Class ActivityClientCallsInterceptorBase

java.lang.Object

io.temporal.common.interceptors.ActivityClientCallsInterceptorBase

All Implemented Interfaces:

ActivityClientCallsInterceptor

public class ActivityClientCallsInterceptorBase
extends Object
implements ActivityClientCallsInterceptor

Convenience base class for ActivityClientCallsInterceptor implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.temporal.common.interceptors.ActivityClientCallsInterceptor

ActivityClientCallsInterceptor.CancelActivityInput, ActivityClientCallsInterceptor.CancelActivityOutput, ActivityClientCallsInterceptor.CountActivitiesInput, ActivityClientCallsInterceptor.CountActivitiesOutput, ActivityClientCallsInterceptor.DescribeActivityInput, ActivityClientCallsInterceptor.DescribeActivityOutput, ActivityClientCallsInterceptor.GetActivityResultInput<R>, ActivityClientCallsInterceptor.GetActivityResultOutput<R>, ActivityClientCallsInterceptor.ListActivitiesInput, ActivityClientCallsInterceptor.ListActivitiesOutput, ActivityClientCallsInterceptor.StartActivityInput, ActivityClientCallsInterceptor.StartActivityOutput, ActivityClientCallsInterceptor.TerminateActivityInput, ActivityClientCallsInterceptor.TerminateActivityOutput

Constructor Summary

Constructors

Constructor	Description
ActivityClientCallsInterceptorBase(ActivityClientCallsInterceptor next)

Method Summary

Modifier and Type	Method	Description
ActivityClientCallsInterceptor.CancelActivityOutput	cancelActivity(ActivityClientCallsInterceptor.CancelActivityInput input)	Requests cooperative cancellation of a running standalone activity.
ActivityClientCallsInterceptor.CountActivitiesOutput	countActivities(ActivityClientCallsInterceptor.CountActivitiesInput input)	Returns the count of activity executions matching the Visibility query in input.
ActivityClientCallsInterceptor.DescribeActivityOutput	describeActivity(ActivityClientCallsInterceptor.DescribeActivityInput input)	Returns the current execution description for a standalone activity.
<R> ActivityClientCallsInterceptor.GetActivityResultOutput<R>	getActivityResult(ActivityClientCallsInterceptor.GetActivityResultInput<R> input)	Synchronously long-polls the server until the activity completes, then deserializes and returns the result.
<R> CompletableFuture<ActivityClientCallsInterceptor.GetActivityResultOutput<R>>	getActivityResultAsync(ActivityClientCallsInterceptor.GetActivityResultInput<R> input)	Asynchronously polls for the activity result without blocking the calling thread.
ActivityClientCallsInterceptor.ListActivitiesOutput	listActivities(ActivityClientCallsInterceptor.ListActivitiesInput input)	Returns a lazy Stream of activity execution metadata matching the Visibility query in input.
ActivityClientCallsInterceptor.StartActivityOutput	startActivity(ActivityClientCallsInterceptor.StartActivityInput input)	Schedules a standalone activity for execution.
ActivityClientCallsInterceptor.TerminateActivityOutput	terminateActivity(ActivityClientCallsInterceptor.TerminateActivityInput input)	Forcefully terminates a running standalone activity.

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityClientCallsInterceptorBase

public ActivityClientCallsInterceptorBase(ActivityClientCallsInterceptor next)

Method Details

startActivity

public ActivityClientCallsInterceptor.StartActivityOutput startActivity(ActivityClientCallsInterceptor.StartActivityInput input)

Description copied from interface: ActivityClientCallsInterceptor

Schedules a standalone activity for execution. The activity type name, arguments, and scheduling options are carried in input.

Specified by:

startActivity in interface ActivityClientCallsInterceptor

Parameters:

input - activity type, raw arguments, scheduling options, and propagated header

Returns:

output containing the caller-supplied activity ID and the run ID assigned by the server (if the server provides one)

getActivityResult

public <R>
ActivityClientCallsInterceptor.GetActivityResultOutput<R> getActivityResult(ActivityClientCallsInterceptor.GetActivityResultInput<R> input)
                                                                     throws TimeoutException

Description copied from interface: ActivityClientCallsInterceptor

