io.temporal.common.interceptors

Interface WorkflowCallsInterceptor

All Known Implementing Classes:

WorkflowCallsInterceptorBase

public interface WorkflowCallsInterceptor

Can be used to intercept workflow code calls to Temporal APIs. An instance should be created through WorkflowInterceptor.interceptExecuteWorkflow(WorkflowCallsInterceptor, WorkflowInvocationInterceptor). 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	WorkflowCallsInterceptor.WorkflowResult<R>

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)
Promise<java.lang.Void>	cancelWorkflow(io.temporal.proto.execution.WorkflowExecution execution)
void	continueAsNew(java.util.Optional<java.lang.String> workflowType, java.util.Optional<ContinueAsNewOptions> options, java.lang.Object[] args)
<R> Promise<R>	executeActivity(java.lang.String activityName, java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, java.lang.Object[] args, ActivityOptions options)
<R> WorkflowCallsInterceptor.WorkflowResult<R>	executeChildWorkflow(java.lang.String workflowType, java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, java.lang.Object[] args, ChildWorkflowOptions options)
<R> Promise<R>	executeLocalActivity(java.lang.String activityName, java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, java.lang.Object[] args, LocalActivityOptions options)
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.util.Random	newRandom()
Promise<java.lang.Void>	newTimer(java.time.Duration duration)
java.util.UUID	randomUUID()
void	registerQuery(java.lang.String queryType, java.lang.reflect.Type[] argTypes, Functions.Func1<java.lang.Object[],java.lang.Object> callback)
void	registerSignal(java.lang.String signalType, java.lang.reflect.Type[] argTypes, Functions.Proc1<java.lang.Object[]> callback)
<R> R	sideEffect(java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, Functions.Func<R> func)
Promise<java.lang.Void>	signalExternalWorkflow(io.temporal.proto.execution.WorkflowExecution execution, java.lang.String signalName, java.lang.Object[] args)
void	sleep(java.time.Duration duration)
void	upsertSearchAttributes(java.util.Map<java.lang.String,java.lang.Object> searchAttributes)

Method Detail

executeActivity

<R> Promise<R> executeActivity(java.lang.String activityName,
                               java.lang.Class<R> resultClass,
                               java.lang.reflect.Type resultType,
                               java.lang.Object[] args,
                               ActivityOptions options)

executeLocalActivity

<R> Promise<R> executeLocalActivity(java.lang.String activityName,
                                    java.lang.Class<R> resultClass,
                                    java.lang.reflect.Type resultType,
                                    java.lang.Object[] args,
                                    LocalActivityOptions options)

executeChildWorkflow

<R> WorkflowCallsInterceptor.WorkflowResult<R> executeChildWorkflow(java.lang.String workflowType,
                                                                    java.lang.Class<R> resultClass,
                                                                    java.lang.reflect.Type resultType,
                                                                    java.lang.Object[] args,
                                                                    ChildWorkflowOptions options)

newRandom

java.util.Random newRandom()

signalExternalWorkflow

Promise<java.lang.Void> signalExternalWorkflow(io.temporal.proto.execution.WorkflowExecution execution,
                                               java.lang.String signalName,
                                               java.lang.Object[] args)

cancelWorkflow

Promise<java.lang.Void> cancelWorkflow(io.temporal.proto.execution.WorkflowExecution execution)

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(java.util.Optional<java.lang.String> workflowType,
                   java.util.Optional<ContinueAsNewOptions> options,
                   java.lang.Object[] args)

registerQuery

void registerQuery(java.lang.String queryType,
                   java.lang.reflect.Type[] argTypes,
                   Functions.Func1<java.lang.Object[],java.lang.Object> callback)

registerSignal

void registerSignal(java.lang.String signalType,
                    java.lang.reflect.Type[] argTypes,
                    Functions.Proc1<java.lang.Object[]> callback)

randomUUID

java.util.UUID randomUUID()

upsertSearchAttributes

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