Package io.temporal.common.interceptors

Interface WorkflowClientCallsInterceptor

All Known Implementing Classes:

RootWorkflowClientInvoker, WorkflowClientCallsInterceptorBase

public interface WorkflowClientCallsInterceptor

Intercepts calls to the WorkflowClient related to the lifecycle of a Workflow.

Prefer extending WorkflowClientCallsInterceptorBase and overriding only the methods you need instead of implementing this interface directly. WorkflowClientCallsInterceptorBase provides correct default implementations to all the methods of this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WorkflowClientCallsInterceptor.CancelInput
static class	WorkflowClientCallsInterceptor.CancelOutput
static class	WorkflowClientCallsInterceptor.DescribeWorkflowInput
static class	WorkflowClientCallsInterceptor.DescribeWorkflowOutput
static class	WorkflowClientCallsInterceptor.GetResultAsyncOutput<R>
static class	WorkflowClientCallsInterceptor.GetResultInput<R>
static class	WorkflowClientCallsInterceptor.GetResultOutput<R>
static class	WorkflowClientCallsInterceptor.PollWorkflowUpdateInput<R>
static class	WorkflowClientCallsInterceptor.PollWorkflowUpdateOutput<R>
static class	WorkflowClientCallsInterceptor.QueryInput<R>
static class	WorkflowClientCallsInterceptor.QueryOutput<R>
static class	WorkflowClientCallsInterceptor.StartUpdateInput<R>
static class	WorkflowClientCallsInterceptor.TerminateInput
static class	WorkflowClientCallsInterceptor.TerminateOutput
static class	WorkflowClientCallsInterceptor.WorkflowSignalInput
static class	WorkflowClientCallsInterceptor.WorkflowSignalOutput
static class	WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput
static class	WorkflowClientCallsInterceptor.WorkflowSignalWithStartOutput
static class	WorkflowClientCallsInterceptor.WorkflowStartInput
static class	WorkflowClientCallsInterceptor.WorkflowStartOutput
static class	WorkflowClientCallsInterceptor.WorkflowUpdateWithStartInput<R>
static class	WorkflowClientCallsInterceptor.WorkflowUpdateWithStartOutput<R>

Method Summary

Modifier and Type	Method	Description
WorkflowClientCallsInterceptor.CancelOutput	cancel(WorkflowClientCallsInterceptor.CancelInput input)
WorkflowClientCallsInterceptor.DescribeWorkflowOutput	describe(WorkflowClientCallsInterceptor.DescribeWorkflowInput input)
<R> WorkflowClientCallsInterceptor.GetResultOutput<R>	getResult(WorkflowClientCallsInterceptor.GetResultInput<R> input)	If you implement this method, getResultAsync(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>) most likely needs to be implemented too.
<R> WorkflowClientCallsInterceptor.GetResultAsyncOutput<R>	getResultAsync(WorkflowClientCallsInterceptor.GetResultInput<R> input)	If you implement this method, getResult(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>) most likely needs to be implemented too.
<R> WorkflowClientCallsInterceptor.PollWorkflowUpdateOutput<R>	pollWorkflowUpdate(WorkflowClientCallsInterceptor.PollWorkflowUpdateInput<R> input)
<R> WorkflowClientCallsInterceptor.QueryOutput<R>	query(WorkflowClientCallsInterceptor.QueryInput<R> input)
WorkflowClientCallsInterceptor.WorkflowSignalOutput	signal(WorkflowClientCallsInterceptor.WorkflowSignalInput input)	If you implement this method, signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput) most likely needs to be implemented too.
WorkflowClientCallsInterceptor.WorkflowSignalWithStartOutput	signalWithStart(WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput input)
WorkflowClientCallsInterceptor.WorkflowStartOutput	start(WorkflowClientCallsInterceptor.WorkflowStartInput input)	If you implement this method, signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput) and @{link #updateWithStart} most likely need to be implemented too.
<R> WorkflowUpdateHandle<R>	startUpdate(WorkflowClientCallsInterceptor.StartUpdateInput<R> input)
WorkflowClientCallsInterceptor.TerminateOutput	terminate(WorkflowClientCallsInterceptor.TerminateInput input)
<R> WorkflowClientCallsInterceptor.WorkflowUpdateWithStartOutput<R>	updateWithStart(WorkflowClientCallsInterceptor.WorkflowUpdateWithStartInput<R> input)	Intercepts calls from WorkflowStub.startUpdateWithStart(io.temporal.client.UpdateOptions<R>, java.lang.Object[], java.lang.Object[]) and WorkflowStub.executeUpdateWithStart(io.temporal.client.UpdateOptions<R>, java.lang.Object[], java.lang.Object[]) as well as WorkflowClient.startUpdateWithStart(io.temporal.workflow.Functions.Proc, io.temporal.client.UpdateOptions<R>, io.temporal.client.WithStartWorkflowOperation<?>) and WorkflowClient.executeUpdateWithStart(io.temporal.workflow.Functions.Proc, io.temporal.client.UpdateOptions<R>, io.temporal.client.WithStartWorkflowOperation<?>).

Method Detail

start

WorkflowClientCallsInterceptor.WorkflowStartOutput start(WorkflowClientCallsInterceptor.WorkflowStartInput input)

If you implement this method, signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput) and @{link #updateWithStart} most likely need to be implemented too.

See Also:

signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput)

