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 4 commits into
base: master
Choose a base branch
from
+129 −52
Open

Align Java API with other languages #1560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
592b883
Align Java API with other languages
mcruzdev Sep 20, 2025
d272d88
Apply checkstyle
mcruzdev Sep 20, 2025
5449651
Remove deprecated usages
mcruzdev Sep 21, 2025
af554a6
Merge branch 'master' into issue-1554
mcruzdev Sep 23, 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
12 changes: 6 additions & 6 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 @@ -514,7 +514,7 @@ public class DemoWorkflowClient {

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

System.out.println(separatorStr);
Expand Down Expand Up @@ -545,13 +545,13 @@ public class DemoWorkflowClient {


System.out.println(separatorStr);
System.out.println("**WaitForInstanceCompletion**");
System.out.println("**waitForWorkflowCompletion**");
try {
WorkflowInstanceStatus waitForInstanceCompletionResult =
client.waitForInstanceCompletion(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForInstanceCompletionResult);
WorkflowInstanceStatus 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
14 changes: 7 additions & 7 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,7 +104,7 @@ public class DemoWorkflowClient {

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

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


System.out.println(separatorStr);
System.out.println("**WaitForInstanceCompletion**");
System.out.println("**waitForWorkflowCompletion**");
try {
WorkflowInstanceStatus waitForInstanceCompletionResult =
client.waitForInstanceCompletion(instanceId, Duration.ofSeconds(60), true);
System.out.printf("Result: %s%n", waitForInstanceCompletionResult);
WorkflowInstanceStatus 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
2 changes: 1 addition & 1 deletion 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 @@ -35,7 +35,7 @@ public static void main(String[] args) {

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

String result = workflowInstanceStatus.readOutputAs(String.class);
System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId, result);
Expand Down
2 changes: 1 addition & 1 deletion ...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 @@ -31,7 +31,7 @@ public static void main(String[] 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);
client.waitForWorkflowCompletion(instanceId, null, true);

String result = workflowInstanceStatus.readOutputAs(String.class);
System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId, result);
Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -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);
WorkflowInstanceStatus 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
2 changes: 1 addition & 1 deletion 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 @@ -48,7 +48,7 @@ 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(
WorkflowInstanceStatus workflowInstanceStatus = client.waitForWorkflowCompletion(
instanceId,
Duration.ofSeconds(30),
true);
Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -49,7 +49,7 @@ 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);
client.waitForWorkflowCompletion(instanceId, null, true);

// Get the result
String result = workflowInstanceStatus.readOutputAs(String.class);
Expand Down
6 changes: 3 additions & 3 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 @@ -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);
WorkflowInstanceStatus 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
20 changes: 10 additions & 10 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 @@ -104,11 +104,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.waitForWorkflowStart(instanceId, Duration.ofSeconds(10), false);
workflowClient.raiseEvent(instanceId, "MoveForward", payload);

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

assertNotNull(workflowStatus);

Expand All @@ -124,25 +124,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);
WorkflowInstanceStatus 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 +154,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);
WorkflowInstanceStatus workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);

assertNotNull(workflowStatus);

Expand All @@ -178,10 +178,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);
WorkflowInstanceStatus workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, timeout, true);

assertNotNull(workflowStatus);

Expand Down
4 changes: 2 additions & 2 deletions ...st/java/io/dapr/it/testcontainers/workflows/multiapp/WorkflowsMultiAppCallActivityIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,9 +175,9 @@ public void testMultiAppWorkflow() throws Exception {
try {
String instanceId = workflowClient.scheduleNewWorkflow(MultiAppWorkflow.class, input);
assertNotNull(instanceId, "Workflow instance ID should not be null");
workflowClient.waitForInstanceStart(instanceId, Duration.ofSeconds(30), false);
workflowClient.waitForWorkflowStart(instanceId, Duration.ofSeconds(30), false);

WorkflowInstanceStatus workflowStatus = workflowClient.waitForInstanceCompletion(instanceId, null, true);
WorkflowInstanceStatus workflowStatus = workflowClient.waitForWorkflowCompletion(instanceId, null, true);
assertNotNull(workflowStatus, "Workflow status should not be null");
assertEquals(WorkflowRuntimeStatus.COMPLETED, workflowStatus.getRuntimeStatus(),
"Workflow should complete successfully");
Expand Down
Loading
Loading