Class ActivityExecutionContextBase

java.lang.Object

io.temporal.common.interceptors.ActivityExecutionContextBase

All Implemented Interfaces:

ActivityExecutionContext

public class ActivityExecutionContextBase
extends Object
implements ActivityExecutionContext

Convenience class for implementing ActivityInterceptors.

Constructor Summary

Constructors

Constructor	Description
ActivityExecutionContextBase(ActivityExecutionContext next)

Method Summary

Modifier and Type	Method	Description
void	doNotCompleteOnReturn()	If this method is called during an Activity Execution then the Activity Execution is not going to complete when its method returns.
ActivityCancellationToken	getCancellationToken()	Returns a token that can be used by Activity code to observe cancellation requests without recording Heartbeats.
<V> Optional<V>	getHeartbeatDetails(Class<V> detailsClass)	Extracts Heartbeat details from the last heartbeat of this Activity Execution attempt.
<V> Optional<V>	getHeartbeatDetails(Class<V> detailsClass, Type detailsGenericType)	Extracts Heartbeat details from the last heartbeat of this Activity Execution attempt.
ActivityInfo	getInfo()	Information about the Activity Execution and the Workflow Execution that invoked it.
Object	getInstance()	Get the currently running activity instance.
<V> Optional<V>	getLastHeartbeatDetails(Class<V> detailsClass)	Returns details from the last failed attempt of this Activity Execution.
<V> Optional<V>	getLastHeartbeatDetails(Class<V> detailsClass, Type detailsGenericType)	Returns details from the last failed attempt of this Activity Execution.
com.uber.m3.tally.Scope	getMetricsScope()	Get scope for reporting business metrics in activity logic.
byte[]	getTaskToken()	Gets a correlation token that can be used to complete the Activity Execution asynchronously through ActivityCompletionClient.complete(byte[], Object).
WorkflowClient	getWorkflowClient()	Get a WorkflowClient that can be used to start interact with the Temporal service from an activity.
<V> void	heartbeat(V details)	Used to notify the Workflow Execution that the Activity Execution is alive.
boolean	isDoNotCompleteOnReturn()
boolean	isUseLocalManualCompletion()
ManualActivityCompletionClient	useLocalManualCompletion()	For local manual completion, sets the ActivityExecutionContext.doNotCompleteOnReturn() flag, making Activity Execution completion asynchronous, and returns the completion client.

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityExecutionContextBase

public ActivityExecutionContextBase(ActivityExecutionContext next)

Method Details

getInfo

public ActivityInfo getInfo()

Description copied from interface: ActivityExecutionContext

Information about the Activity Execution and the Workflow Execution that invoked it.

Specified by:

getInfo in interface ActivityExecutionContext

heartbeat

public <V> void heartbeat(V details)
                   throws ActivityCompletionException

Description copied from interface: ActivityExecutionContext

Used to notify the Workflow Execution that the Activity Execution is alive.

Specified by:

heartbeat in interface ActivityExecutionContext

Parameters:

details - In case the Activity Execution times out details are returned as a field of the exception that is thrown. The details are also accessible through ActivityExecutionContext.getHeartbeatDetails(Class)() on the next Activity Execution retry.

Throws:

ActivityCompletionException - Which indicates that cancellation of the Activity Execution was requested by the Workflow Execution. Or it could indicate any other reason for an Activity Execution to stop. Should be rethrown from the Activity implementation to indicate a successful cancellation.

getHeartbeatDetails

public <V> Optional<V> getHeartbeatDetails(Class<V> detailsClass)

Description copied from interface: ActivityExecutionContext

Extracts Heartbeat details from the last heartbeat of this Activity Execution attempt. If there were no heartbeats in this attempt, details from the last failed attempt are returned instead. This is used in combination with retry options. An Activity Execution could be scheduled with optional RetryOptions via ActivityOptions. If an Activity Execution failed then the server would attempt to dispatch another Activity Task to retry the execution according to the retry options. If there were Heartbeat details reported by the last Activity Execution that failed, they would be delivered along with the Activity Task for the next retry attempt and can be extracted by the Activity implementation.

Specified by:

getHeartbeatDetails in interface ActivityExecutionContext

Parameters:

detailsClass - Class of the Heartbeat details

getHeartbeatDetails

public <V> Optional<V> getHeartbeatDetails(Class<V> detailsClass,
 Type detailsGenericType)

Description copied from interface: ActivityExecutionContext

Extracts Heartbeat details from the last heartbeat of this Activity Execution attempt. If there were no heartbeats in this attempt, details from the last failed attempt are returned instead. It is useful in combination with retry options. An Activity Execution could be scheduled with optional RetryOptions via ActivityOptions. If an Activity Execution failed then the server would attempt to dispatch another Activity Task to retry the execution according to the retry options. If there were Heartbeat details reported by the last Activity Execution that failed, the details would be delivered along with the Activity Task for the next retry attempt. The Activity implementation can extract the details via ActivityExecutionContext.getHeartbeatDetails(Class)() and resume progress.

Specified by:

