Skip to content

README.md

Latest commit

 

History

History
56 lines (38 loc) · 2.78 KB

README.md

File metadata and controls

56 lines (38 loc) · 2.78 KB
Raw

Conductor Client Spring for Spring Boot 3

Spring Boot 3 auto-configuration for the Conductor core client, workflow SDK, and Java workers.

Prerequisites: Java 21+, Spring Boot 3, and a running OSS or Orkes Conductor server. For Spring Boot 4, use the Boot 4 module.

Install

Use the published version from Maven Central.

implementation 'org.conductoross:conductor-client-spring:<VERSION>'
<dependency>
    <groupId>org.conductoross</groupId>
    <artifactId>conductor-client-spring</artifactId>
    <version>&lt;VERSION&gt;</version>
</dependency>

Configure

conductor.client.root-uri=http://localhost:8080/api
conductor.client.verifying-ssl=true

For Orkes, provide the endpoint and credentials through your deployment's environment/secret manager; see connection and authentication. Never store auth credentials in application.properties committed to source control.

What auto-configuration provides

With @SpringBootApplication, the module discovers its auto-configurations automatically. It creates a ConductorClient, TaskClient, WorkflowClient, WorkflowExecutor, AnnotatedWorkerExecutor, and a managed TaskRunnerConfigurer when the required beans are available. No @ComponentScan for com.netflix.conductor is required.

Spring discovers Worker beans and @Component beans with public @WorkerTask methods. The task runner starts with the application and calls shutdown() during graceful Spring shutdown.

@Component
class GreetingTasks {
    @WorkerTask("greet")
    public @OutputParam("greeting") String greet(@InputParam("name") String name) {
        return "Hello, " + name;
    }
}

Expected result: when a registered workflow reaches greet, the managed worker polls it and completes the task. Set per-task worker thread counts with conductor.worker.<task-name>.threadCount; keep side effects idempotent.

Customization and migration

Define your own ConductorClient, TaskClient, WorkflowClient, WorkflowExecutor, or TaskRunnerConfigurer bean to replace the corresponding default. Use conductor.client.base-path as an alternative to root-uri; root-uri wins when both are present.

Older documentation showed Java 17 and a fixed 4.0.0 coordinate. This module now follows the Java 21 SDK baseline and uses <VERSION> from Maven Central. It also uses Boot auto-configuration, so remove legacy manual component scanning unless it serves your own application components.

Next: Spring integration selector, workers, and reliability.