com.amazonaws.services.simpleworkflow.flow.spring

Class SpringActivityWorker

java.lang.Object

com.amazonaws.services.simpleworkflow.flow.spring.SpringActivityWorker

All Implemented Interfaces:

Suspendable, SuspendableWorker, WorkerBase, WorkerLifecycle, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class SpringActivityWorker
extends Object
implements WorkerBase, org.springframework.context.SmartLifecycle

Field Summary

Fields

Modifier and Type	Field and Description
protected long	terminationTimeoutSeconds

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
SpringActivityWorker()
SpringActivityWorker(GenericActivityWorker genericWorker)
SpringActivityWorker(software.amazon.awssdk.services.swf.SwfClient service, String domain, String taskListToPoll)
SpringActivityWorker(software.amazon.awssdk.services.swf.SwfClient service, String domain, String taskListToPoll, SimpleWorkflowClientConfig config)

Method Summary

Modifier and Type	Method and Description
List<ActivityType>	addActivitiesImplementation(Object activitiesImplementation)
boolean	awaitTermination(long timeout, TimeUnit unit)
Iterable<Object>	getActivitiesImplementations()
SimpleWorkflowClientConfig	getClientConfig()
DataConverter	getDataConverter()
String	getDomain()
long	getDomainRetentionPeriodInDays()
int	getExecuteThreadCount()
String	getIdentity()
int	getMaximumPollRateIntervalMilliseconds()
double	getMaximumPollRatePerSecond()
MetricsRegistry	getMetricsRegistry()
int	getPhase()
double	getPollBackoffCoefficient()
long	getPollBackoffInitialInterval()
long	getPollBackoffMaximumInterval()
int	getPollThreadCount()
software.amazon.awssdk.services.swf.SwfClient	getService()
String	getTaskListToPoll() Task list name that given worker polls for tasks.
long	getTerminationTimeoutSeconds()
Thread.UncaughtExceptionHandler	getUncaughtExceptionHandler()
boolean	gracefulShutdown(long timeout, TimeUnit unit)
boolean	isAllowCoreThreadTimeOut()
boolean	isAutoStartup()
boolean	isDisableAutoStartup()
boolean	isDisableServiceShutdownOnStop()
boolean	isDisableTypeRegistrationOnStart()
boolean	isPollingSuspended() Check suspension status
boolean	isRegisterDomain()
boolean	isRunning()
void	registerTypesToPoll() Try to register every type (activity or workflow depending on worker) that are configured with the worker.
void	resumePolling() Alias to setPollingSuspended(false)
void	setActivitiesImplementations(Iterable<Object> activitiesImplementations)
void	setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut) When set to true allows the task execution threads to terminate if they have been idle for 1 minute.
void	setDataConverter(DataConverter dataConverter)
void	setDisableAutoStartup(boolean disableAutoStartup)
void	setDisableServiceShutdownOnStop(boolean disableServiceShutdownOnStop) When set to false (which is default) at the beginning of the worker shutdown SdkAutoCloseable.close() is called.
void	setDisableTypeRegistrationOnStart(boolean disableTypeRegistrationOnStart) When set to true disables types registration on start even if SkipTypeRegistration is not specified.
void	setDomain(String domain)
void	setDomainRetentionPeriodInDays(long domainRetentionPeriodInDays) Value of DomainRetentionPeriodInDays parameter passed to SwfClient.registerDomain(software.amazon.awssdk.services.swf.model.RegisterDomainRequest) call.
void	setExecuteThreadCount(int threadCount) Defines how many concurrent threads are used by the given worker to poll the specified task list.
void	setIdentity(String identity) Set the identity that worker specifies in the poll requests.
void	setMaximumPollRateIntervalMilliseconds(int maximumPollRateIntervalMilliseconds) The sliding window interval used to measure the poll rate.
void	setMaximumPollRatePerSecond(double maximumPollRatePerSecond) Maximum number of poll request to the task list per second allowed.
void	setMetricsRegistry(MetricsRegistry factory)
void	setPhase(int startPhase)
void	setPollBackoffCoefficient(double backoffCoefficient)
void	setPollBackoffInitialInterval(long backoffInitialInterval) Failed poll requests are retried after an interval defined by an exponential backoff algorithm.
void	setPollBackoffMaximumInterval(long backoffMaximumInterval)
void	setPollingSuspended(boolean flag) If set to true stop making any poll requests.
void	setPollThreadCount(int threadCount) Defines how many concurrent threads are used by the given worker to poll the specified task list.
void	setRegisterDomain(boolean registerDomain) Should domain be registered on startup.
void	setService(software.amazon.awssdk.services.swf.SwfClient service)
void	setTaskListToPoll(String taskListToPoll)
void	setTerminationTimeoutSeconds(long terminationTimeoutSeconds)
void	setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler) Handler notified about poll request and other unexpected failures.
void	shutdown()
void	shutdownAndAwaitTermination()
boolean	shutdownAndAwaitTermination(long timeout, TimeUnit unit)
void	shutdownNow()
void	start()
void	stop()
void	stop(Runnable callback)
void	stopNow()
void	suspendPolling() Alias to setPollingSuspended(true)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

