com.uber.cadence.internal.common

Class WorkflowExecutionUtils

java.lang.Object

com.uber.cadence.internal.common.WorkflowExecutionUtils

public class WorkflowExecutionUtils
extends java.lang.Object

Convenience methods to be used by unit tests and during development.

Constructor Summary

Constructors

Constructor and Description
WorkflowExecutionUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	containsEvent(java.util.List<HistoryEvent> history, EventType eventType)
static WorkflowExecutionInfo	describeWorkflowInstance(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution)
static WorkflowExecutionCloseStatus	getCloseStatus(HistoryEvent event)
static EventType	getEventTypeForDecision(DecisionType decisionType)
static java.lang.String	getFailureCause(HistoryEvent historyEvent)
static java.util.Iterator<HistoryEvent>	getHistory(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution)
static GetWorkflowExecutionHistoryResponse	getHistoryPage(byte[] nextPageToken, IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution)
static java.lang.String	getId(HistoryEvent historyEvent)
static HistoryEvent	getInstanceCloseEvent(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution, long timeout, java.util.concurrent.TimeUnit unit) Returns an instance closing event, potentially waiting for workflow to complete.
static byte[]	getWorkflowExecutionResult(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution, java.util.Optional<java.lang.String> workflowType, long timeout, java.util.concurrent.TimeUnit unit) Returns result of a workflow instance execution or throws an exception if workflow did not complete successfully.
static java.util.concurrent.CompletableFuture<byte[]>	getWorkflowExecutionResultAsync(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution, java.util.Optional<java.lang.String> workflowType, long timeout, java.util.concurrent.TimeUnit unit)
static WorkflowExecution	getWorkflowIdFromExternalWorkflowCompletedEvent(HistoryEvent event)
static boolean	isActivityTaskClosedEvent(HistoryEvent event)
static boolean	isDecisionEvent(HistoryEvent event) Is this an event that was created to mirror a decision?
static boolean	isExternalWorkflowClosedEvent(HistoryEvent event)
static boolean	isWorkflowExecutionCompleteDecision(Decision decision)
static boolean	isWorkflowExecutionCompletedEvent(HistoryEvent event)
static java.lang.String	prettyPrintDecision(Decision decision) Returns single decision in a human readable format
static java.lang.String	prettyPrintDecisions(java.lang.Iterable<Decision> decisions)
static java.lang.String	prettyPrintHistory(History history, boolean showWorkflowTasks) Returns workflow instance history in a human readable format.
static java.lang.String	prettyPrintHistory(java.util.Iterator<HistoryEvent> events, boolean showWorkflowTasks)
static java.lang.String	prettyPrintHistory(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution) Returns workflow instance history in a human readable format.
static java.lang.String	prettyPrintHistory(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution, boolean showWorkflowTasks) Returns workflow instance history in a human readable format.
static java.lang.String	prettyPrintHistoryEvent(HistoryEvent event) Returns single event in a human readable format
static WorkflowExecutionCloseStatus	waitForWorkflowInstanceCompletion(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution) Blocks until workflow instance completes.
static WorkflowExecutionCloseStatus	waitForWorkflowInstanceCompletion(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution, long timeout, java.util.concurrent.TimeUnit unit) Waits up to specified timeout for workflow instance completion.
static WorkflowExecutionCloseStatus	waitForWorkflowInstanceCompletionAcrossGenerations(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution) Like waitForWorkflowInstanceCompletion(IWorkflowService, String, WorkflowExecution, long, TimeUnit) , but with no timeout.*
static WorkflowExecutionCloseStatus	waitForWorkflowInstanceCompletionAcrossGenerations(IWorkflowService service, java.lang.String domain, WorkflowExecution workflowExecution, long timeout, java.util.concurrent.TimeUnit unit) Like waitForWorkflowInstanceCompletion(IWorkflowService, String, WorkflowExecution, long, TimeUnit) , except will wait for continued generations of the original workflow execution too.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowExecutionUtils

public WorkflowExecutionUtils()

Method Detail

getWorkflowExecutionResult

