|
| 1 | +--- |
| 2 | +title: Serverless Workflow Java SDK 7.0.0 |
| 3 | +author: Francisco Javier Tirado Sarti |
| 4 | +date: 2025-01-31 |
| 5 | +description: > |
| 6 | + Heads up, community! We have released a new Java SDK version compatible with Specification 1.0.0. |
| 7 | +--- |
| 8 | + |
| 9 | +## Announcing the Release of Serverless Workflow Java SDK 7.0.0 |
| 10 | + |
| 11 | +Hello, Serverless Workflow community! |
| 12 | + |
| 13 | +We're excited to announce the release of the latest Java SDK, version 7.0.0, which is now compatible with the upcoming Serverless Workflow Specification 1.0.0 and includes a reference implementation. The reference implementation provides a ready-to-use runtime that supports the Serverless Workflow Specification. It includes a workflow execution engine, validation utilities, and illustrative examples to help you quickly test and deploy your workflows. |
| 14 | + |
| 15 | + |
| 16 | +## Java SDK example |
| 17 | + |
| 18 | +You can dive right in using [one of the examples](https://github.com/serverlessworkflow/specification/tree/main/examples) available in the specification repository. Here's a quick example to get you started: |
| 19 | + |
| 20 | +To use the SDK, simply add it as a dependency to your Maven project: |
| 21 | + |
| 22 | + |
| 23 | +```xml |
| 24 | +<dependency> |
| 25 | + <groupId>io.serverlessworkflow</groupId> |
| 26 | + <artifactId>serverlessworkflow-api</artifactId> |
| 27 | + <version>7.0.0</version> |
| 28 | +</dependency> |
| 29 | +``` |
| 30 | + |
| 31 | +Then, you can write |
| 32 | + |
| 33 | +```java |
| 34 | +// Make sure simple.yaml is in your root folder |
| 35 | +try (InputStream in = new FileInputStream("simple.yaml")) { |
| 36 | + Workflow workflow = WorkflowReader.readWorkflow (in, WorkflowFormat.YAML); |
| 37 | + // Once you have the Workflow instance, you can use its API to inspect it |
| 38 | +} |
| 39 | +``` |
| 40 | + |
| 41 | +## Java Reference implementation example |
| 42 | + |
| 43 | +You can dive right in using [one of the examples](https://github.com/serverlessworkflow/sdk-java/tree/main/examples) available in the implementation repository or by checking the [README](https://github.com/serverlessworkflow/sdk-java/tree/main/impl). |
| 44 | + |
| 45 | +Here's a quick example to get you started: |
| 46 | + |
| 47 | +To use reference implementation, simply add it as a dependency to your Maven project: |
| 48 | + |
| 49 | +```xml |
| 50 | +<dependency> |
| 51 | + <groupId>io.serverlessworkflow</groupId> |
| 52 | + <artifactId>serverlessworkflow-impl-core</artifactId> |
| 53 | + <version>7.0.0</version> |
| 54 | +</dependency> |
| 55 | +``` |
| 56 | + |
| 57 | +Then, you can write the following code to execute a workflow |
| 58 | + |
| 59 | +``` java |
| 60 | +// Make sure simple.yaml is in your src/main/resources folder |
| 61 | +try (WorkflowApplication appl = WorkflowApplication.builder().build()) { |
| 62 | + logger.info( |
| 63 | + "Workflow output is {}", |
| 64 | + appl.workflowDefinition(WorkflowReader.readWorkflowFromClasspath("simple.yaml")) |
| 65 | + .instance(Map.of()) |
| 66 | + .start() |
| 67 | + .join()); |
| 68 | + } |
| 69 | +``` |
| 70 | + |
| 71 | +## Whats new? |
| 72 | + |
| 73 | +In this release: |
| 74 | + |
| 75 | +- We updated the latest schema revision. |
| 76 | +- We improved POJO generation from specification schema by: |
| 77 | + - Fixing generation of POJOs related to the `EventComsuption` strategy. |
| 78 | +- We released the first documented version of the [reference implementation](https://github.com/serverlessworkflow/sdk-java/tree/main/impl), completing [phase 1](https://github.com/serverlessworkflow/sdk-java/issues/459). |
| 79 | + |
| 80 | + |
| 81 | +### Future plans |
| 82 | + |
| 83 | +Check out our roadmap [here](https://github.com/serverlessworkflow/sdk-java/milestone/2) |
| 84 | + |
| 85 | +### Previous Versions and Support for the Specification 0.8 |
| 86 | + |
| 87 | +As we move forward, if you encounter any issues with the 5.x series, which supports Specification 0.8, please [open an issue in our repository](https://github.com/serverlessworkflow/sdk-java/issues) so we can track it. While we may release patch versions to address critical issues, please note that no new features will be added, and our resources for maintaining this branch are limited. |
| 88 | + |
| 89 | +For those interested in contributing to the 6.x series, which supports the legacy 0.9 version of the specification, we welcome your efforts. However, we want to emphasize that our primary focus and resources are dedicated to the new 1.0.0 specification, which aligns with the 7.x stream of the Java SDK. |
| 90 | + |
| 91 | +Happy coding! |
0 commit comments