Java SDK for iWF workflow engine
See samples for how to use this SDK to build your workflow.
- Java 1.8+
Here is the link to all the versions on Maven available to use. It gets replicated from staging repo after 30-60 minutes.
Also the Java docs for the latest version. For the latest version, MVN Repository website may have 1~2 days delay to show up.
// https://mvnrepository.com/artifact/io.iworkflow/iwf-java-sdk
implementation 'io.iworkflow:iwf-java-sdk:2.5.+'
<!-- https://mvnrepository.com/artifact/io.iworkflow/iwf-java-sdk -->
<dependency>
<groupId>io.iworkflow</groupId>
<artifactId>iwf-java-sdk</artifactId>
<version>2.5.+</version>
<type>pom</type>
</dependency>
To implement a workflow, the two most core interfaces are
-
Workflow interface defines the workflow definition
-
WorkflowState interface defines the workflow states for workflow definitions
A workflow can contain any number of WorkflowStates.
See more in https://github.com/indeedeng/iwf#what-is-iwf
- Check out the idl submodule by running the command:
git submodule update --init --recursive
- In "Build, Execution, Deployment" -> "Gradle", choose "wrapper task in Gradle build script" for "Use gradle from".
- Open Gradle tab, click "build" under "build" to build the project
Run the command git submodule update --remote --merge
to update IDL to the latest commit
.github/workflows/
: the GithubActions workflowsiwf-idl/
: the idl submodulescript/
: some scripts for GithubActions and testingsrc/
: Java source codemain/java/io/iworkflow/core/
: SDK codecommand/
: the command implementationcommunication/
: the communication implementationmapper/
: the mapper with IDLpersistence/
: the persistence implementationvalidator/
: some validatorsClient.java
: the client implemntation...java
...
test/java/io/iworkflow/
: Java test code (currently only integ test)spring/
: the integ test setup of using Spring as REST controllerinteg/
: the integration testsXyzTest.java
: a file for test casesxyz/
: the iWF workflow implementation for the integration test cases
- Start workflow API
- Executing
start
/decide
APIs and completing workflow - Parallel execution of multiple states
- Timer command
- Signal command
- SearchAttribute
- DataAttribute
- StateExecutionLocal
- Signal workflow API
- Get workflow DataAttributes/SearchAttributes API
- Get workflow API
- Search workflow API
- Cancel workflow API
- Reset workflow API
- InternalChannel command
- AnyCommandCompleted Decider trigger type
- More workflow start options: IdReusePolicy, cron schedule, retry
- StateOption: WaitUntil/Execute API timeout and retry policy
- Reset workflow by stateId/StateExecutionId
- New search attribute types: Double, Bool, Datetime, Keyword array, Text
- Workflow start options: initial search attributes
- Skip timer API for testing/operation
- Decider trigger type: any command combination
- Support failing workflow with results
- Improve workflow uncompleted error return(canceled, failed, timeout, terminated)
- Support PROCEED_ON_FAILURE for WaitUntilApiFailurePolicy
- Renaming some concepts/APIs with breaking changes(see releaste notes)
- Support workflow RPC
- Support caching on persistence
- Support atomic conditional complete workflow by checking signal/internal channel emptiness
- Support dynamic data/search attributes and internal/signal channel definition
- Support state options overridden dynamically
- Support describe workflow API
- Support execute API failure policy
- Support RPC persistence locking policy
- Add waitForStateExecutionCompletion API
- Small breaking changes to IdReusePolicy for fixing typo