getHeartbeatDetails in interface ActivityExecutionContext

Parameters:

detailsClass - Class of the Heartbeat details

detailsGenericType - Type of the Heartbeat details

getLastHeartbeatDetails

public <V> Optional<V> getLastHeartbeatDetails(Class<V> detailsClass)

Description copied from interface: ActivityExecutionContext

Returns details from the last failed attempt of this Activity Execution. Unlike ActivityExecutionContext.getHeartbeatDetails(Class), the returned details are not updated on every heartbeat call within the current attempt.

Specified by:

getLastHeartbeatDetails in interface ActivityExecutionContext

Parameters:

detailsClass - Class of the Heartbeat details

getLastHeartbeatDetails

public <V> Optional<V> getLastHeartbeatDetails(Class<V> detailsClass,
 Type detailsGenericType)

Description copied from interface: ActivityExecutionContext

Returns details from the last failed attempt of this Activity Execution. Unlike ActivityExecutionContext.getHeartbeatDetails(Class, Type), the returned details are not updated on every heartbeat call within the current attempt.

Specified by:

getLastHeartbeatDetails in interface ActivityExecutionContext

Parameters:

detailsClass - Class of the Heartbeat details

detailsGenericType - Type of the Heartbeat details

getTaskToken

public byte[] getTaskToken()

Description copied from interface: ActivityExecutionContext

Gets a correlation token that can be used to complete the Activity Execution asynchronously through ActivityCompletionClient.complete(byte[], Object).

Specified by:

getTaskToken in interface ActivityExecutionContext

getCancellationToken

public ActivityCancellationToken getCancellationToken()

Description copied from interface: ActivityExecutionContext

Returns a token that can be used by Activity code to observe cancellation requests without recording Heartbeats.

Specified by:

getCancellationToken in interface ActivityExecutionContext

doNotCompleteOnReturn

public void doNotCompleteOnReturn()

Description copied from interface: ActivityExecutionContext

If this method is called during an Activity Execution then the Activity Execution is not going to complete when its method returns. It is expected to be completed asynchronously using ActivityCompletionClient.

Async Activity Executions that have ActivityExecutionContext.isUseLocalManualCompletion() set to false will not respect the limit defined by WorkerOptions.getMaxConcurrentActivityExecutionSize().

If you want to maintain the workflow's limit on the total number of concurrent Activity Executions and if you always complete those Activity Executions within the same Java process, you may use ActivityExecutionContext.useLocalManualCompletion() instead.

Specified by:

doNotCompleteOnReturn in interface ActivityExecutionContext

See Also:

• as a stricter version of this method respecting the worker's concurrent activities limit

isDoNotCompleteOnReturn

public boolean isDoNotCompleteOnReturn()

Specified by:

isDoNotCompleteOnReturn in interface ActivityExecutionContext

Returns:

true if ActivityExecutionContext.doNotCompleteOnReturn() was called and supported by the activity type, false otherwise

isUseLocalManualCompletion

public boolean isUseLocalManualCompletion()

Specified by:

isUseLocalManualCompletion in interface ActivityExecutionContext

Returns:

true if ActivityExecutionContext.useLocalManualCompletion() method has been called on this context. If this flag is set to true, ActivityWorker would not release concurrency semaphore and delegate release function to the manual Activity client returned by ActivityExecutionContext.useLocalManualCompletion()

useLocalManualCompletion

public ManualActivityCompletionClient useLocalManualCompletion()

Description copied from interface: ActivityExecutionContext

For local manual completion, sets the ActivityExecutionContext.doNotCompleteOnReturn() flag, making Activity Execution completion asynchronous, and returns the completion client. Returned completion client must be used to complete the Activity Execution inside the same Java process.

The completion client returned from this method updates the Worker's Active Activity Executions Counter. This way the limit of concurrent Activity Executions defined by WorkerOptions.Builder.setMaxConcurrentActivityExecutionSize(int) is respected. It's the main difference of this method from calling ActivityExecutionContext.doNotCompleteOnReturn().

Always call one of the completion methods on the obtained completion client. Otherwise, an Activity Worker could stop polling as it will consider Activity Executions that wasn't explicitly completed as still running.

Specified by:

useLocalManualCompletion in interface ActivityExecutionContext

getMetricsScope

public com.uber.m3.tally.Scope getMetricsScope()

Description copied from interface: ActivityExecutionContext

Get scope for reporting business metrics in activity logic. This scope is tagged with a workflow and an activity type.

The original metrics scope is set through ServiceStubsOptions.Builder.setMetricsScope(Scope) when a worker starts up.

Specified by:

getMetricsScope in interface ActivityExecutionContext

getWorkflowClient

public WorkflowClient getWorkflowClient()

Description copied from interface: ActivityExecutionContext

Get a WorkflowClient that can be used to start interact with the Temporal service from an activity.

Specified by:

getWorkflowClient in interface ActivityExecutionContext

getInstance

public Object getInstance()

Description copied from interface: ActivityExecutionContext

Get the currently running activity instance.

Specified by:

getInstance in interface ActivityExecutionContext