Package io.temporal.common.interceptors

Interface WorkflowClientInterceptor

All Known Implementing Classes:

WorkflowClientInterceptorBase

public interface WorkflowClientInterceptor

Method Summary

Modifier and Type	Method	Description
ActivityCompletionClient	newActivityCompletionClient(ActivityCompletionClient next)
WorkflowStub	newUntypedWorkflowStub(io.temporal.api.common.v1.WorkflowExecution execution, java.util.Optional<java.lang.String> workflowType, WorkflowStub next)	Deprecated. consider implementing all intercepting functionality using WorkflowClientCallsInterceptor that is produced in workflowClientCallsInterceptor(io.temporal.common.interceptors.WorkflowClientCallsInterceptor).
WorkflowStub	newUntypedWorkflowStub(java.lang.String workflowType, WorkflowOptions options, WorkflowStub next)	Deprecated. consider implementing all intercepting functionality using WorkflowClientCallsInterceptor that is produced in workflowClientCallsInterceptor(io.temporal.common.interceptors.WorkflowClientCallsInterceptor).
WorkflowClientCallsInterceptor	workflowClientCallsInterceptor(WorkflowClientCallsInterceptor next)	Called once during creation of WorkflowClient to create a chain of Client Workflow Interceptors

Method Detail

newUntypedWorkflowStub

@Deprecated
WorkflowStub newUntypedWorkflowStub(java.lang.String workflowType,
                                    WorkflowOptions options,
                                    WorkflowStub next)

Deprecated.

consider implementing all intercepting functionality using WorkflowClientCallsInterceptor that is produced in workflowClientCallsInterceptor(io.temporal.common.interceptors.WorkflowClientCallsInterceptor). This method has to stay temporary because TimeLockingInterceptor has to intercept top level WorkflowStub methods.

Called when workflow stub is instantiated during creation of new workflow. It allows to decorate calls to WorkflowStub instance which is an entry point for client code.

Returns:

decorated stub

newUntypedWorkflowStub

@Deprecated
WorkflowStub newUntypedWorkflowStub(io.temporal.api.common.v1.WorkflowExecution execution,
                                    java.util.Optional<java.lang.String> workflowType,
                                    WorkflowStub next)

Deprecated.

consider implementing all intercepting functionality using WorkflowClientCallsInterceptor that is produced in workflowClientCallsInterceptor(io.temporal.common.interceptors.WorkflowClientCallsInterceptor). This method has to stay temporary because TimeLockingInterceptor has to intercept top level WorkflowStub methods.

Called when workflow stub is instantiated for a known existing workflow execution. It allows to decorate calls to WorkflowStub instance which is an entry point for client code.

Returns:

decorated stub

newActivityCompletionClient

ActivityCompletionClient newActivityCompletionClient(ActivityCompletionClient next)

workflowClientCallsInterceptor

WorkflowClientCallsInterceptor workflowClientCallsInterceptor(WorkflowClientCallsInterceptor next)

Called once during creation of WorkflowClient to create a chain of Client Workflow Interceptors

Parameters:

next - next workflow client interceptor in the chain of interceptors

Returns:

new interceptor that should decorate calls to next