{"id":25611330,"url":"https://github.com/danielgerlag/jworkflow","last_synced_at":"2025-04-04T16:12:48.288Z","repository":{"id":15907379,"uuid":"78961828","full_name":"danielgerlag/jworkflow","owner":"danielgerlag","description":"JWorkflow is a light weight workflow library for Java","archived":false,"fork":false,"pushed_at":"2025-01-18T16:03:20.000Z","size":339,"stargazers_count":109,"open_issues_count":12,"forks_count":34,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-28T15:05:14.079Z","etag":null,"topics":["workflow","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danielgerlag.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2017-01-14T19:29:22.000Z","updated_at":"2025-02-28T08:09:37.000Z","dependencies_parsed_at":"2025-03-01T00:09:47.713Z","dependency_job_id":"a53f91be-4b52-4146-badf-856d2631f993","html_url":"https://github.com/danielgerlag/jworkflow","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielgerlag%2Fjworkflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielgerlag%2Fjworkflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielgerlag%2Fjworkflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielgerlag%2Fjworkflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielgerlag","download_url":"https://codeload.github.com/danielgerlag/jworkflow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247208140,"owners_count":20901570,"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":["workflow","workflow-engine"],"created_at":"2025-02-21T23:06:41.697Z","updated_at":"2025-04-04T16:12:48.264Z","avatar_url":"https://github.com/danielgerlag.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JWorkflow\n\n[\u003cimg src=\"https://api.gitsponsors.com/api/badge/img?id=78961828\" height=\"20\"\u003e](https://api.gitsponsors.com/api/badge/link?p=BEgKtI+LTLagRYOAgwn7CorAqodkvLwNTw7nilneEcLpaMh39jIiLlr3MCq/2Xmow7raks2SyYvn3pDc/5nyPA==)\n\nJWorkflow is a light weight workflow library for Java.  It supports pluggable persistence and concurrency providers to allow for multi-node clusters.\n\n## Installing\n\n### Using Maven\n\nAdd `jworkflow` to your POM file as a dependency.\n\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003enet.jworkflow\u003c/groupId\u003e\n        \u003cartifactId\u003ejworkflow\u003c/artifactId\u003e\n        \u003cversion\u003e0.5-SNAPSHOT\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n### Using Gradle\n\n```Gradle\ndependencies { \n    compile 'net.jworkflow:jworkflow:0.5-SNAPSHOT'\n}\n```\n\n## Documentation\n\nSee [Tutorial here.](https://github.com/danielgerlag/jworkflow/tree/master/docs)\n\n## Fluent API\n\nDefine your workflows with the fluent API.\n\n```c#\npublic class HelloWorkflow implements Workflow {\n   @Override\n    public void build(WorkflowBuilder builder) {\n        \n        builder\n            .startsWith(Task1.class)\n            .then(Task2.class)                \n            .then(Task3.class);        \n    }    \n}\n...\n...\npublic class Task1 implements StepBody {\n\n    @Override\n    public ExecutionResult run(StepExecutionContext context) {\n        System.out.println(\"Hello world\");\n        return ExecutionResult.next();\n    }    \n}\n```\n\n## JSON Workflow Definitions\n\nDefine your workflows in JSON\n\n```json\n{\n  \"id\": \"HelloWorld\",\n  \"version\": 1,\n  \"steps\": [\n    {\n      \"id\": \"hello\",\n      \"stepType\": \"com.myapp.Step1\",\n      \"nextStepId\": \"bye\"\n    },        \n    {\n      \"id\": \"bye\",\n      \"stepType\": \"com.myapp.Step2\"\n    }\n  ]\n}\n```\n\n### Sample use cases\n\n* New user workflow\n```java\npublic class MyData {    \n    public String email;\n    public String password;\n    public String userId;\n}\n\n\npublic class MyWorkflow implements Workflow\u003cMyData\u003e {\n\n    ...\n\n    @Override\n    public void build(WorkflowBuilder\u003cMyData\u003e builder) {\n        builder\n            .startsWith(CreateUser.class)  \n                .input((step, data) -\u003e step.email = data.email)\n                .input((step, data) -\u003e step.password = data.password)\n                .output((step, data) -\u003e data.userId = step.userId)\n            .then(SendConfirmationEmail.class)\n                .waitFor(\"confirmation\", data -\u003e data.userId)\n            .then(UpdateUser.class)\n                .input((step, data) -\u003e step.userId = data.userId);\n    }    \n}\n```\n\n* Saga Transactions\n\n```java\npublic class MyWorkflow implements Workflow\u003cMyData\u003e {\n\n    ...\n\n    @Override\n    public void build(WorkflowBuilder\u003cMyData\u003e builder) {\n        builder\n            .startsWith(CreateCustomer.class)  \n            .then(PushToSalesforce.class)\n                .onError(ErrorBehavior.RETRY)\n            .then(PushToERP.class)\n                .onError(ErrorBehavior.RETRY, Duration.ofMinutes(30));\n    }    \n}\n```\n\n```java\nbuilder\n    .startsWith(LogStart.class)  \n    .saga(saga -\u003e saga\n        .startsWith(Task1.class)\n            .compensateWith(UndoTask1.class)\n        .then(Task2.Class)\n            .compensateWith(UndoTask2.class)\n        .then(Task3.Class)\n            .compensateWith(UndoTask3.class)\n    )\n    .onError(ErrorBehavior.RETRY, Duration.ofMinutes(30));\n    .then(LogEnd.class);\n```\n\n\n### Persistence\n\nSince workflows are typically long running processes, they will need to be persisted to storage between steps.\nThere are several persistence providers available as seperate packages.\n\n* Memory Persistence Provider *(Default provider, for demo and testing purposes)*\n* [MongoDB](https://github.com/danielgerlag/jworkflow/tree/master/jworkflow.providers.mongodb)\n* [Amazon DynamoDB](https://github.com/danielgerlag/jworkflow/tree/master/jworkflow.providers.aws)\n* *(more to come soon...)*\n\n### Multi-node clusters\n\nBy default, the WorkflowHost service will run as a single node using the built-in queue and locking providers for a single node configuration.  Should you wish to run a multi-node cluster, you will need to configure an external queueing mechanism and a distributed lock manager to co-ordinate the cluster.  These are the providers that are currently available.\n\n#### Queue Providers\n\n* SingleNodeQueueProvider *(Default built-in provider)*\n* [RabbitMQ](https://github.com/danielgerlag/jworkflow/tree/master/jworkflow.providers.rabbitmq)\n* [Redis](https://github.com/danielgerlag/jworkflow/tree/master/jworkflow.providers.redis)\n* [AWS Simple Queue Service](https://github.com/danielgerlag/jworkflow/tree/master/jworkflow.providers.aws)\n\n#### Distributed lock managers\n\n* SingleNodeLockProvider *(Default built-in provider)*\n* [Redis](https://github.com/danielgerlag/jworkflow/tree/master/jworkflow.providers.redis)\n* [Amazon DynamoDB](https://github.com/danielgerlag/jworkflow/tree/master/jworkflow.providers.aws)\n* *(more to come soon...)*\n\n## Samples\n\n[Hello World](https://github.com/danielgerlag/jworkflow/tree/master/samples/sample01)\n\n[Passing Data](https://github.com/danielgerlag/jworkflow/tree/master/samples/sample02)\n\n[If condition](https://github.com/danielgerlag/jworkflow/tree/master/samples/sample06)\n\n[Responding to external events](https://github.com/danielgerlag/jworkflow/tree/master/samples/sample03)\n\n[Parallel ForEach](https://github.com/danielgerlag/jworkflow/tree/master/samples/sample04)\n\n[While loop](https://github.com/danielgerlag/jworkflow/tree/master/samples/sample05)\n\n[Saga Transactions](https://github.com/danielgerlag/jworkflow/tree/master/samples/sample07)\n\n[JSON Workflows](https://github.com/danielgerlag/jworkflow/tree/master/samples/sample08)\n\n\n\n## Contributors\n\n* **Daniel Gerlag** - *Initial work*\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielgerlag%2Fjworkflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielgerlag%2Fjworkflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielgerlag%2Fjworkflow/lists"}