terminationTimeoutSeconds

protected long terminationTimeoutSeconds

Constructor Detail

SpringActivityWorker

public SpringActivityWorker()

SpringActivityWorker

public SpringActivityWorker(software.amazon.awssdk.services.swf.SwfClient service,
                            String domain,
                            String taskListToPoll)

SpringActivityWorker

public SpringActivityWorker(software.amazon.awssdk.services.swf.SwfClient service,
                            String domain,
                            String taskListToPoll,
                            SimpleWorkflowClientConfig config)

SpringActivityWorker

public SpringActivityWorker(GenericActivityWorker genericWorker)

Method Detail

getClientConfig

public SimpleWorkflowClientConfig getClientConfig()

Specified by:

getClientConfig in interface WorkerBase

getService

public software.amazon.awssdk.services.swf.SwfClient getService()

Specified by:

getService in interface WorkerBase

setService

public void setService(software.amazon.awssdk.services.swf.SwfClient service)

getDomain

public String getDomain()

Specified by:

getDomain in interface WorkerBase

setDomain

public void setDomain(String domain)

isRegisterDomain

public boolean isRegisterDomain()

Specified by:

isRegisterDomain in interface WorkerBase

setRegisterDomain

public void setRegisterDomain(boolean registerDomain)

Description copied from interface: WorkerBase

Should domain be registered on startup. Default is false. When enabled WorkerBase.setDomainRetentionPeriodInDays(long) property is required.

Specified by:

setRegisterDomain in interface WorkerBase

Parameters:

registerDomain - true if domain should be registered

getDomainRetentionPeriodInDays

public long getDomainRetentionPeriodInDays()

Specified by:

getDomainRetentionPeriodInDays in interface WorkerBase

setDomainRetentionPeriodInDays

public void setDomainRetentionPeriodInDays(long domainRetentionPeriodInDays)

Description copied from interface: WorkerBase

Value of DomainRetentionPeriodInDays parameter passed to SwfClient.registerDomain(software.amazon.awssdk.services.swf.model.RegisterDomainRequest) call. Required when WorkerBase.isRegisterDomain() is true.

Specified by:

setDomainRetentionPeriodInDays in interface WorkerBase

Parameters:

domainRetentionPeriodInDays - Days to retain domain history

getTaskListToPoll

public String getTaskListToPoll()

Description copied from interface: WorkerBase

Task list name that given worker polls for tasks.

Specified by:

getTaskListToPoll in interface WorkerBase

Returns:

Name of task list to poll

setTaskListToPoll

public void setTaskListToPoll(String taskListToPoll)

getDataConverter

public DataConverter getDataConverter()

setDataConverter

public void setDataConverter(DataConverter dataConverter)

getMaximumPollRatePerSecond

public double getMaximumPollRatePerSecond()

Specified by:

getMaximumPollRatePerSecond in interface WorkerBase

setMaximumPollRatePerSecond

public void setMaximumPollRatePerSecond(double maximumPollRatePerSecond)

Description copied from interface: WorkerBase

Maximum number of poll request to the task list per second allowed. Default is 0 which means unlimited.

Specified by:

setMaximumPollRatePerSecond in interface WorkerBase

Parameters:

maximumPollRatePerSecond - - Maximum polls allowed per second

See Also:

WorkerBase.setMaximumPollRateIntervalMilliseconds(int)

getMaximumPollRateIntervalMilliseconds

public int getMaximumPollRateIntervalMilliseconds()

Specified by:

getMaximumPollRateIntervalMilliseconds in interface WorkerBase

setMaximumPollRateIntervalMilliseconds

public void setMaximumPollRateIntervalMilliseconds(int maximumPollRateIntervalMilliseconds)

Description copied from interface: WorkerBase

The sliding window interval used to measure the poll rate. Controls allowed rate burstiness. For example if allowed rate is 10 per second and poll rate interval is 100 milliseconds the poller is not going to allow more then one poll per 100 milliseconds. If poll rate interval is 10 seconds then 100 request can be emitted as fast as possible, but then the polling stops until 10 seconds pass.

Specified by:

setMaximumPollRateIntervalMilliseconds in interface WorkerBase

Parameters:

maximumPollRateIntervalMilliseconds - - interval in milliseconds for rate limiting

See Also:

WorkerBase.setMaximumPollRatePerSecond(double)

getIdentity

public String getIdentity()

Specified by:

getIdentity in interface WorkerBase

setIdentity

public void setIdentity(String identity)

Description copied from interface: WorkerBase

Set the identity that worker specifies in the poll requests. This value ends up stored in the identity field of the corresponding Start history event. Default is "pid"@"host".

Specified by:

setIdentity in interface WorkerBase

Parameters:

identity - maximum size is 256 characters.

getUncaughtExceptionHandler

public Thread.UncaughtExceptionHandler getUncaughtExceptionHandler()

Specified by:

getUncaughtExceptionHandler in interface WorkerBase

setUncaughtExceptionHandler

public void setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Description copied from interface: WorkerBase

Handler notified about poll request and other unexpected failures. The default implementation logs the failures using ERROR level.

Specified by:

setUncaughtExceptionHandler in interface WorkerBase

Parameters:

uncaughtExceptionHandler - - handler for processing uncaught exceptions

getPollBackoffInitialInterval

public long getPollBackoffInitialInterval()

Specified by:

getPollBackoffInitialInterval in interface WorkerBase

setPollBackoffInitialInterval

public void setPollBackoffInitialInterval(long backoffInitialInterval)

Description copied from interface: WorkerBase

Failed poll requests are retried after an interval defined by an exponential backoff algorithm. See BackoffThrottler for more info.

Specified by:

setPollBackoffInitialInterval in interface WorkerBase

Parameters:

backoffInitialInterval - the interval between failure and the first retry. Default is 100.

getPollBackoffMaximumInterval

public long getPollBackoffMaximumInterval()

Specified by:

getPollBackoffMaximumInterval in interface WorkerBase

setPollBackoffMaximumInterval

public void setPollBackoffMaximumInterval(long backoffMaximumInterval)

Specified by:

setPollBackoffMaximumInterval in interface WorkerBase

Parameters:

backoffMaximumInterval - maximum interval between poll request retries. Default is 60000 (one minute).

See Also:

WorkerBase.setPollBackoffInitialInterval(long)

getPollBackoffCoefficient

public double getPollBackoffCoefficient()

Specified by:

getPollBackoffCoefficient in interface WorkerBase

setPollBackoffCoefficient

public void setPollBackoffCoefficient(double backoffCoefficient)

Specified by:

setPollBackoffCoefficient in interface WorkerBase

Parameters:

backoffCoefficient - coefficient that defines how fast retry interval grows in case of poll request failures. Default is 2.0.

See Also:

WorkerBase.setPollBackoffInitialInterval(long)

getPollThreadCount

public int getPollThreadCount()

Specified by:

getPollThreadCount in interface WorkerBase

setPollThreadCount

public void setPollThreadCount(int threadCount)

Description copied from interface: WorkerBase

Defines how many concurrent threads are used by the given worker to poll the specified task list. Default is 1. The size of the task execution thread pool is defined through WorkerBase.setExecuteThreadCount(int).

Specified by:

setPollThreadCount in interface WorkerBase

Parameters:

threadCount - - number of concurrent polling threads

getExecuteThreadCount

public int getExecuteThreadCount()

Specified by:

getExecuteThreadCount in interface WorkerBase

setExecuteThreadCount

public void setExecuteThreadCount(int threadCount)

Description copied from interface: WorkerBase

Defines how many concurrent threads are used by the given worker to poll the specified task list. Default is 100. This will be the actual number of threads which execute tasks which are polled from the specified task list by Poll threads

Specified by:

setExecuteThreadCount in interface WorkerBase

Parameters:

threadCount - - number of task execution threads

isDisableServiceShutdownOnStop

public boolean isDisableServiceShutdownOnStop()

Specified by:

isDisableServiceShutdownOnStop in interface WorkerBase

setDisableServiceShutdownOnStop

public void setDisableServiceShutdownOnStop(boolean disableServiceShutdownOnStop)

Description copied from interface: WorkerBase

When set to false (which is default) at the beginning of the worker shutdown SdkAutoCloseable.close() is called. It causes all outstanding long poll request to disconnect. But also causes all future request (for example activity completions) to SWF fail.

Specified by:

setDisableServiceShutdownOnStop in interface WorkerBase

Parameters:

disableServiceShutdownOnStop - - flag to control service shutdown

isAllowCoreThreadTimeOut

public boolean isAllowCoreThreadTimeOut()

Specified by:

isAllowCoreThreadTimeOut in interface WorkerBase

getMetricsRegistry

public MetricsRegistry getMetricsRegistry()

Specified by:

getMetricsRegistry in interface WorkerBase

setMetricsRegistry

public void setMetricsRegistry(MetricsRegistry factory)

Specified by:

setMetricsRegistry in interface WorkerBase

setAllowCoreThreadTimeOut

public void setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)

Description copied from interface: WorkerBase

When set to true allows the task execution threads to terminate if they have been idle for 1 minute.

Specified by:

setAllowCoreThreadTimeOut in interface WorkerBase

Parameters:

allowCoreThreadTimeOut - - flag to enable thread timeout

suspendPolling

public void suspendPolling()

Description copied from interface: Suspendable

Alias to setPollingSuspended(true)

Specified by:

suspendPolling in interface Suspendable

resumePolling

public void resumePolling()

Description copied from interface: Suspendable

Alias to setPollingSuspended(false)

Specified by:

resumePolling in interface Suspendable

isPollingSuspended

public boolean isPollingSuspended()

Description copied from interface: Suspendable

Check suspension status

Specified by:

isPollingSuspended in interface Suspendable

Returns:

true if polling is suspended

setPollingSuspended

public void setPollingSuspended(boolean flag)

Description copied from interface: Suspendable

If set to true stop making any poll requests. Outstanding long polls still can return tasks after this method was called. Setting to false enables polling.

Specified by:

setPollingSuspended in interface Suspendable

Parameters:

flag - - boolean to control polling state

start

public void start()

Specified by:

start in interface WorkerLifecycle

Specified by:

start in interface org.springframework.context.Lifecycle

stopNow

public void stopNow()

shutdown

public void shutdown()

Specified by:

shutdown in interface WorkerLifecycle

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface WorkerLifecycle

shutdownAndAwaitTermination

public boolean shutdownAndAwaitTermination(long timeout,
                                           TimeUnit unit)
                                    throws InterruptedException

Specified by:

shutdownAndAwaitTermination in interface WorkerLifecycle

Throws:

InterruptedException

shutdownAndAwaitTermination

public void shutdownAndAwaitTermination()
                                 throws InterruptedException

Throws:

InterruptedException

awaitTermination

public boolean awaitTermination(long timeout,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface WorkerLifecycle

Throws:

InterruptedException

gracefulShutdown

public boolean gracefulShutdown(long timeout,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

gracefulShutdown in interface WorkerLifecycle

Throws:

InterruptedException

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface WorkerBase

Specified by:

isRunning in interface org.springframework.context.Lifecycle

setActivitiesImplementations

public void setActivitiesImplementations(Iterable<Object> activitiesImplementations)
                                  throws InstantiationException,
                                         IllegalAccessException,
                                         SecurityException,
                                         NoSuchMethodException

Throws:

InstantiationException

IllegalAccessException

SecurityException

NoSuchMethodException

getActivitiesImplementations

public Iterable<Object> getActivitiesImplementations()

addActivitiesImplementation

public List<ActivityType> addActivitiesImplementation(Object activitiesImplementation)
                                               throws InstantiationException,
                                                      IllegalAccessException,
                                                      SecurityException,
                                                      NoSuchMethodException

Throws:

InstantiationException

IllegalAccessException

SecurityException

NoSuchMethodException

registerTypesToPoll

public void registerTypesToPoll()

Description copied from interface: WorkerBase

Try to register every type (activity or workflow depending on worker) that are configured with the worker.

Specified by:

registerTypesToPoll in interface WorkerBase

See Also:

WorkerBase.setDisableTypeRegistrationOnStart(boolean)

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

Returns:

default is 0

setPhase

public void setPhase(int startPhase)

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

getTerminationTimeoutSeconds

public long getTerminationTimeoutSeconds()

setTerminationTimeoutSeconds

public void setTerminationTimeoutSeconds(long terminationTimeoutSeconds)

isDisableAutoStartup

public boolean isDisableAutoStartup()

setDisableAutoStartup

public void setDisableAutoStartup(boolean disableAutoStartup)

setDisableTypeRegistrationOnStart

public void setDisableTypeRegistrationOnStart(boolean disableTypeRegistrationOnStart)

Description copied from interface: WorkerBase

When set to true disables types registration on start even if SkipTypeRegistration is not specified. Types still can be registered by calling WorkerBase.registerTypesToPoll().

Specified by:

setDisableTypeRegistrationOnStart in interface WorkerBase

Parameters:

disableTypeRegistrationOnStart - - flag to disable type registration

isDisableTypeRegistrationOnStart

public boolean isDisableTypeRegistrationOnStart()

Specified by:

isDisableTypeRegistrationOnStart in interface WorkerBase

stop

public void stop(Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

toString

public String toString()

Overrides:

toString in class Object