io.temporal.common.interceptors

Interface WorkflowOutboundCallsInterceptor

All Known Implementing Classes:

WorkflowOutboundCallsInterceptorBase

public interface WorkflowOutboundCallsInterceptor

Can be used to intercept workflow code calls to the Temporal APIs. An instance should be created through WorkerInterceptor.interceptWorkflow(WorkflowInboundCallsInterceptor). An interceptor instance must forward all the calls to the next interceptor passed to the interceptExecuteWorkflow call.

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.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
boolean	await(java.time.Duration timeout, java.lang.String reason, java.util.function.Supplier<java.lang.Boolean> unblockCondition)
void	await(java.lang.String reason, java.util.function.Supplier<java.lang.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)
int	getVersion(java.lang.String changeId, int minSupported, int maxSupported)
<R> R	mutableSideEffect(java.lang.String id, java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, java.util.function.BiPredicate<R,R> updated, Functions.Func<R> func)
java.lang.Object	newChildThread(java.lang.Runnable runnable, boolean detached, java.lang.String name) Intercepts creation of the workflow child thread.
java.util.Random	newRandom()
Promise<java.lang.Void>	newTimer(java.time.Duration duration)
java.util.UUID	randomUUID()
void	registerDynamicQueryHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicQueryHandlerInput input)
void	registerDynamicSignalHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicSignalHandlerInput handler)
void	registerQuery(WorkflowOutboundCallsInterceptor.RegisterQueryInput input)
void	registerSignalHandlers(WorkflowOutboundCallsInterceptor.RegisterSignalHandlersInput input)
<R> R	sideEffect(java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, Functions.Func<R> func)
WorkflowOutboundCallsInterceptor.SignalExternalOutput	signalExternalWorkflow(WorkflowOutboundCallsInterceptor.SignalExternalInput input)
void	sleep(java.time.Duration duration)
void	upsertSearchAttributes(java.util.Map<java.lang.String,java.lang.Object> searchAttributes)

Method Detail

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)

newRandom

java.util.Random newRandom()

signalExternalWorkflow

WorkflowOutboundCallsInterceptor.SignalExternalOutput signalExternalWorkflow(WorkflowOutboundCallsInterceptor.SignalExternalInput input)

cancelWorkflow

WorkflowOutboundCallsInterceptor.CancelWorkflowOutput cancelWorkflow(WorkflowOutboundCallsInterceptor.CancelWorkflowInput input)

sleep

void sleep(java.time.Duration duration)

await

boolean await(java.time.Duration timeout,
              java.lang.String reason,
              java.util.function.Supplier<java.lang.Boolean> unblockCondition)

await

void await(java.lang.String reason,
           java.util.function.Supplier<java.lang.Boolean> unblockCondition)

newTimer

Promise<java.lang.Void> newTimer(java.time.Duration duration)

sideEffect

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

mutableSideEffect

<R> R mutableSideEffect(java.lang.String id,
                        java.lang.Class<R> resultClass,
                        java.lang.reflect.Type resultType,
                        java.util.function.BiPredicate<R,R> updated,
                        Functions.Func<R> func)

getVersion

int getVersion(java.lang.String changeId,
               int minSupported,
               int maxSupported)

continueAsNew

void continueAsNew(WorkflowOutboundCallsInterceptor.ContinueAsNewInput input)

registerQuery

void registerQuery(WorkflowOutboundCallsInterceptor.RegisterQueryInput input)

registerSignalHandlers

void registerSignalHandlers(WorkflowOutboundCallsInterceptor.RegisterSignalHandlersInput input)

registerDynamicSignalHandler

void registerDynamicSignalHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicSignalHandlerInput handler)

registerDynamicQueryHandler

void registerDynamicQueryHandler(WorkflowOutboundCallsInterceptor.RegisterDynamicQueryHandlerInput input)

randomUUID

java.util.UUID randomUUID()

upsertSearchAttributes

void upsertSearchAttributes(java.util.Map<java.lang.String,java.lang.Object> searchAttributes)

newChildThread

java.lang.Object newChildThread(java.lang.Runnable runnable,
                                boolean detached,
                                java.lang.String name)

Intercepts creation of the 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()