{"id":28158496,"url":"https://github.com/indeedeng/iwf-java-sdk","last_synced_at":"2025-05-15T09:20:04.192Z","repository":{"id":58708589,"uuid":"518175994","full_name":"indeedeng/iwf-java-sdk","owner":"indeedeng","description":"Java SDK for iwf workflow engine(simple \u0026 powerful workflow as code engine based on Cadence/Temporal)","archived":false,"fork":false,"pushed_at":"2025-05-06T19:02:31.000Z","size":925,"stargazers_count":14,"open_issues_count":11,"forks_count":9,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-05-07T23:40:07.084Z","etag":null,"topics":["java","java-sdk","open-source","orchestration","orchestration-engine","orchestration-framework","workflow","workflow-as-code","workflow-engine"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/indeedeng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-07-26T18:32:22.000Z","updated_at":"2025-04-15T13:28:54.000Z","dependencies_parsed_at":"2023-02-19T10:45:26.160Z","dependency_job_id":"c92bb7b1-e0cb-42d0-a7b8-288a1da85f6c","html_url":"https://github.com/indeedeng/iwf-java-sdk","commit_stats":null,"previous_names":[],"tags_count":54,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indeedeng%2Fiwf-java-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indeedeng%2Fiwf-java-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indeedeng%2Fiwf-java-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indeedeng%2Fiwf-java-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/indeedeng","download_url":"https://codeload.github.com/indeedeng/iwf-java-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254310502,"owners_count":22049471,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","java-sdk","open-source","orchestration","orchestration-engine","orchestration-framework","workflow","workflow-as-code","workflow-engine"],"created_at":"2025-05-15T09:19:41.468Z","updated_at":"2025-05-15T09:20:04.160Z","avatar_url":"https://github.com/indeedeng.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# iwf-java-sdk\n[![Coverage Status](https://codecov.io/github/indeedeng/iwf-java-sdk/coverage.svg?branch=main)](https://app.codecov.io/gh/indeedeng/iwf-java-sdk/branch/main)\n[![Build status](https://github.com/indeedeng/iwf-java-sdk/actions/workflows/ci-integ-test.yml/badge.svg?branch=main)](https://github.com/indeedeng/iwf-java-sdk/actions/workflows/ci-integ-test.yml)\n\nJava SDK for [iWF workflow engine](https://github.com/indeedeng/iwf)\n\nSee [samples](https://github.com/indeedeng/iwf-java-samples) for how to use this SDK to build your workflow.\n\n## Requirements\n\n- Java 1.8+\n\n## How to use\n\nHere is\nthe [link to all the versions on Maven](https://repo1.maven.org/maven2/io/iworkflow/iwf-java-sdk/) available to use. It gets replicated from [staging repo](https://s01.oss.sonatype.org/content/repositories/releases/io/iworkflow/iwf-java-sdk/) after 30-60 minutes.\n\nAlso the [Java docs for the latest version](https://www.javadoc.io/doc/io.iworkflow/iwf-java-sdk/latest/index.html).\nFor the latest version, [MVN Repository](https://mvnrepository.com/artifact/io.iworkflow/iwf-java-sdk) website may have\n1~2 days delay to show up.\n\n### Gradle\n\n```gradle\n// https://mvnrepository.com/artifact/io.iworkflow/iwf-java-sdk\nimplementation 'io.iworkflow:iwf-java-sdk:2.5.+'\n```\n\n### Maven\n\n```\n\u003c!-- https://mvnrepository.com/artifact/io.iworkflow/iwf-java-sdk --\u003e\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.iworkflow\u003c/groupId\u003e\n    \u003cartifactId\u003eiwf-java-sdk\u003c/artifactId\u003e\n    \u003cversion\u003e2.5.+\u003c/version\u003e\n    \u003ctype\u003epom\u003c/type\u003e\n\u003c/dependency\u003e\n\n```\n\n## Concepts\n\nTo implement a workflow, the two most core interfaces are\n\n* [Workflow interface](https://github.com/indeedeng/iwf-java-sdk/blob/main/src/main/java/io/iworkflow/core/ObjectWorkflow.java)\n  defines the workflow definition\n\n* [WorkflowState interface](https://github.com/indeedeng/iwf-java-sdk/blob/main/src/main/java/io/iworkflow/core/WorkflowState.java)\n  defines the workflow states for workflow definitions\n\nA workflow can contain any number of WorkflowStates.\n\nSee more in https://github.com/indeedeng/iwf#what-is-iwf\n\n## How to build \u0026 run\n\n### Using IntelliJ\n\n1. Check out the idl submodule by running the command: `git submodule update --init --recursive`\n2. In \"Build, Execution, Deployment\" -\u003e \"Gradle\", choose \"wrapper task in Gradle build script\" for \"Use gradle from\".\n3. Open Gradle tab, click \"build\" under \"build\" to build the project\n\n## Development Guide\n\n### Update IDL\n\nRun the command `git submodule update --remote --merge` to update IDL to the latest commit\n\n### Repo structure\n* `.github/workflows/`: the GithubActions workflows\n* `iwf-idl/`: the idl submodule\n* `script/`: some scripts for GithubActions and testing\n* `src/`: Java source code\n  * `main/java/io/iworkflow/core/`: SDK code\n    * `command/`: the command implementation\n    * `communication/`: the communication implementation\n    * `mapper/`: the mapper with IDL\n    * `persistence/`: the persistence implementation\n    * `validator/`: some validators\n    * `Client.java`: the client implemntation\n    * `...java` ...\n  * `test/java/io/iworkflow/`: Java test code (currently only integ test)\n    * `spring/`: the integ test setup of using Spring as REST controller\n    * `integ/`: the integration tests\n      * `XyzTest.java`: a file for test cases\n      * `xyz/`: the iWF workflow implementation for the integration test cases\n\n# Development Plan\n\n## 1.0\n\n- [x] Start workflow API\n- [x] Executing `start`/`decide` APIs and completing workflow\n- [x] Parallel execution of multiple states\n- [x] Timer command\n- [x] Signal command\n- [x] SearchAttribute\n- [x] DataAttribute\n- [x] StateExecutionLocal\n- [x] Signal workflow API\n- [x] Get workflow DataAttributes/SearchAttributes API\n- [x] Get workflow API\n- [x] Search workflow API\n- [x] Cancel workflow API\n- [x] Reset workflow API\n- [x] InternalChannel command\n- [x] AnyCommandCompleted Decider trigger type\n- [x] More workflow start options: IdReusePolicy, cron schedule, retry\n- [x] StateOption: WaitUntil/Execute API timeout and retry policy\n- [x] Reset workflow by stateId/StateExecutionId\n\n## 1.1\n\n- [x] New search attribute types: Double, Bool, Datetime, Keyword array, Text\n- [x] Workflow start options: initial search attributes\n\n## 1.2\n\n- [x] Skip timer API for testing/operation\n- [x] Decider trigger type: any command combination\n\n## 1.3\n\n- [x] Support failing workflow with results\n- [x] Improve workflow uncompleted error return(canceled, failed, timeout, terminated)\n\n### 1.4\n\n- [x] Support PROCEED_ON_FAILURE for WaitUntilApiFailurePolicy\n\n### 2.0\n\n- [x] Renaming some concepts/APIs with breaking changes(see releaste notes)\n- [x] Support workflow RPC\n\n### 2.1\n\n- [x] Support caching on persistence\n\n### 2.2\n\n- [x] Support atomic conditional complete workflow by checking signal/internal channel emptiness\n\n### 2.3\n\n- [x] Support dynamic data/search attributes and internal/signal channel definition\n- [x] Support state options overridden dynamically\n- [x] Support describe workflow API\n\n### 2.4\n\n- [x] Support execute API failure policy\n- [x] Support RPC persistence locking policy\n\n### 2.5\n\n- [x] Add waitForStateExecutionCompletion API\n\n### 2.6\n\n- [x] Small breaking changes to IdReusePolicy for fixing typo\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findeedeng%2Fiwf-java-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Findeedeng%2Fiwf-java-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findeedeng%2Fiwf-java-sdk/lists"}