Interface WorkflowOutboundCallsInterceptor

All Known Implementing Classes:

WorkflowOutboundCallsInterceptorBase

@Experimental
public interface WorkflowOutboundCallsInterceptor

Can be used to intercept calls from to workflow code into the Temporal APIs.

The calls to the interceptor are executed in the context of a workflow and must follow the same rules all the other workflow code follows.

Prefer extending WorkflowOutboundCallsInterceptorBase and overriding only the methods you need instead of implementing this interface directly. WorkflowOutboundCallsInterceptorBase provides correct default implementations to all the methods of this interface.

An instance may be created in WorkflowInboundCallsInterceptor.init(WorkflowOutboundCallsInterceptor) and set by passing it into init method of the next WorkflowInboundCallsInterceptor The implementation must forward all the calls to the outbound interceptor passed as a outboundCalls parameter to the init call.

See Also:

• for the definition of "next" WorkflowInboundCallsInterceptor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WorkflowOutboundCallsInterceptor.ActivityInput<R>
static final class	WorkflowOutboundCallsInterceptor.ActivityOutput<R>
static final class	WorkflowOutboundCallsInterceptor.CancelWorkflowInput
static final class	WorkflowOutboundCallsInterceptor.CancelWorkflowOutput
static final class	WorkflowOutboundCallsInterceptor.ChildWorkflowInput<R>
static final class	WorkflowOutboundCallsInterceptor.ChildWorkflowOutput<R>
static final class	WorkflowOutboundCallsInterceptor.ContinueAsNewInput
static final class	WorkflowOutboundCallsInterceptor.ExecuteNexusOperationInput<R>
static final class	WorkflowOutboundCallsInterceptor.ExecuteNexusOperationOutput<R>
static final class	WorkflowOutboundCallsInterceptor.LocalActivityInput<R>
static final class	WorkflowOutboundCallsInterceptor.LocalActivityOutput<R>
static final class	WorkflowOutboundCallsInterceptor.RegisterDynamicQueryHandlerInput
static final class	WorkflowOutboundCallsInterceptor.RegisterDynamicSignalHandlerInput
static final class	WorkflowOutboundCallsInterceptor.RegisterDynamicUpdateHandlerInput
static final class	WorkflowOutboundCallsInterceptor.RegisterQueryInput
static final class	WorkflowOutboundCallsInterceptor.RegisterSignalHandlersInput
static final class	WorkflowOutboundCallsInterceptor.RegisterUpdateHandlersInput
static final class	WorkflowOutboundCallsInterceptor.SignalExternalInput
static final class	WorkflowOutboundCallsInterceptor.SignalExternalOutput
static final class	WorkflowOutboundCallsInterceptor.SignalRegistrationRequest
static final class	WorkflowOutboundCallsInterceptor.UpdateRegistrationRequest

Method Summary

Modifier and Type	Method	Description
void	await(String reason, Supplier<Boolean> unblockCondition)
boolean	await(Duration timeout, String reason, Supplier<Boolean> unblockCondition)
WorkflowOutboundCallsInterceptor.CancelWorkflowOutput	cancelWorkflow(WorkflowOutboundCallsInterceptor.CancelWorkflowInput input)
void	continueAsNew(WorkflowOutboundCallsInterceptor.ContinueAsNewInput input)
long	currentTimeMillis()
<R> WorkflowOutboundCallsInterceptor.ActivityOutput<R>	executeActivity(WorkflowOutboundCallsInterceptor.ActivityInput<R> input)
<R> WorkflowOutboundCallsInterceptor.ChildWorkflowOutput<R>	executeChildWorkflow(WorkflowOutboundCallsInterceptor.ChildWorkflowInput<R> input)
<R> WorkflowOutboundCallsInterceptor.LocalActivityOutput<R>	executeLocalActivity(WorkflowOutboundCallsInterceptor.LocalActivityInput<R> input)
<R> WorkflowOutboundCallsInterceptor.ExecuteNexusOperationOutput<R>	executeNexusOperation(WorkflowOutboundCallsInterceptor.ExecuteNexusOperationInput<R> input)
com.uber.m3.tally.Scope	getMetricsScope()	Intercepts call to get the metric scope in a workflow.
int	getVersion(String changeId, int minSupported, int maxSupported)
<R> R	mutableSideEffect(String id, Class<R> resultClass, Type resultType, BiPredicate<R,R> updated, Functions.Func<R> func)
<R> R	mutableSideEffect(String id, Class<R> resultClass, Type resultType, BiPredicate<R,R> updated, Functions.Func<R> func, MutableSideEffectOptions options)
Object	newChildThread(Runnable runnable, boolean detached, String name)	Intercepts creation of a workflow child thread.
Random	newRandom()
Promise<Void>	newTimer(Duration duration)
Promise<Void>	newTimer(Duration duration, TimerOptions options)
UUID	randomUUID()
void	registerDynamicQueryHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicQueryHandlerInput input)
void	registerDynamicSignalHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicSignalHandlerInput handler)
void	registerDynamicUpdateHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicUpdateHandlerInput input)
void	registerQuery(WorkflowOutboundCallsInterceptor.RegisterQueryInput input)
void	registerSignalHandlers(WorkflowOutboundCallsInterceptor.RegisterSignalHandlersInput input)
void	registerUpdateHandlers(WorkflowOutboundCallsInterceptor.RegisterUpdateHandlersInput input)
<R> R	sideEffect(Class<R> resultClass, Type resultType, Functions.Func<R> func)
<R> R	sideEffect(Class<R> resultClass, Type resultType, Functions.Func<R> func, SideEffectOptions options)
WorkflowOutboundCallsInterceptor.SignalExternalOutput	signalExternalWorkflow(WorkflowOutboundCallsInterceptor.SignalExternalInput input)
void	sleep(Duration duration)
void	upsertMemo(Map<String,Object> memo)
void	upsertSearchAttributes(Map<String,?> searchAttributes)
void	upsertTypedSearchAttributes(SearchAttributeUpdate<?>... searchAttributeUpdates)

