Skip to main content

Orkes Conductor Java SDK

Orkes Conductor Java SDK is maintained here: https://github.com/orkes-io/orkes-conductor-client

Dependencies

Add orkes-conductor-client dependency to your project.

Gradle

implementation 'io.orkes.conductor:orkes-conductor-client:1.1.22'

Maven

<dependency>
<groupId>io.orkes.conductor</groupId>
<artifactId>orkes-conductor-client</artifactId>
<version>1.1.22</version>
</dependency>

Initialization

Everything related to server settings should be done within the ApiClient class by setting the required parameters when initializing an object, like this:

ApiClient apiClient = new ApiClient("https://play.orkes.io/api");

If we are using Spring Framework, we can initialize the above class as a bean that can be used across the project.

Authentication Settings (optional)

See Security via Applications or this video for details on how to get an access key and secret.

Once we have a key and secret, we can configure the app from properties or environment variables, as shown in this example:

    String key = System.getenv("KEY");
String secret = System.getenv("SECRET");
String conductorServer = System.getenv("CONDUCTOR_SERVER_URL");
ApiClient apiClient = new ApiClient(conductorServer, key, secret);

Remember to protect your app secrets like any other secrets or passwords.