Class WorkflowInboundCallsInterceptorBase

java.lang.Object

io.temporal.common.interceptors.WorkflowInboundCallsInterceptorBase

All Implemented Interfaces:

WorkflowInboundCallsInterceptor

public class WorkflowInboundCallsInterceptorBase
extends Object
implements WorkflowInboundCallsInterceptor

Convenience base class for WorkflowInboundCallsInterceptor implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.temporal.common.interceptors.WorkflowInboundCallsInterceptor

WorkflowInboundCallsInterceptor.QueryInput, WorkflowInboundCallsInterceptor.QueryOutput, WorkflowInboundCallsInterceptor.SignalInput, WorkflowInboundCallsInterceptor.UpdateInput, WorkflowInboundCallsInterceptor.UpdateOutput, WorkflowInboundCallsInterceptor.WorkflowInput, WorkflowInboundCallsInterceptor.WorkflowOutput

Constructor Summary

Constructors

Constructor	Description
WorkflowInboundCallsInterceptorBase(WorkflowInboundCallsInterceptor next)

Method Summary

Modifier and Type	Method	Description
WorkflowInboundCallsInterceptor.WorkflowOutput	execute(WorkflowInboundCallsInterceptor.WorkflowInput input)	Called when workflow main method is called.
WorkflowInboundCallsInterceptor.UpdateOutput	executeUpdate(WorkflowInboundCallsInterceptor.UpdateInput input)	Called when update workflow execution request is delivered to a workflow execution, after passing the validator.
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.
Object	newCallbackThread(Runnable runnable, String name)	Intercepts creation of a workflow callback thread
Object	newWorkflowMethodThread(Runnable runnable, String name)	Intercepts creation of the workflow main method thread
void	validateUpdate(WorkflowInboundCallsInterceptor.UpdateInput input)	Called when update workflow execution request is delivered to a workflow execution, before the update is executed.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkflowInboundCallsInterceptorBase

public WorkflowInboundCallsInterceptorBase(WorkflowInboundCallsInterceptor next)

Method Details

init

public void init(WorkflowOutboundCallsInterceptor outboundCalls)

Description copied from interface: WorkflowInboundCallsInterceptor

Called when workflow class is instantiated. May create a WorkflowOutboundCallsInterceptor instance. The instance must forward all the calls to outboundCalls, but it may change the input parameters.

The instance should be passed into the {next.init(newWorkflowOutboundCallsInterceptor)}.

See WorkerInterceptor.interceptWorkflow(io.temporal.common.interceptors.WorkflowInboundCallsInterceptor) for the definition of "next" WorkflowInboundCallsInterceptor.

Specified by:

init in interface WorkflowInboundCallsInterceptor

Parameters:

outboundCalls - an existing interceptor instance to be proxied by the interceptor created inside this method

execute

public WorkflowInboundCallsInterceptor.WorkflowOutput execute(WorkflowInboundCallsInterceptor.WorkflowInput input)

Description copied from interface: WorkflowInboundCallsInterceptor

Called when workflow main method is called.

Specified by:

execute in interface WorkflowInboundCallsInterceptor

Returns:

result of the workflow execution.

handleSignal

public void handleSignal(WorkflowInboundCallsInterceptor.SignalInput input)

Description copied from interface: WorkflowInboundCallsInterceptor

Called when signal is delivered to a workflow execution.

Specified by:

handleSignal in interface WorkflowInboundCallsInterceptor

handleQuery

public WorkflowInboundCallsInterceptor.QueryOutput handleQuery(WorkflowInboundCallsInterceptor.QueryInput input)

Description copied from interface: WorkflowInboundCallsInterceptor

Called when a workflow is queried.

Specified by:

handleQuery in interface WorkflowInboundCallsInterceptor

validateUpdate

public void validateUpdate(WorkflowInboundCallsInterceptor.UpdateInput input)

Description copied from interface: WorkflowInboundCallsInterceptor

Called when update workflow execution request is delivered to a workflow execution, before the update is executed.

Specified by:

validateUpdate in interface WorkflowInboundCallsInterceptor

executeUpdate

public WorkflowInboundCallsInterceptor.UpdateOutput executeUpdate(WorkflowInboundCallsInterceptor.UpdateInput input)

Description copied from interface: WorkflowInboundCallsInterceptor

Called when update workflow execution request is delivered to a workflow execution, after passing the validator.

Specified by:

executeUpdate in interface WorkflowInboundCallsInterceptor

newWorkflowMethodThread

@Nonnull
public Object newWorkflowMethodThread(Runnable runnable,
 String name)

Description copied from interface: WorkflowInboundCallsInterceptor

Intercepts creation of the workflow main method thread

Specified by:

newWorkflowMethodThread in interface WorkflowInboundCallsInterceptor

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

@Nonnull
public Object newCallbackThread(Runnable runnable,
 String name)

Description copied from interface: WorkflowInboundCallsInterceptor

Intercepts creation of a workflow callback thread

Specified by:

newCallbackThread in interface WorkflowInboundCallsInterceptor

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.