Synchronously long-polls the server until the activity completes, then deserializes and returns the result. Loops automatically on empty long-poll responses (server-side timeout with no outcome yet). Blocks the calling thread for the duration.

Specified by:

getActivityResult in interface ActivityClientCallsInterceptor

Type Parameters:

R - the expected result type

Parameters:

input - activity ID, optional run ID, and result class and generic type

Returns:

output wrapping the deserialized activity result

Throws:

TimeoutException

getActivityResultAsync

public <R>
CompletableFuture<ActivityClientCallsInterceptor.GetActivityResultOutput<R>> getActivityResultAsync(ActivityClientCallsInterceptor.GetActivityResultInput<R> input)

Description copied from interface: ActivityClientCallsInterceptor

Asynchronously polls for the activity result without blocking the calling thread. Returns a CompletableFuture that completes with the deserialized result when the activity succeeds, or completes exceptionally with ActivityFailedException on failure, or TimeoutException if the deadline in input expires before the activity completes.

The default implementation wraps ActivityClientCallsInterceptor.getActivityResult(io.temporal.common.interceptors.ActivityClientCallsInterceptor.GetActivityResultInput<R>) in a CompletableFuture.supplyAsync(java.util.function.Supplier<U>) call. Interceptors that want true non-blocking behavior should override this method.

Specified by:

getActivityResultAsync in interface ActivityClientCallsInterceptor

Type Parameters:

R - the expected result type

Parameters:

input - activity ID, optional run ID, result class and generic type, and timeout

Returns:

a future that completes with output wrapping the deserialized activity result

describeActivity

public ActivityClientCallsInterceptor.DescribeActivityOutput describeActivity(ActivityClientCallsInterceptor.DescribeActivityInput input)

Description copied from interface: ActivityClientCallsInterceptor

Returns the current execution description for a standalone activity. If a long-poll token from a prior call is present in input, the server blocks until the description changes or the poll times out, enabling efficient change detection.

Specified by:

describeActivity in interface ActivityClientCallsInterceptor

Parameters:

input - activity ID, optional run ID, and optional long-poll token from a prior call

Returns:

output containing the ActivityExecutionDescription; the fresh long-poll token for the next call is stored inside the returned ActivityExecutionDescription

cancelActivity

public ActivityClientCallsInterceptor.CancelActivityOutput cancelActivity(ActivityClientCallsInterceptor.CancelActivityInput input)

Description copied from interface: ActivityClientCallsInterceptor

Requests cooperative cancellation of a running standalone activity. The activity will receive a cancellation request on its next heartbeat; it may choose to honour or ignore it.

Specified by:

cancelActivity in interface ActivityClientCallsInterceptor

Parameters:

input - activity ID, optional run ID, and optional human-readable cancellation reason

Returns:

an empty output object (reserved for future use)

terminateActivity

public ActivityClientCallsInterceptor.TerminateActivityOutput terminateActivity(ActivityClientCallsInterceptor.TerminateActivityInput input)

Description copied from interface: ActivityClientCallsInterceptor

Forcefully terminates a running standalone activity. Unlike cancellation, termination is immediate and cannot be caught or suppressed by the activity.

Specified by:

terminateActivity in interface ActivityClientCallsInterceptor

Parameters:

input - activity ID, optional run ID, and optional human-readable termination reason

Returns:

an empty output object (reserved for future use)

listActivities

public ActivityClientCallsInterceptor.ListActivitiesOutput listActivities(ActivityClientCallsInterceptor.ListActivitiesInput input)

Description copied from interface: ActivityClientCallsInterceptor

Returns a lazy Stream of activity execution metadata matching the Visibility query in input. Pages are fetched from the server on demand as the stream is consumed.

Specified by:

listActivities in interface ActivityClientCallsInterceptor

Parameters:

input - Visibility query string and listing options (e.g. page-size limit)

Returns:

output wrapping a stream of ActivityExecutionMetadata

countActivities

public ActivityClientCallsInterceptor.CountActivitiesOutput countActivities(ActivityClientCallsInterceptor.CountActivitiesInput input)

Description copied from interface: ActivityClientCallsInterceptor

Returns the count of activity executions matching the Visibility query in input.

Specified by:

countActivities in interface ActivityClientCallsInterceptor

Parameters:

input - Visibility query string and count options

Returns:

output wrapping the ActivityExecutionCount