Method Details

executeActivity

<R>
WorkflowOutboundCallsInterceptor.ActivityOutput<R> executeActivity(WorkflowOutboundCallsInterceptor.ActivityInput<R> input)

executeLocalActivity

<R>
WorkflowOutboundCallsInterceptor.LocalActivityOutput<R> executeLocalActivity(WorkflowOutboundCallsInterceptor.LocalActivityInput<R> input)

executeChildWorkflow

<R>
WorkflowOutboundCallsInterceptor.ChildWorkflowOutput<R> executeChildWorkflow(WorkflowOutboundCallsInterceptor.ChildWorkflowInput<R> input)

executeNexusOperation

@Experimental
<R>
WorkflowOutboundCallsInterceptor.ExecuteNexusOperationOutput<R> executeNexusOperation(WorkflowOutboundCallsInterceptor.ExecuteNexusOperationInput<R> input)

newRandom

Random newRandom()

signalExternalWorkflow

WorkflowOutboundCallsInterceptor.SignalExternalOutput signalExternalWorkflow(WorkflowOutboundCallsInterceptor.SignalExternalInput input)

cancelWorkflow

WorkflowOutboundCallsInterceptor.CancelWorkflowOutput cancelWorkflow(WorkflowOutboundCallsInterceptor.CancelWorkflowInput input)

sleep

void sleep(Duration duration)

await

boolean await(Duration timeout,
 String reason,
 Supplier<Boolean> unblockCondition)

await

void await(String reason,
 Supplier<Boolean> unblockCondition)

newTimer

Promise<Void> newTimer(Duration duration)

newTimer

Promise<Void> newTimer(Duration duration,
 TimerOptions options)

sideEffect

<R> R sideEffect(Class<R> resultClass,
 Type resultType,
 Functions.Func<R> func)

sideEffect

<R> R sideEffect(Class<R> resultClass,
 Type resultType,
 Functions.Func<R> func,
 SideEffectOptions options)

mutableSideEffect

<R> R mutableSideEffect(String id,
 Class<R> resultClass,
 Type resultType,
 BiPredicate<R,R> updated,
 Functions.Func<R> func)

mutableSideEffect

<R> R mutableSideEffect(String id,
 Class<R> resultClass,
 Type resultType,
 BiPredicate<R,R> updated,
 Functions.Func<R> func,
 MutableSideEffectOptions options)

getVersion

int getVersion(String changeId,
 int minSupported,
 int maxSupported)

continueAsNew

void continueAsNew(WorkflowOutboundCallsInterceptor.ContinueAsNewInput input)

registerQuery

void registerQuery(WorkflowOutboundCallsInterceptor.RegisterQueryInput input)

registerSignalHandlers

void registerSignalHandlers(WorkflowOutboundCallsInterceptor.RegisterSignalHandlersInput input)

registerUpdateHandlers

void registerUpdateHandlers(WorkflowOutboundCallsInterceptor.RegisterUpdateHandlersInput input)

registerDynamicSignalHandler

void registerDynamicSignalHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicSignalHandlerInput handler)

registerDynamicQueryHandler

void registerDynamicQueryHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicQueryHandlerInput input)

registerDynamicUpdateHandler

void registerDynamicUpdateHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicUpdateHandlerInput input)

randomUUID

UUID randomUUID()

upsertSearchAttributes

void upsertSearchAttributes(Map<String,?> searchAttributes)

upsertTypedSearchAttributes

void upsertTypedSearchAttributes(SearchAttributeUpdate<?>... searchAttributeUpdates)

upsertMemo

void upsertMemo(Map<String,Object> memo)

getMetricsScope

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

Intercepts call to get the metric scope in a workflow.

newChildThread

Object newChildThread(Runnable runnable,
 boolean detached,
 String name)

Intercepts creation of a workflow child thread.

Please note, that "workflow child thread" and "child workflow" are different and independent concepts.

Parameters:

runnable - thread function to run

detached - if this thread is detached from the parent CancellationScope

name - name of the thread

Returns:

created WorkflowThread

currentTimeMillis

long currentTimeMillis()