Java/
API Reference
The Java SDK public surface — the FlexiQ client, tasks, workers, workflows, and the CLI.
The Java SDK public surface — the FlexiQ client, tasks, workers, workflows, and the CLI.
The public API lives under org.byteveda.flexiq (Maven coordinates
org.byteveda:flexiq). Contrib helpers live under
org.byteveda.flexiq.contrib; the Spring Boot 3 starter ships separately as
org.byteveda:flexiq-spring.
| Page | Covers |
|---|---|
| Overview | The layered architecture — FlexiQ down to the native QueueBackend. |
| FlexiQ | FlexiQ.builder(), enqueue, inspect, admin, locks, periodic. |
| Task | Task.of typed tasks, EnqueueOptions, RetryPolicy, the annotations. |
| Worker | The Worker.Builder and the running worker handle. |
| Result | Awaiting jobs and reading typed results. |
| Context | Resources.use and the middleware TaskContext. |
| Resources | Worker dependency injection — scopes, pools, disposal. |
| Serializers | JsonSerializer, MsgpackSerializer, CborSerializer, payload codecs. |
| Batching | Batcher — buffer payloads and flush them as one enqueueMany call. |
| Workflows | The Workflow builder, WorkflowRun, gates, sagas, analysis. |
| Canvas | Canvas.link, chain, group, and chord shortcuts. |
| Saga | Step.Builder.compensate, saga run/node states, the rollback contract. |
| Errors | The FlexiQException hierarchy. |
| Testing | The in-memory backend for fast, native-library-free tests. |
| CLI | The flexiq command. |