Package io.temporal.common.interceptors

Interface WorkflowInboundCallsInterceptor

All Known Implementing Classes:

BaseRootWorkflowInboundCallsInterceptor, WorkflowInboundCallsInterceptorBase

public interface WorkflowInboundCallsInterceptor

Intercepts calls to the workflow execution. Executes under workflow context. So all the restrictions on the workflow code should be obeyed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WorkflowInboundCallsInterceptor.QueryInput
static class	WorkflowInboundCallsInterceptor.QueryOutput
static class	WorkflowInboundCallsInterceptor.SignalInput
static class	WorkflowInboundCallsInterceptor.WorkflowInput
static class	WorkflowInboundCallsInterceptor.WorkflowOutput

Method Summary

Modifier and Type	Method	Description
WorkflowInboundCallsInterceptor.WorkflowOutput	execute(WorkflowInboundCallsInterceptor.WorkflowInput input)	Called when workflow main method is called.
WorkflowInboundCallsInterceptor.QueryOutput	handleQuery(WorkflowInboundCallsInterceptor.QueryInput input)	Called when a workflow is queried.
void	handleSignal(WorkflowInboundCallsInterceptor.SignalInput input)	Called when signal is delivered to a workflow execution.
void	init(WorkflowOutboundCallsInterceptor outboundCalls)	Called when workflow class is instantiated.
java.lang.Object	newCallbackThread(java.lang.Runnable runnable, java.lang.String name)	Intercepts creation of a workflow callback thread
java.lang.Object	newWorkflowMethodThread(java.lang.Runnable runnable, java.lang.String name)	Intercepts creation of the workflow main method thread

Method Detail

init

void init(WorkflowOutboundCallsInterceptor outboundCalls)

Called when workflow class is instantiated.

Parameters:

outboundCalls - interceptor for calls that workflow makes to the SDK

execute

WorkflowInboundCallsInterceptor.WorkflowOutput execute(WorkflowInboundCallsInterceptor.WorkflowInput input)

Called when workflow main method is called.

Returns:

result of the workflow execution.

handleSignal

void handleSignal(WorkflowInboundCallsInterceptor.SignalInput input)

Called when signal is delivered to a workflow execution.

handleQuery

WorkflowInboundCallsInterceptor.QueryOutput handleQuery(WorkflowInboundCallsInterceptor.QueryInput input)

Called when a workflow is queried.

newWorkflowMethodThread

java.lang.Object newWorkflowMethodThread(java.lang.Runnable runnable,
                                         @Nullable
                                         java.lang.String name)

Intercepts creation of the workflow main method thread

Parameters:

runnable - thread function to run

name - name of the thread, optional

Returns:

created workflow thread. Should be treated as a pass-through object that shouldn't be manipulated in any way by the interceptor code.

newCallbackThread

java.lang.Object newCallbackThread(java.lang.Runnable runnable,
                                   @Nullable
                                   java.lang.String name)

Intercepts creation of a workflow callback thread

Parameters:

runnable - thread function to run

name - name of the thread, optional

Returns:

created workflow thread. Should be treated as a pass-through object that shouldn't be manipulated in any way by the interceptor code.