signal

WorkflowClientCallsInterceptor.WorkflowSignalOutput signal(WorkflowClientCallsInterceptor.WorkflowSignalInput input)

If you implement this method, signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput) most likely needs to be implemented too.

See Also:

signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput)

signalWithStart

WorkflowClientCallsInterceptor.WorkflowSignalWithStartOutput signalWithStart(WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput input)

updateWithStart

<R> WorkflowClientCallsInterceptor.WorkflowUpdateWithStartOutput<R> updateWithStart(WorkflowClientCallsInterceptor.WorkflowUpdateWithStartInput<R> input)

Intercepts calls from WorkflowStub.startUpdateWithStart(io.temporal.client.UpdateOptions<R>, java.lang.Object[], java.lang.Object[]) and WorkflowStub.executeUpdateWithStart(io.temporal.client.UpdateOptions<R>, java.lang.Object[], java.lang.Object[]) as well as WorkflowClient.startUpdateWithStart(io.temporal.workflow.Functions.Proc, io.temporal.client.UpdateOptions<R>, io.temporal.client.WithStartWorkflowOperation<?>) and WorkflowClient.executeUpdateWithStart(io.temporal.workflow.Functions.Proc, io.temporal.client.UpdateOptions<R>, io.temporal.client.WithStartWorkflowOperation<?>).

getResult

<R> WorkflowClientCallsInterceptor.GetResultOutput<R> getResult(WorkflowClientCallsInterceptor.GetResultInput<R> input)
                                                         throws java.util.concurrent.TimeoutException

If you implement this method, getResultAsync(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>) most likely needs to be implemented too.

Throws:

java.util.concurrent.TimeoutException

See Also:

getResultAsync(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>)

getResultAsync

<R> WorkflowClientCallsInterceptor.GetResultAsyncOutput<R> getResultAsync(WorkflowClientCallsInterceptor.GetResultInput<R> input)

If you implement this method, getResult(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>) most likely needs to be implemented too.

See Also:

getResult(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>)

query

<R> WorkflowClientCallsInterceptor.QueryOutput<R> query(WorkflowClientCallsInterceptor.QueryInput<R> input)

startUpdate

<R> WorkflowUpdateHandle<R> startUpdate(WorkflowClientCallsInterceptor.StartUpdateInput<R> input)

pollWorkflowUpdate

<R> WorkflowClientCallsInterceptor.PollWorkflowUpdateOutput<R> pollWorkflowUpdate(WorkflowClientCallsInterceptor.PollWorkflowUpdateInput<R> input)

cancel

WorkflowClientCallsInterceptor.CancelOutput cancel(WorkflowClientCallsInterceptor.CancelInput input)

terminate

WorkflowClientCallsInterceptor.TerminateOutput terminate(WorkflowClientCallsInterceptor.TerminateInput input)

describe

WorkflowClientCallsInterceptor.DescribeWorkflowOutput describe(WorkflowClientCallsInterceptor.DescribeWorkflowInput input)