Package io.temporal.internal.sync

Class SyncWorkflowWorker

java.lang.Object

io.temporal.internal.sync.SyncWorkflowWorker

All Implemented Interfaces:

Lifecycle, Shutdownable, Startable, Suspendable, SuspendableWorker, Functions.Proc1<io.temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse>, Functions.TemporalFunctionalInterfaceMarker, java.io.Serializable

public class SyncWorkflowWorker
extends java.lang.Object
implements SuspendableWorker, Functions.Proc1<io.temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse>

Facade that supports a lifecycle and maintains an assembly of

• WorkflowWorker that performing execution of workflow task
• LocalActivityWorker that performs execution of local activities scheduled by the workflow tasks

and exposing additional management helper methods for the assembly.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

SyncWorkflowWorker(io.temporal.serviceclient.WorkflowServiceStubs service, java.lang.String namespace, java.lang.String taskQueue, WorkerInterceptor[] workerInterceptors, SingleWorkerOptions singleWorkerOptions, SingleWorkerOptions localActivityOptions, WorkflowExecutorCache cache, java.lang.String stickyTaskQueueName, java.time.Duration stickyWorkflowTaskScheduleToStartTimeout, java.util.concurrent.ThreadPoolExecutor workflowThreadPool)

Method Summary

Modifier and Type	Method	Description
<R> void	addWorkflowImplementationFactory(WorkflowImplementationOptions options, java.lang.Class<R> clazz, Functions.Func<R> factory)
<R> void	addWorkflowImplementationFactory(java.lang.Class<R> clazz, Functions.Func<R> factory)
void	apply(io.temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse pollWorkflowTaskQueueResponse)
void	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit)
boolean	isShutdown()
boolean	isStarted()
boolean	isSuspended()
boolean	isTerminated()
<R> R	queryWorkflowExecution(WorkflowExecutionHistory history, java.lang.String queryType, java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, java.lang.Object[] args)
void	registerLocalActivityImplementations(java.lang.Object... activitiesImplementation)
void	registerWorkflowImplementationTypes(WorkflowImplementationOptions options, java.lang.Class<?>[] workflowImplementationTypes)
void	resumePolling()	Allow new poll requests.
java.util.concurrent.CompletableFuture<java.lang.Void>	shutdown(ShutdownManager shutdownManager, boolean interruptTasks)
void	start()
void	suspendPolling()	Do not make new poll requests.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncWorkflowWorker

public SyncWorkflowWorker(io.temporal.serviceclient.WorkflowServiceStubs service,
                          java.lang.String namespace,
                          java.lang.String taskQueue,
                          WorkerInterceptor[] workerInterceptors,
                          SingleWorkerOptions singleWorkerOptions,
                          SingleWorkerOptions localActivityOptions,
                          WorkflowExecutorCache cache,
                          java.lang.String stickyTaskQueueName,
                          java.time.Duration stickyWorkflowTaskScheduleToStartTimeout,
                          java.util.concurrent.ThreadPoolExecutor workflowThreadPool)

Method Detail

registerWorkflowImplementationTypes

public void registerWorkflowImplementationTypes(WorkflowImplementationOptions options,
                                                java.lang.Class<?>[] workflowImplementationTypes)

addWorkflowImplementationFactory

public <R> void addWorkflowImplementationFactory(WorkflowImplementationOptions options,
                                                 java.lang.Class<R> clazz,
                                                 Functions.Func<R> factory)

addWorkflowImplementationFactory

public <R> void addWorkflowImplementationFactory(java.lang.Class<R> clazz,
                                                 Functions.Func<R> factory)

registerLocalActivityImplementations

public void registerLocalActivityImplementations(java.lang.Object... activitiesImplementation)

start

public void start()

Specified by:

start in interface Startable

isStarted

public boolean isStarted()

Specified by:

isStarted in interface Startable

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface Shutdownable

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface Shutdownable

shutdown

public java.util.concurrent.CompletableFuture<java.lang.Void> shutdown(ShutdownManager shutdownManager,
                                                                       boolean interruptTasks)

Specified by:

shutdown in interface Shutdownable

Parameters:

shutdownManager - provides toolset to get a Future for a shutdown of instances that have both non-blocking and not returning a Future on a completion shutdown methods (like ExecutorService.shutdown())

interruptTasks - if the threads processing user code (like workflows, workflow tasks or activities) should be interrupted, or we want to wait for their full graceful completion

Returns:

CompletableFuture which should be completed when awaiting downstream dependencies can proceed with their own shutdown. Should never be completed exceptionally CompletableFuture.exceptionally(Function) as downstream dependencies have no use of this information (they need to perform a shutdown anyway), and it complicates the shutdown flow.

awaitTermination

public void awaitTermination(long timeout,
                             java.util.concurrent.TimeUnit unit)

Specified by:

awaitTermination in interface Shutdownable

suspendPolling

public void suspendPolling()

Description copied from interface: Suspendable

Do not make new poll requests. Outstanding long polls still can return tasks after this method was called.

Specified by:

suspendPolling in interface Suspendable

resumePolling

public void resumePolling()

Description copied from interface: Suspendable

Allow new poll requests.

Specified by:

resumePolling in interface Suspendable

isSuspended

public boolean isSuspended()

Specified by:

isSuspended in interface Suspendable

queryWorkflowExecution

public <R> R queryWorkflowExecution(WorkflowExecutionHistory history,
                                    java.lang.String queryType,
                                    java.lang.Class<R> resultClass,
                                    java.lang.reflect.Type resultType,
                                    java.lang.Object[] args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

apply

public void apply(io.temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse pollWorkflowTaskQueueResponse)

Specified by:

apply in interface Functions.Proc1<io.temporal.api.workflowservice.v1.PollWorkflowTaskQueueResponse>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object