Class ActivityHandleImpl

java.lang.Object

io.temporal.internal.client.ActivityHandleImpl

All Implemented Interfaces:

UntypedActivityHandle

public final class ActivityHandleImpl
extends Object
implements UntypedActivityHandle

Implementation of UntypedActivityHandle that delegates lifecycle operations through the interceptor chain.

Constructor Summary

Constructors

Constructor	Description
ActivityHandleImpl(String activityId, String activityRunId, ActivityClientCallsInterceptor clientCallsInterceptor)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Requests cancellation of the activity.
void	cancel(String reason)	Requests cancellation of the activity with an optional reason.
ActivityExecutionDescription	describe()	Describes the current state of the activity execution.
String	getActivityId()	The user-assigned activity ID.
String	getActivityRunId()	The server-assigned run ID for this execution.
<R> R	getResult(long timeout, TimeUnit unit, Class<R> resultClass)	Blocks until the standalone activity completes and returns the typed result, or throws if the timeout expires before the activity completes.
<R> R	getResult(long timeout, TimeUnit unit, Class<R> resultClass, Type resultType)	Blocks until the standalone activity completes and returns the typed result, or throws if the timeout expires.
<R> R	getResult(Class<R> resultClass)	Blocks until the standalone activity completes and returns the typed result.
<R> R	getResult(Class<R> resultClass, Type resultType)	Blocks until the standalone activity completes and returns the typed result.
<R> CompletableFuture<R>	getResultAsync(long timeout, TimeUnit unit, Class<R> resultClass)	Returns a future that completes when the activity completes, or fails with TimeoutException if the activity does not complete within the specified timeout.
<R> CompletableFuture<R>	getResultAsync(long timeout, TimeUnit unit, Class<R> resultClass, Type resultType)	Returns a future for generic return types with a timeout.
<R> CompletableFuture<R>	getResultAsync(Class<R> resultClass)	Returns a future that completes when the activity completes and resolves to the typed result.
<R> CompletableFuture<R>	getResultAsync(Class<R> resultClass, Type resultType)	Returns a future for generic return types (e.g.
void	terminate()	Terminates the activity immediately, regardless of its current state.
void	terminate(String reason)	Terminates the activity immediately with a reason.

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityHandleImpl

public ActivityHandleImpl(String activityId,
 @Nullable
 String activityRunId,
 ActivityClientCallsInterceptor clientCallsInterceptor)

Method Details

getActivityId

public String getActivityId()

Description copied from interface: UntypedActivityHandle

The user-assigned activity ID.

Specified by:

getActivityId in interface UntypedActivityHandle

getActivityRunId

@Nullable
public String getActivityRunId()

Description copied from interface: UntypedActivityHandle

The server-assigned run ID for this execution. Present when the handle was returned by ActivityClient.start(java.lang.Class<I>, io.temporal.workflow.Functions.Proc1<I>, io.temporal.client.StartActivityOptions). May be null when obtained via ActivityClient.getHandle(String, String) with a null run ID — call UntypedActivityHandle.describe() to retrieve the current run ID.

Specified by:

getActivityRunId in interface UntypedActivityHandle

getResult

public <R> R getResult(Class<R> resultClass)

Description copied from interface: UntypedActivityHandle

Blocks until the standalone activity completes and returns the typed result. Polls the server via long-polling.

Specified by:

getResult in interface UntypedActivityHandle

Parameters:

resultClass - the class to deserialize the result into

getResult

public <R> R getResult(Class<R> resultClass,
 @Nullable
 Type resultType)

Description copied from interface: UntypedActivityHandle

Blocks until the standalone activity completes and returns the typed result. Use this overload for generic return types (e.g. List<String>).

Specified by:

getResult in interface UntypedActivityHandle

Parameters:

resultClass - the class to deserialize the result into

resultType - the generic type to use for deserialization; may be null

getResult

public <R> R getResult(long timeout,
 TimeUnit unit,
 Class<R> resultClass)
                throws TimeoutException

Description copied from interface: UntypedActivityHandle

Blocks until the standalone activity completes and returns the typed result, or throws if the timeout expires before the activity completes.

Specified by:

getResult in interface UntypedActivityHandle

Parameters:

timeout - maximum time to wait

unit - unit of timeout

resultClass - the class to deserialize the result into

Throws:

TimeoutException - if the client-side timeout expires before the activity completes

getResult

public <R> R getResult(long timeout,
 TimeUnit unit,
 Class<R> resultClass,
 @Nullable
 Type resultType)
                throws TimeoutException

Description copied from interface: UntypedActivityHandle

Blocks until the standalone activity completes and returns the typed result, or throws if the timeout expires. Use this overload for generic return types (e.g. List<String>).

Specified by:

getResult in interface UntypedActivityHandle

Parameters:

timeout - maximum time to wait

unit - unit of timeout

resultClass - the class to deserialize the result into

resultType - the generic type to use for deserialization; may be null

Throws:

TimeoutException - if the client-side timeout expires before the activity completes

getResultAsync

public <R> CompletableFuture<R> getResultAsync(Class<R> resultClass)

Description copied from interface: UntypedActivityHandle

Returns a future that completes when the activity completes and resolves to the typed result.

Specified by:

getResultAsync in interface UntypedActivityHandle

Parameters:

resultClass - the class to deserialize the result into

getResultAsync

public <R> CompletableFuture<R> getResultAsync(Class<R> resultClass,
 @Nullable
 Type resultType)

Description copied from interface: UntypedActivityHandle

Returns a future for generic return types (e.g. List<String>).

Specified by:

getResultAsync in interface UntypedActivityHandle

Parameters:

resultClass - the class to deserialize the result into

resultType - the generic type to use for deserialization; may be null

getResultAsync

public <R> CompletableFuture<R> getResultAsync(long timeout,
 TimeUnit unit,
 Class<R> resultClass)

Description copied from interface: UntypedActivityHandle

Returns a future that completes when the activity completes, or fails with TimeoutException if the activity does not complete within the specified timeout.

Specified by:

getResultAsync in interface UntypedActivityHandle

Parameters:

timeout - maximum time to wait

unit - unit of timeout

resultClass - the class to deserialize the result into

getResultAsync

public <R> CompletableFuture<R> getResultAsync(long timeout,
 TimeUnit unit,
 Class<R> resultClass,
 @Nullable
 Type resultType)

Description copied from interface: UntypedActivityHandle

Returns a future for generic return types with a timeout.

Specified by:

getResultAsync in interface UntypedActivityHandle

Parameters:

timeout - maximum time to wait

unit - unit of timeout

resultClass - the class to deserialize the result into

resultType - the generic type to use for deserialization; may be null

describe

public ActivityExecutionDescription describe()

Description copied from interface: UntypedActivityHandle

Describes the current state of the activity execution.

Specified by:

describe in interface UntypedActivityHandle

Returns:

detailed information about the activity

cancel

public void cancel()

Description copied from interface: UntypedActivityHandle

Requests cancellation of the activity. The activity will receive a cancellation via ActivityExecutionContext.heartbeat(Object).

Specified by:

cancel in interface UntypedActivityHandle

cancel

public void cancel(@Nullable
 String reason)

Description copied from interface: UntypedActivityHandle

Requests cancellation of the activity with an optional reason.

Specified by:

cancel in interface UntypedActivityHandle

Parameters:

reason - human-readable reason for cancellation, may be null

terminate

public void terminate()

Description copied from interface: UntypedActivityHandle

Terminates the activity immediately, regardless of its current state.

Specified by:

terminate in interface UntypedActivityHandle

terminate

public void terminate(@Nullable
 String reason)

Description copied from interface: UntypedActivityHandle

Terminates the activity immediately with a reason.

Specified by:

terminate in interface UntypedActivityHandle

Parameters:

reason - human-readable reason for termination, may be null