Class SyncWorkflowWorker

java.lang.Object

io.temporal.internal.worker.SyncWorkflowWorker

All Implemented Interfaces:

Shutdownable, Startable, Suspendable, SuspendableWorker, WorkerWithLifecycle

public class SyncWorkflowWorker
extends Object
implements SuspendableWorker

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.

Constructor Summary

Constructors

Constructor

Description

SyncWorkflowWorker(WorkflowClient client, String namespace, String taskQueue, SingleWorkerOptions singleWorkerOptions, SingleWorkerOptions localActivityOptions, WorkflowRunLockManager runLocks, WorkflowExecutorCache cache, String stickyTaskQueueName, WorkflowThreadExecutor workflowThreadExecutor, EagerActivityDispatcher eagerActivityDispatcher, SlotSupplier<WorkflowSlotInfo> slotSupplier, SlotSupplier<LocalActivitySlotInfo> laSlotSupplier, NamespaceCapabilities namespaceCapabilities)

Method Summary

Modifier and Type	Method	Description
void	awaitTermination(long timeout, TimeUnit unit)
WorkerLifecycleState	getLifecycleState()
TrackingSlotSupplier<LocalActivitySlotInfo>	getLocalActivitySlotSupplier()
TaskCounter	getLocalActivityTaskCounter()
PollerTracker	getStickyPollerTracker()
String	getStickyTaskQueueName()
PollerOptions	getWorkflowPollerOptions()
PollerTracker	getWorkflowPollerTracker()
TrackingSlotSupplier<WorkflowSlotInfo>	getWorkflowSlotSupplier()
TaskCounter	getWorkflowTaskCounter()
boolean	hasStickyQueue()
boolean	isAnyTypeSupported()
boolean	isShutdown()
boolean	isSuspended()
boolean	isTerminated()
<R> R	queryWorkflowExecution(WorkflowExecutionHistory history, String queryType, Class<R> resultClass, Type resultType, Object[] args)
void	registerLocalActivityImplementations(Object... activitiesImplementation)
<R> void	registerWorkflowImplementationFactory(WorkflowImplementationOptions options, Class<R> clazz, Functions.Func<R> factory)
<R> void	registerWorkflowImplementationFactory(WorkflowImplementationOptions options, Class<R> clazz, Functions.Func1<EncodedValues,R> factory)
void	registerWorkflowImplementationTypes(WorkflowImplementationOptions options, Class<?>[] workflowImplementationTypes)
WorkflowTaskDispatchHandle	reserveWorkflowExecutor()
void	resumePolling()	Allow new poll requests.
CompletableFuture<Void>	shutdown(ShutdownManager shutdownManager, boolean interruptTasks)
boolean	start()	This method is not required to be idempotent.
void	suspendPolling()	Do not make new poll requests.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SyncWorkflowWorker

public SyncWorkflowWorker(@Nonnull
 WorkflowClient client,
 @Nonnull
 String namespace,
 @Nonnull
 String taskQueue,
 @Nonnull
 SingleWorkerOptions singleWorkerOptions,
 @Nonnull
 SingleWorkerOptions localActivityOptions,
 @Nonnull
 WorkflowRunLockManager runLocks,
 @Nonnull
 WorkflowExecutorCache cache,
 String stickyTaskQueueName,
 @Nonnull
 WorkflowThreadExecutor workflowThreadExecutor,
 @Nonnull
 EagerActivityDispatcher eagerActivityDispatcher,
 @Nonnull
 SlotSupplier<WorkflowSlotInfo> slotSupplier,
 @Nonnull
 SlotSupplier<LocalActivitySlotInfo> laSlotSupplier,
 @Nonnull
 NamespaceCapabilities namespaceCapabilities)

Method Details

registerWorkflowImplementationTypes

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

registerWorkflowImplementationFactory

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

registerWorkflowImplementationFactory

public <R> void registerWorkflowImplementationFactory(WorkflowImplementationOptions options,
 Class<R> clazz,
 Functions.Func1<EncodedValues,R> factory)

registerLocalActivityImplementations

public void registerLocalActivityImplementations(Object... activitiesImplementation)

start

public boolean start()

Description copied from interface: Startable

This method is not required to be idempotent. It is expected to be called only once.

Specified by:

start in interface Startable

Returns:

true if the start was successful, false if the worker configuration renders the start obsolete (like no types are registered)

shutdown

public CompletableFuture<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,
 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

queryWorkflowExecution

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

Throws:

Exception

isSuspended

public boolean isSuspended()

Specified by:

isSuspended in interface Suspendable

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface Shutdownable

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface Shutdownable

getLifecycleState

public WorkerLifecycleState getLifecycleState()

Specified by:

getLifecycleState in interface WorkerWithLifecycle

getWorkflowSlotSupplier

public TrackingSlotSupplier<WorkflowSlotInfo> getWorkflowSlotSupplier()

getLocalActivitySlotSupplier

public TrackingSlotSupplier<LocalActivitySlotInfo> getLocalActivitySlotSupplier()

hasStickyQueue

public boolean hasStickyQueue()

isAnyTypeSupported

public boolean isAnyTypeSupported()

getWorkflowTaskCounter

public TaskCounter getWorkflowTaskCounter()

getLocalActivityTaskCounter

public TaskCounter getLocalActivityTaskCounter()

getWorkflowPollerOptions

public PollerOptions getWorkflowPollerOptions()

getWorkflowPollerTracker

public PollerTracker getWorkflowPollerTracker()

getStickyPollerTracker

public PollerTracker getStickyPollerTracker()

getStickyTaskQueueName

public String getStickyTaskQueueName()

toString

public String toString()

Overrides:

toString in class Object

reserveWorkflowExecutor

@Nullable
public WorkflowTaskDispatchHandle reserveWorkflowExecutor()