Helix Framework Documentation

Ecosystem

Libraries

Reusable framework modules that provide implementation building blocks for Helix-based applications.

Helix libraries are the reusable building blocks underneath the framework ecosystem. This index focuses on the core libraries only, without the Spring Boot starters and autoconfiguration modules.

API and Application

  • API Contract - Response envelopes, pagination payloads, HAL links, and other contract types used by Helix APIs.
  • API Health - HTTP and JDBC health indicator helpers for services that need explicit downstream health checks.
  • API Key - Core API key value types for Helix security and authentication flows.
  • API Sanity App ID - Startup sanity check that verifies the application ID expected by Helix API components is configured.
  • API Sanity Clock - Startup sanity check that verifies a shared clock is available for time-sensitive API behavior.
  • API Sanity Required Props - Startup sanity check that validates required application properties before the service is considered healthy.
  • Validation - Validation helpers, composite validators, and address-state validation support.

Data and Persistence

  • Cache - Core cache abstraction for implementing reusable cache services in Helix applications.
  • Cache Redis - Redis-backed implementation of the Helix cache abstraction.
  • DB - Database repository and pagination support for JDBC-based data access layers.
  • Pagination Cursor - Cursor primitives and criteria types for implementing cursor-based pagination.
  • Pagination Sorting - Sorting primitives and converters for mapping request values into sortable criteria.
  • PostgreSQL - PostgreSQL notification listener utilities for applications that react to database events.

Security and Secrets

  • AWS Encryption - AWS encryption helpers for envelope encryption and decryption workflows.
  • AWS STS - STS identity helpers for resolving and exposing the active AWS identity.
  • Crypto AEAD - AEAD and streaming AEAD helpers for symmetric encryption workflows.
  • Crypto Bcrypt - BCrypt hashing helpers for password and secret verification use cases.
  • Crypto Diffie-Hellman - Diffie-Hellman key exchange helpers for shared-secret generation.
  • Crypto MAC - MAC helpers for signing and verifying payload integrity.

Observability and Operations

  • Build Info - Build metadata types for surfacing version and build details at runtime.
  • Logback - Logback integration helpers and logger factory support for Helix logging conventions.
  • Logging - Marker utilities for consistent structured logging across Helix services.
  • Logstash - Value masking helpers for Logstash-oriented structured logging pipelines.
  • Smoke - Smoke test abstractions for validating deployments and runtime readiness checks.
  • Tracing - Core correlation ID abstractions for Helix tracing integrations.
  • Tracing Datadog - Datadog correlation ID integration built on the core Helix tracing abstraction.
  • Tracing HTTP - HTTP header correlation ID integration built on the core Helix tracing abstraction.
  • Tracing Zipkin - Zipkin correlation ID integration built on the core Helix tracing abstraction.

Platform Integrations

  • Email - Email abstractions and SMTP-backed implementations for sending outbound mail.
  • Git - Git build and repository metadata helpers for applications that surface source-control details.
  • OkHttp - OkHttp client factories and interceptors for authenticated outbound HTTP clients.
  • RestTemplate - RestTemplate interceptors for metadata, request IDs, tracing, and HTTP logging.

Utilities

  • AWS Dynamo Scan - A thin DynamoDB scan utility for iterating through large DynamoDB result sets safely.
  • Annotation - Shared annotations and marker types used across the Helix library stack.
  • Archive - Archive helpers for creating and extracting ZIP content in Helix tools and services.
  • Assertion - Assertion helpers for validating state and surfacing consistent failures in application code.
  • Barcode - Barcode and QR code generation helpers for Helix applications and tooling.
  • Collections - Collection helpers such as tracking and versioned maps for stateful application logic.
  • Concurrency - Executors, futures, and fire-and-forget helpers for Helix background and concurrent work.
  • Conditional - Spring condition helpers for activating configuration only when required properties are present.
  • Console - Console, prompt, progress, and terminal utilities used by Helix command-line tools.
  • Delta - Minimal, traceable JSON delta computation and replay helpers for audit, change tracking, and selective update workflows.
  • Env - Environment and context helpers for working with Helix runtime environments and Spring profiles.
  • Env Opts - Environment-driven option parsing utilities for CLIs and runtime configuration.
  • File - File and resource helpers for working with packaged assets and filesystem permissions.
  • File Watcher - Directory watching utilities for reacting to file creation, update, and delete events.
  • Generics - Generic wrapper abstractions used by other Helix modules when working with typed containers.
  • Gradle - Small Gradle utility classes shared by Helix build integrations and plugin code.
  • ID - Identifier generation helpers for UUIDs, ULIDs, and secure random strings.
  • Mapper - Mapper support library for Helix applications.
  • Name - Friendly naming utilities for turning identifiers into human-readable names.
  • Proxy - Dynamic proxy helpers for composing invocation handlers around existing implementations.
  • Reflection - Reflection helpers for class loading and reflective access with consistent error handling.
  • Retry - Retry primitives for wrapping operations with fixed retry behavior and exhausted-retry handling.
  • Rules - Rule engine primitives, filters, and YAML-backed rule loading for configurable policy evaluation.
  • SemVer - Semantic version parsing and comparison helpers.
  • Thread Context - Thread factory and context-copy helpers for propagating execution context across threads.
  • Time - Time, duration, timeout, and business-day utilities used across Helix services.