Skip to content

Align Java API with other languages #1560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
+1,002 −92
Open

Align Java API with other languages #1560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
96eb34e
Align Java API with other languages
mcruzdev Sep 30, 2025
f35e2d0
Merge branch 'master' into issue-1554
artur-ciocanu Oct 2, 2025
5e0daea
Apply pull request suggestions
mcruzdev Oct 4, 2025
6033ba2
Merge branch 'issue-1554' of github.com:mcruzdev/java-sdk into issue-…
mcruzdev Oct 4, 2025
95f6455
Apply pull request suggestions
mcruzdev Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions daprdocs/content/en/java-sdk-docs/java-client/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ public class DistributedLockGrpcClient {
package io.dapr.examples.workflows;

import io.dapr.workflows.client.DaprWorkflowClient;
import io.dapr.workflows.client.WorkflowInstanceStatus;
import io.dapr.workflows.client.WorkflowState;

import java.time.Duration;
import java.util.concurrent.TimeUnit;
Expand All @@ -513,18 +513,18 @@ public class DemoWorkflowClient {
System.out.printf("Started new workflow instance with random ID: %s%n", instanceId);

System.out.println(separatorStr);
System.out.println("**GetInstanceMetadata:Running Workflow**");
WorkflowInstanceStatus workflowMetadata = client.getInstanceState(instanceId, true);
System.out.println("**GetWorkflowMetadata:Running Workflow**");
WorkflowState workflowMetadata = client.getWorkflowState(instanceId, true);
System.out.printf("Result: %s%n", workflowMetadata);

System.out.println(separatorStr);
System.out.println("**WaitForInstanceStart**");
System.out.println("**WaitForWorkflowStart**");
try {
WorkflowInstanceStatus waitForInstanceStartResult =
client.waitForInstanceStart(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForInstanceStartResult);
WorkflowState waitForWorkflowStartResult =
client.waitForWorkflowStart(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForWorkflowStartResult);
} catch (TimeoutException ex) {
System.out.printf("waitForInstanceStart has an exception:%s%n", ex);
System.out.printf("waitForWorkflowStart has an exception:%s%n", ex);
}

System.out.println(separatorStr);
Expand All @@ -545,18 +545,18 @@ public class DemoWorkflowClient {


System.out.println(separatorStr);
System.out.println("**WaitForInstanceCompletion**");
System.out.println("**waitForWorkflowCompletion**");
try {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should change the example to use WorkflowState

WorkflowInstanceStatus waitForInstanceCompletionResult =
client.waitForInstanceCompletion(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForInstanceCompletionResult);
WorkflowState waitForWorkflowCompletionResult =
client.waitForWorkflowCompletion(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForWorkflowCompletionResult);
} catch (TimeoutException ex) {
System.out.printf("waitForInstanceCompletion has an exception:%s%n", ex);
System.out.printf("waitForWorkflowCompletion has an exception:%s%n", ex);
}

System.out.println(separatorStr);
System.out.println("**purgeInstance**");
boolean purgeResult = client.purgeInstance(instanceId);
System.out.println("**purgeWorkflow**");
boolean purgeResult = client.purgeWorkflow(instanceId);
System.out.printf("purgeResult: %s%n", purgeResult);

System.out.println(separatorStr);
Expand Down
24 changes: 12 additions & 12 deletions daprdocs/content/en/java-sdk-docs/java-workflow/java-workflow-howto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,17 @@ public class DemoWorkflowClient {

System.out.println(separatorStr);
System.out.println("**GetInstanceMetadata:Running Workflow**");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should change the example to use WorkflowState

WorkflowInstanceStatus workflowMetadata = client.getInstanceState(instanceId, true);
WorkflowState workflowMetadata = client.getWorkflowState(instanceId, true);
System.out.printf("Result: %s%n", workflowMetadata);

System.out.println(separatorStr);
System.out.println("**WaitForInstanceStart**");
System.out.println("**WaitForWorkflowStart**");
try {
WorkflowInstanceStatus waitForInstanceStartResult =
client.waitForInstanceStart(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForInstanceStartResult);
WorkflowState waitForWorkflowStartResult =
client.waitForWorkflowStart(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForWorkflowStartResult);
} catch (TimeoutException ex) {
System.out.printf("waitForInstanceStart has an exception:%s%n", ex);
System.out.printf("waitForWorkflowStart has an exception:%s%n", ex);
}

System.out.println(separatorStr);
Expand All @@ -135,13 +135,13 @@ public class DemoWorkflowClient {


System.out.println(separatorStr);
System.out.println("**WaitForInstanceCompletion**");
System.out.println("**waitForWorkflowCompletion**");
try {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should change the example to use WorkflowState

WorkflowInstanceStatus waitForInstanceCompletionResult =
client.waitForInstanceCompletion(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForInstanceCompletionResult);
WorkflowState waitForWorkflowCompletionResult =
client.waitForWorkflowCompletion(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForWorkflowCompletionResult);
} catch (TimeoutException ex) {
System.out.printf("waitForInstanceCompletion has an exception:%s%n", ex);
System.out.printf("waitForWorkflowCompletion has an exception:%s%n", ex);
}

System.out.println(separatorStr);
Expand Down Expand Up @@ -213,7 +213,7 @@ Events raised for workflow with instanceId: 0b4cc0d5-413a-4c1c-816a-a71fa24740d4
** Registering Event to be captured by anyOf(t1,t2,t3) **
Event raised for workflow with instanceId: 0b4cc0d5-413a-4c1c-816a-a71fa24740d4
*******
**WaitForInstanceCompletion**
**WaitForWorkflowCompletion**
Result: [Name: 'io.dapr.examples.workflows.DemoWorkflow', ID: '0b4cc0d5-413a-4c1c-816a-a71fa24740d4', RuntimeStatus: FAILED, CreatedAt: 2023-09-13T13:02:30.547Z, LastUpdatedAt: 2023-09-13T13:02:55.054Z, Input: '"input data"', Output: '']
*******
**purgeInstance**
Expand Down
8 changes: 4 additions & 4 deletions examples/src/main/java/io/dapr/examples/workflows/chain/DemoChainClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import io.dapr.examples.workflows.utils.PropertyUtils;
import io.dapr.examples.workflows.utils.RetryUtils;
import io.dapr.workflows.client.DaprWorkflowClient;
import io.dapr.workflows.client.WorkflowInstanceStatus;
import io.dapr.workflows.client.WorkflowState;

import java.time.Duration;
import java.util.concurrent.TimeoutException;
Expand All @@ -34,10 +34,10 @@ public static void main(String[] args) {
Duration.ofSeconds(60));

System.out.printf("Started a new chaining model workflow with instance ID: %s%n", instanceId);
WorkflowInstanceStatus workflowInstanceStatus =
client.waitForInstanceCompletion(instanceId, null, true);
WorkflowState workflowState =
client.waitForWorkflowCompletion(instanceId, null, true);

String result = workflowInstanceStatus.readOutputAs(String.class);
String result = workflowState.readOutputAs(String.class);
System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId, result);
} catch (TimeoutException | InterruptedException e) {
throw new RuntimeException(e);
Expand Down
8 changes: 4 additions & 4 deletions ...les/src/main/java/io/dapr/examples/workflows/childworkflow/DemoChildWorkerflowClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

import io.dapr.examples.workflows.utils.PropertyUtils;
import io.dapr.workflows.client.DaprWorkflowClient;
import io.dapr.workflows.client.WorkflowInstanceStatus;
import io.dapr.workflows.client.WorkflowState;

import java.util.concurrent.TimeoutException;

Expand All @@ -30,10 +30,10 @@ public static void main(String[] args) {
try (DaprWorkflowClient client = new DaprWorkflowClient(PropertyUtils.getProperties(args))) {
String instanceId = client.scheduleNewWorkflow(DemoWorkflow.class);
System.out.printf("Started a new child-workflow model workflow with instance ID: %s%n", instanceId);
WorkflowInstanceStatus workflowInstanceStatus =
client.waitForInstanceCompletion(instanceId, null, true);
WorkflowState workflowState =
client.waitForWorkflowCompletion(instanceId, null, true);

String result = workflowInstanceStatus.readOutputAs(String.class);
String result = workflowState.readOutputAs(String.class);
System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId, result);

} catch (TimeoutException | InterruptedException e) {
Expand Down
4 changes: 2 additions & 2 deletions examples/src/main/java/io/dapr/examples/workflows/compensation/BookTripClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import io.dapr.examples.workflows.utils.PropertyUtils;
import io.dapr.examples.workflows.utils.RetryUtils;
import io.dapr.workflows.client.DaprWorkflowClient;
import io.dapr.workflows.client.WorkflowInstanceStatus;
import io.dapr.workflows.client.WorkflowState;

import java.time.Duration;
import java.util.concurrent.TimeoutException;
Expand All @@ -27,7 +27,7 @@ public static void main(String[] args) {
String instanceId = RetryUtils.callWithRetry(() -> client.scheduleNewWorkflow(BookTripWorkflow.class), Duration.ofSeconds(60));
System.out.printf("Started a new trip booking workflow with instance ID: %s%n", instanceId);

WorkflowInstanceStatus status = client.waitForInstanceCompletion(instanceId, Duration.ofMinutes(30), true);
WorkflowState status = client.waitForWorkflowCompletion(instanceId, Duration.ofMinutes(30), true);
System.out.printf("Workflow instance with ID: %s completed with status: %s%n", instanceId, status);
System.out.printf("Workflow output: %s%n", status.getSerializedOutput());
} catch (TimeoutException | InterruptedException e) {
Expand Down
2 changes: 1 addition & 1 deletion examples/src/main/java/io/dapr/examples/workflows/continueasnew/DemoContinueAsNewClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public static void main(String[] args) {
String instanceId = client.scheduleNewWorkflow(DemoContinueAsNewWorkflow.class);
System.out.printf("Started a new continue-as-new model workflow with instance ID: %s%n", instanceId);

client.waitForInstanceCompletion(instanceId, null, true);
client.waitForWorkflowCompletion(instanceId, null, true);
System.out.printf("workflow instance with ID: %s completed.", instanceId);

} catch (TimeoutException | InterruptedException e) {
Expand Down
2 changes: 1 addition & 1 deletion examples/src/main/java/io/dapr/examples/workflows/externalevent/DemoExternalEventClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public static void main(String[] args) {
client.raiseEvent(instanceId, "Approval", true);
//client.raiseEvent(instanceId, "Approval", false);

client.waitForInstanceCompletion(instanceId, null, true);
client.waitForWorkflowCompletion(instanceId, null, true);
System.out.printf("workflow instance with ID: %s completed.", instanceId);

} catch (TimeoutException | InterruptedException e) {
Expand Down
6 changes: 3 additions & 3 deletions examples/src/main/java/io/dapr/examples/workflows/faninout/DemoFanInOutClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import io.dapr.examples.workflows.utils.PropertyUtils;
import io.dapr.examples.workflows.utils.RetryUtils;
import io.dapr.workflows.client.DaprWorkflowClient;
import io.dapr.workflows.client.WorkflowInstanceStatus;
import io.dapr.workflows.client.WorkflowState;

import java.time.Duration;
import java.util.Arrays;
Expand Down Expand Up @@ -48,12 +48,12 @@ public static void main(String[] args) throws InterruptedException {
System.out.printf("Started a new fan out/fan in model workflow with instance ID: %s%n", instanceId);

// Block until the orchestration completes. Then print the final status, which includes the output.
WorkflowInstanceStatus workflowInstanceStatus = client.waitForInstanceCompletion(
WorkflowState workflowState = client.waitForWorkflowCompletion(
instanceId,
Duration.ofSeconds(30),
true);
System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId,
workflowInstanceStatus.readOutputAs(int.class));
workflowState.readOutputAs(int.class));
} catch (TimeoutException e) {
throw new RuntimeException(e);
}
Expand Down
6 changes: 3 additions & 3 deletions examples/src/main/java/io/dapr/examples/workflows/multiapp/MultiAppWorkflowClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
package io.dapr.examples.workflows.multiapp;

import io.dapr.workflows.client.DaprWorkflowClient;
import io.dapr.workflows.client.WorkflowInstanceStatus;
import io.dapr.workflows.client.WorkflowState;

import java.util.concurrent.TimeoutException;

Expand Down Expand Up @@ -48,8 +48,8 @@ public static void main(String[] args) {

// Wait for the workflow to complete
System.out.println("Waiting for workflow completion...");
WorkflowInstanceStatus workflowInstanceStatus =
client.waitForInstanceCompletion(instanceId, null, true);
WorkflowState workflowInstanceStatus =
client.waitForWorkflowCompletion(instanceId, null, true);

// Get the result
String result = workflowInstanceStatus.readOutputAs(String.class);
Expand Down
8 changes: 4 additions & 4 deletions examples/src/main/java/io/dapr/examples/workflows/suspendresume/DemoSuspendResumeClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import io.dapr.examples.workflows.utils.PropertyUtils;
import io.dapr.examples.workflows.utils.RetryUtils;
import io.dapr.workflows.client.DaprWorkflowClient;
import io.dapr.workflows.client.WorkflowInstanceStatus;
import io.dapr.workflows.client.WorkflowState;

import java.time.Duration;
import java.util.concurrent.TimeoutException;
Expand All @@ -38,21 +38,21 @@ public static void main(String[] args) {
System.out.printf("Suspending Workflow Instance: %s%n", instanceId );
client.suspendWorkflow(instanceId, "suspending workflow instance.");

WorkflowInstanceStatus instanceState = client.getInstanceState(instanceId, false);
WorkflowState instanceState = client.getWorkflowState(instanceId, false);
assert instanceState != null;
System.out.printf("Workflow Instance Status: %s%n", instanceState.getRuntimeStatus().name() );

System.out.printf("Let's resume the Workflow Instance before sending the external event: %s%n", instanceId );
client.resumeWorkflow(instanceId, "resuming workflow instance.");

instanceState = client.getInstanceState(instanceId, false);
instanceState = client.getWorkflowState(instanceId, false);
assert instanceState != null;
System.out.printf("Workflow Instance Status: %s%n", instanceState.getRuntimeStatus().name() );

System.out.printf("Now that the instance is RUNNING again, lets send the external event. %n");
client.raiseEvent(instanceId, "Approval", true);

client.waitForInstanceCompletion(instanceId, null, true);
client.waitForWorkflowCompletion(instanceId, null, true);
System.out.printf("workflow instance with ID: %s completed.", instanceId);

} catch (TimeoutException | InterruptedException e) {
Expand Down
23 changes: 11 additions & 12 deletions sdk-tests/src/test/java/io/dapr/it/testcontainers/workflows/DaprWorkflowsIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,12 @@

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

import io.dapr.testcontainers.Component;
import io.dapr.testcontainers.DaprContainer;
import io.dapr.testcontainers.DaprLogLevel;
import io.dapr.workflows.client.DaprWorkflowClient;
import io.dapr.workflows.client.WorkflowInstanceStatus;
import io.dapr.workflows.client.WorkflowRuntimeStatus;
import io.dapr.workflows.client.WorkflowState;
import io.dapr.workflows.runtime.WorkflowRuntime;
import io.dapr.workflows.runtime.WorkflowRuntimeBuilder;
import org.junit.jupiter.api.BeforeEach;
Expand Down Expand Up @@ -104,11 +103,11 @@ public void testWorkflows() throws Exception {
TestWorkflowPayload payload = new TestWorkflowPayload(new ArrayList<>());
String instanceId = workflowClient.scheduleNewWorkflow(TestWorkflow.class, payload);

workflowClient.waitForInstanceStart(instanceId, Duration.ofSeconds(10), false);
workflowClient.waitForWorkflowCompletion(instanceId, Duration.ofSeconds(10), false);
workflowClient.raiseEvent(instanceId, "MoveForward", payload);

Duration timeout = Duration.ofSeconds(10);
WorkflowInstanceStatus workflowStatus = workflowClient.waitForInstanceCompletion(instanceId, timeout, true);
WorkflowState workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);

assertNotNull(workflowStatus);

Expand All @@ -124,25 +123,25 @@ public void testWorkflows() throws Exception {
public void testSuspendAndResumeWorkflows() throws Exception {
TestWorkflowPayload payload = new TestWorkflowPayload(new ArrayList<>());
String instanceId = workflowClient.scheduleNewWorkflow(TestWorkflow.class, payload);
workflowClient.waitForInstanceStart(instanceId, Duration.ofSeconds(10), false);
workflowClient.waitForWorkflowStart(instanceId, Duration.ofSeconds(10), false);

workflowClient.suspendWorkflow(instanceId, "testing suspend.");


WorkflowInstanceStatus instanceState = workflowClient.getInstanceState(instanceId, false);
WorkflowState instanceState = workflowClient.getWorkflowState(instanceId, false);
assertNotNull(instanceState);
assertEquals(WorkflowRuntimeStatus.SUSPENDED, instanceState.getRuntimeStatus());

workflowClient.resumeWorkflow(instanceId, "testing resume");

instanceState = workflowClient.getInstanceState(instanceId, false);
instanceState = workflowClient.getWorkflowState(instanceId, false);
assertNotNull(instanceState);
assertEquals(WorkflowRuntimeStatus.RUNNING, instanceState.getRuntimeStatus());

workflowClient.raiseEvent(instanceId, "MoveForward", payload);

Duration timeout = Duration.ofSeconds(10);
instanceState = workflowClient.waitForInstanceCompletion(instanceId, timeout, true);
instanceState = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);

assertNotNull(instanceState);
assertEquals(WorkflowRuntimeStatus.COMPLETED, instanceState.getRuntimeStatus());
Expand All @@ -154,10 +153,10 @@ public void testNamedActivitiesWorkflows() throws Exception {
TestWorkflowPayload payload = new TestWorkflowPayload(new ArrayList<>());
String instanceId = workflowClient.scheduleNewWorkflow(TestNamedActivitiesWorkflow.class, payload);

workflowClient.waitForInstanceStart(instanceId, Duration.ofSeconds(10), false);
workflowClient.waitForWorkflowStart(instanceId, Duration.ofSeconds(10), false);

Duration timeout = Duration.ofSeconds(10);
WorkflowInstanceStatus workflowStatus = workflowClient.waitForInstanceCompletion(instanceId, timeout, true);
WorkflowState workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);

assertNotNull(workflowStatus);

Expand All @@ -178,10 +177,10 @@ public void testExecutionKeyWorkflows() throws Exception {
TestWorkflowPayload payload = new TestWorkflowPayload(new ArrayList<>());
String instanceId = workflowClient.scheduleNewWorkflow(TestExecutionKeysWorkflow.class, payload);

workflowClient.waitForInstanceStart(instanceId, Duration.ofSeconds(100), false);
workflowClient.waitForWorkflowStart(instanceId, Duration.ofSeconds(100), false);

Duration timeout = Duration.ofSeconds(1000);
WorkflowInstanceStatus workflowStatus = workflowClient.waitForInstanceCompletion(instanceId, timeout, true);
WorkflowState workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);

assertNotNull(workflowStatus);

Expand Down
Loading
Loading