io.temporal.common.interceptors

Class ActivityExecutionContextBase

java.lang.Object

io.temporal.common.interceptors.ActivityExecutionContextBase

All Implemented Interfaces:

ActivityExecutionContext

public class ActivityExecutionContextBase
extends java.lang.Object
implements ActivityExecutionContext

Convenience class for implementing ActivityInterceptors.

Constructor Summary

Constructors

Constructor and Description
ActivityExecutionContextBase(ActivityExecutionContext next)

Method Summary

Modifier and Type	Method and Description
void	doNotCompleteOnReturn() If this method is called during an activity execution then activity is not going to complete when its method returns.
<V> java.util.Optional<V>	getHeartbeatDetails(java.lang.Class<V> detailsClass) Extracts heartbeat details from the last failed attempt.
<V> java.util.Optional<V>	getHeartbeatDetails(java.lang.Class<V> detailsClass, java.lang.reflect.Type detailsType) Extracts heartbeat details from the last failed attempt.
ActivityInfo	getInfo() Information about activity invocation and the caller workflow
com.uber.m3.tally.Scope	getMetricsScope()
byte[]	getTaskToken() A correlation token that can be used to complete the activity asynchronously through ActivityCompletionClient.complete(byte[], Object).
<V> void	heartbeat(V details) Use to notify Simple Workflow that activity execution is alive.
boolean	isDoNotCompleteOnReturn()
boolean	isUseLocalManualCompletion() Returns true if ActivityExecutionContext.useLocalManualCompletion() method has been called on this context.
ManualActivityCompletionClient	useLocalManualCompletion() Local manual completion, sets ActivityExecutionContext.doNotCompleteOnReturn() flag making activity completion asynchronous, also returns completion client.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityExecutionContextBase

public ActivityExecutionContextBase(ActivityExecutionContext next)

Method Detail

getInfo

public ActivityInfo getInfo()

Description copied from interface: ActivityExecutionContext

Information about activity invocation and the caller workflow

Specified by:

getInfo in interface ActivityExecutionContext

heartbeat

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

Description copied from interface: ActivityExecutionContext

Use to notify Simple Workflow that activity execution is alive.

Specified by:

heartbeat in interface ActivityExecutionContext

Parameters:

details - In case of activity timeout details are returned as a field of the exception thrown.

Throws:

ActivityCompletionException - Indicates that activity cancellation was requested by the workflow or any other reason for activity to stop execution. Should be rethrown from activity implementation to indicate successful cancellation.

getHeartbeatDetails

public <V> java.util.Optional<V> getHeartbeatDetails(java.lang.Class<V> detailsClass)

Description copied from interface: ActivityExecutionContext

Extracts heartbeat details from the last failed attempt. This is used in combination with retry options. An activity could be scheduled with an optional RetryOptions on ActivityOptions. If an activity failed then the server would attempt to dispatch another activity task to retry according to the retry options. If there was heartbeat details reported by the activity from the failed attempt, the details would be delivered along with the activity task for the retry attempt. The activity could extract the details by ActivityExecutionContext.getHeartbeatDetails(Class)() and resume from the progress.

Specified by:

getHeartbeatDetails in interface ActivityExecutionContext

Parameters:

detailsClass - type of the heartbeat details

getHeartbeatDetails

public <V> java.util.Optional<V> getHeartbeatDetails(java.lang.Class<V> detailsClass,
                                                     java.lang.reflect.Type detailsType)

Description copied from interface: ActivityExecutionContext

Extracts heartbeat details from the last failed attempt. This is used in combination with retry options. An activity could be scheduled with an optional RetryOptions on ActivityOptions. If an activity failed then the server would attempt to dispatch another activity task to retry according to the retry options. If there was heartbeat details reported by the activity from the failed attempt, the details would be delivered along with the activity task for the retry attempt. The activity could extract the details by ActivityExecutionContext.getHeartbeatDetails(Class)() and resume from the progress.

Specified by:

getHeartbeatDetails in interface ActivityExecutionContext

Parameters:

detailsClass - type of the heartbeat details

getTaskToken

public byte[] getTaskToken()

Description copied from interface: ActivityExecutionContext

A correlation token that can be used to complete the activity asynchronously through ActivityCompletionClient.complete(byte[], Object).

Specified by:

getTaskToken in interface ActivityExecutionContext

doNotCompleteOnReturn

public void doNotCompleteOnReturn()

Description copied from interface: ActivityExecutionContext

If this method is called during an activity execution then activity is not going to complete when its method returns. It is expected to be completed asynchronously using ActivityCompletionClient. Note that async activities that have ActivityExecutionContext.isUseLocalManualCompletion() set to false would not respect the limit defined by WorkerOptions.getMaxConcurrentActivityExecutionSize(). If you want to limit the number of concurrent async activities and if you always complete those activities from the same activity worker you should use ActivityExecutionContext.useLocalManualCompletion() instead.

Specified by:

doNotCompleteOnReturn in interface ActivityExecutionContext

isDoNotCompleteOnReturn

public boolean isDoNotCompleteOnReturn()

Specified by:

isDoNotCompleteOnReturn in interface ActivityExecutionContext

isUseLocalManualCompletion

public boolean isUseLocalManualCompletion()

Description copied from 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()

Specified by:

isUseLocalManualCompletion in interface ActivityExecutionContext

useLocalManualCompletion

public ManualActivityCompletionClient useLocalManualCompletion()

Description copied from interface: ActivityExecutionContext

Local manual completion, sets ActivityExecutionContext.doNotCompleteOnReturn() flag making activity completion asynchronous, also returns completion client. Returned completion client must be used to complete the activity on the same machine. Main difference from calling ActivityExecutionContext.doNotCompleteOnReturn() directly is that by using this method maximum number of concurrent activities defined by WorkerOptions.getMaxConcurrentActivityExecutionSize() will be respected. Users must be careful and always call completion method on the ManualActivityCompletionClient otherwise activity worker could stop polling new work as it will consider all activities that didn't explicitly finish as still running.

Specified by:

useLocalManualCompletion in interface ActivityExecutionContext

getMetricsScope

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

Specified by:

getMetricsScope in interface ActivityExecutionContext