public static byte[] getWorkflowExecutionResult(IWorkflowService service,
                                                java.lang.String domain,
                                                WorkflowExecution workflowExecution,
                                                java.util.Optional<java.lang.String> workflowType,
                                                long timeout,
                                                java.util.concurrent.TimeUnit unit)
                                         throws java.util.concurrent.TimeoutException,
                                                java.util.concurrent.CancellationException,
                                                WorkflowExecutionFailedException,
                                                WorkflowTerminatedException,
                                                WorkflowTimedOutException,
                                                EntityNotExistsError

Returns result of a workflow instance execution or throws an exception if workflow did not complete successfully.

Parameters:

workflowType - is optional.

Throws:

java.util.concurrent.TimeoutException - if workflow didn't complete within specified timeout

java.util.concurrent.CancellationException - if workflow was cancelled

WorkflowExecutionFailedException - if workflow execution failed

WorkflowTimedOutException - if workflow execution exceeded its execution timeout and was forcefully terminated by the Cadence server.

WorkflowTerminatedException - if workflow execution was terminated through an external terminate command.

EntityNotExistsError

getWorkflowExecutionResultAsync

public static java.util.concurrent.CompletableFuture<byte[]> getWorkflowExecutionResultAsync(IWorkflowService service,
                                                                                             java.lang.String domain,
                                                                                             WorkflowExecution workflowExecution,
                                                                                             java.util.Optional<java.lang.String> workflowType,
                                                                                             long timeout,
                                                                                             java.util.concurrent.TimeUnit unit)

getInstanceCloseEvent

public static HistoryEvent getInstanceCloseEvent(IWorkflowService service,
                                                 java.lang.String domain,
                                                 WorkflowExecution workflowExecution,
                                                 long timeout,
                                                 java.util.concurrent.TimeUnit unit)
                                          throws java.util.concurrent.TimeoutException,
                                                 EntityNotExistsError

Returns an instance closing event, potentially waiting for workflow to complete.

Throws:

java.util.concurrent.TimeoutException

EntityNotExistsError

isWorkflowExecutionCompletedEvent

public static boolean isWorkflowExecutionCompletedEvent(HistoryEvent event)

isWorkflowExecutionCompleteDecision

public static boolean isWorkflowExecutionCompleteDecision(Decision decision)

isActivityTaskClosedEvent

public static boolean isActivityTaskClosedEvent(HistoryEvent event)

isExternalWorkflowClosedEvent

public static boolean isExternalWorkflowClosedEvent(HistoryEvent event)

getWorkflowIdFromExternalWorkflowCompletedEvent

public static WorkflowExecution getWorkflowIdFromExternalWorkflowCompletedEvent(HistoryEvent event)

getId

public static java.lang.String getId(HistoryEvent historyEvent)

getFailureCause

public static java.lang.String getFailureCause(HistoryEvent historyEvent)

waitForWorkflowInstanceCompletion

public static WorkflowExecutionCloseStatus waitForWorkflowInstanceCompletion(IWorkflowService service,
                                                                             java.lang.String domain,
                                                                             WorkflowExecution workflowExecution)
                                                                      throws EntityNotExistsError

Blocks until workflow instance completes. Never use in production setting as polling for worklow instance status is an expensive operation.

Parameters:

workflowExecution - result of WorkflowService.Iface.StartWorkflowExecution(StartWorkflowExecutionRequest)

Returns:

instance close status

Throws:

EntityNotExistsError

waitForWorkflowInstanceCompletion

public static WorkflowExecutionCloseStatus waitForWorkflowInstanceCompletion(IWorkflowService service,
                                                                             java.lang.String domain,
                                                                             WorkflowExecution workflowExecution,
                                                                             long timeout,
                                                                             java.util.concurrent.TimeUnit unit)
                                                                      throws java.util.concurrent.TimeoutException,
                                                                             EntityNotExistsError

Waits up to specified timeout for workflow instance completion. Never use in production setting as polling for worklow instance status is an expensive operation.

Parameters:

workflowExecution - result of WorkflowService.Iface.StartWorkflowExecution(StartWorkflowExecutionRequest)

timeout - maximum time to wait for completion. 0 means wait forever.

Returns:

instance close status

Throws:

java.util.concurrent.TimeoutException

EntityNotExistsError

getCloseStatus

public static WorkflowExecutionCloseStatus getCloseStatus(HistoryEvent event)

waitForWorkflowInstanceCompletionAcrossGenerations

public static WorkflowExecutionCloseStatus waitForWorkflowInstanceCompletionAcrossGenerations(IWorkflowService service,
                                                                                              java.lang.String domain,
                                                                                              WorkflowExecution workflowExecution,
                                                                                              long timeout,
                                                                                              java.util.concurrent.TimeUnit unit)
                                                                                       throws java.util.concurrent.TimeoutException,
                                                                                              EntityNotExistsError

Like waitForWorkflowInstanceCompletion(IWorkflowService, String, WorkflowExecution, long, TimeUnit) , except will wait for continued generations of the original workflow execution too.

Throws:

java.util.concurrent.TimeoutException

EntityNotExistsError

See Also:

waitForWorkflowInstanceCompletion(IWorkflowService, String, WorkflowExecution, long, TimeUnit)

waitForWorkflowInstanceCompletionAcrossGenerations

public static WorkflowExecutionCloseStatus waitForWorkflowInstanceCompletionAcrossGenerations(IWorkflowService service,
                                                                                              java.lang.String domain,
                                                                                              WorkflowExecution workflowExecution)
                                                                                       throws java.lang.InterruptedException,
                                                                                              EntityNotExistsError

Like waitForWorkflowInstanceCompletion(IWorkflowService, String, WorkflowExecution, long, TimeUnit) , but with no timeout.*

Throws:

java.lang.InterruptedException

EntityNotExistsError

describeWorkflowInstance

public static WorkflowExecutionInfo describeWorkflowInstance(IWorkflowService service,
                                                             java.lang.String domain,
                                                             WorkflowExecution workflowExecution)

prettyPrintHistory

public static java.lang.String prettyPrintHistory(IWorkflowService service,
                                                  java.lang.String domain,
                                                  WorkflowExecution workflowExecution)

Returns workflow instance history in a human readable format.

prettyPrintHistory

public static java.lang.String prettyPrintHistory(IWorkflowService service,
                                                  java.lang.String domain,
                                                  WorkflowExecution workflowExecution,
                                                  boolean showWorkflowTasks)

Returns workflow instance history in a human readable format.

Parameters:

showWorkflowTasks - when set to false workflow task events (decider events) are not included

getHistory

public static java.util.Iterator<HistoryEvent> getHistory(IWorkflowService service,
                                                          java.lang.String domain,
                                                          WorkflowExecution workflowExecution)

getHistoryPage

public static GetWorkflowExecutionHistoryResponse getHistoryPage(byte[] nextPageToken,
                                                                 IWorkflowService service,
                                                                 java.lang.String domain,
                                                                 WorkflowExecution workflowExecution)

prettyPrintHistory

public static java.lang.String prettyPrintHistory(History history,
                                                  boolean showWorkflowTasks)

Returns workflow instance history in a human readable format.

Parameters:

showWorkflowTasks - when set to false workflow task events (decider events) are not included

prettyPrintHistory

public static java.lang.String prettyPrintHistory(java.util.Iterator<HistoryEvent> events,
                                                  boolean showWorkflowTasks)

prettyPrintDecisions

public static java.lang.String prettyPrintDecisions(java.lang.Iterable<Decision> decisions)

prettyPrintHistoryEvent

public static java.lang.String prettyPrintHistoryEvent(HistoryEvent event)

Returns single event in a human readable format

Parameters:

event - event to pretty print

prettyPrintDecision

public static java.lang.String prettyPrintDecision(Decision decision)

Returns single decision in a human readable format

Parameters:

decision - decision to pretty print

containsEvent

public static boolean containsEvent(java.util.List<HistoryEvent> history,
                                    EventType eventType)

isDecisionEvent

public static boolean isDecisionEvent(HistoryEvent event)

Is this an event that was created to mirror a decision?

getEventTypeForDecision

public static EventType getEventTypeForDecision(DecisionType decisionType)