com.ebay.bascomtask.core

Class GlobalOrchestratorConfig.Config

java.lang.Object

com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config

Enclosing class:

GlobalOrchestratorConfig

public abstract static class GlobalOrchestratorConfig.Config
extends Object

Default implementation maintains values that are transferred to an Orchestrator on demand.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutorService	executorService
protected List<TaskRunner>	first
protected List<BiConsumer<Orchestrator,Object>>	initializers
protected List<TaskRunner>	last
protected SpawnMode	spawnMode
protected long	timeoutMs
protected TimeoutStrategy	timeoutStrategy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Config()

Method Summary

Modifier and Type	Method and Description
abstract void	afterDefaultInitialization(Orchestrator orchestrator, Object arg) Subclasses can override to provide custom logic for updateConfigurationOn(Orchestrator, Object).
void	firstInterceptWith(TaskRunner runner) Adds a TaskRunner that will be processed before any existing TaskRunner.
ExecutorService	getExecutorService()
int	getNumberOfInterceptors() Returns the current number of interceptors, as set by CommonConfig.firstInterceptWith(TaskRunner), CommonConfig.lastInterceptWith(TaskRunner), or for Orchestrators as set from current global settings.
SpawnMode	getSpawnMode() Gets the most recently set mode.
long	getTimeoutMs() Gets the current timeout.
TimeoutStrategy	getTimeoutStrategy() Gets the current timeout strategy, default is TimeoutStrategy.PREVENT_NEW.
void	initializeWith(BiConsumer<Orchestrator,Object> fn)
void	lastInterceptWith(TaskRunner runner) Adds a TaskRunner that will be processed after any existing TaskRunner.
void	removeAllTaskRunners() Removes all interceptors from the current list.
void	removeInterceptor(TaskRunner taskRunner) Removes the given TaskRunner from the current list, if it is there.
void	restoreConfigurationDefaults(Object arg) Restore default settings.
void	restoreDefaultExecutorService()
void	setExecutorService(ExecutorService executorService) Resets the service used by this framework for spawning threads.
void	setSpawnMode(SpawnMode mode) Changes the thread-spawning logic to be consistent with the specified mode.
void	setTimeoutMs(long ms) Sets the current timeout.
void	setTimeoutStrategy(TimeoutStrategy strategy) Sets the strategy to apply if a timeout greater than zero is in effect and is exceeded.
void	updateConfigurationOn(Orchestrator orchestrator, Object arg) Transfers configuration settings to the supplied orchestrator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ebay.bascomtask.core.CommonConfig

setTimeout

Field Detail

executorService

protected ExecutorService executorService

first

protected final List<TaskRunner> first

last

protected final List<TaskRunner> last

spawnMode

protected SpawnMode spawnMode

timeoutMs

protected long timeoutMs

timeoutStrategy

protected TimeoutStrategy timeoutStrategy

initializers

protected final List<BiConsumer<Orchestrator,Object>> initializers

Constructor Detail

Config

protected Config()

Method Detail

updateConfigurationOn

public final void updateConfigurationOn(Orchestrator orchestrator,
                                        Object arg)

Transfers configuration settings to the supplied orchestrator.

Parameters:

orchestrator - to update

arg - passed from user code, see afterDefaultInitialization(Orchestrator, Object)

afterDefaultInitialization

public abstract void afterDefaultInitialization(Orchestrator orchestrator,
                                                Object arg)

Subclasses can override to provide custom logic for updateConfigurationOn(Orchestrator, Object). The arg parameter is what is passed to Orchestrator.create(String, Object), without modification. It is intended to allow for this method to know to apply different settings for different orchestrators, if desired.

Parameters:

orchestrator - to update

arg - passed from user code

restoreConfigurationDefaults

public final void restoreConfigurationDefaults(Object arg)

Description copied from interface: CommonConfig

Restore default settings. Applied on GlobalOrchestratorConfig, sets default values. Applied on Orchestrator, sets values from current GlobalOrchestratorConfig.

getSpawnMode

public SpawnMode getSpawnMode()

Description copied from interface: CommonConfig

Gets the most recently set mode. The global default is SpawnMode.WHEN_NEEDED. The Orchestrator default is null, which results in using the global setting.

Returns:

most recently-set mode (possibly null) or default if none set

setSpawnMode

public void setSpawnMode(SpawnMode mode)

Description copied from interface: CommonConfig

Changes the thread-spawning logic to be consistent with the specified mode. If not set at a more specific level (Orchestrator), the globally-set value is used.

Parameters:

mode - to set

getTimeoutMs

public long getTimeoutMs()

Description copied from interface: CommonConfig

Gets the current timeout. The default is zero, meaning no timeout is in effect.

Returns:

current timeout

setTimeoutMs

public void setTimeoutMs(long ms)

Description copied from interface: CommonConfig

Sets the current timeout. When set to a value greater than zero, the behavior defined by the current CommonConfig.getTimeoutStrategy() will apply.

Parameters:

ms - duration in milliseconds, zero means no timeout will be applied

getTimeoutStrategy

public TimeoutStrategy getTimeoutStrategy()

Description copied from interface: CommonConfig

Gets the current timeout strategy, default is TimeoutStrategy.PREVENT_NEW.

Returns:

default or strategy last set by CommonConfig.setTimeoutStrategy(TimeoutStrategy)

setTimeoutStrategy

public void setTimeoutStrategy(TimeoutStrategy strategy)

Description copied from interface: CommonConfig

Sets the strategy to apply if a timeout greater than zero is in effect and is exceeded.

Parameters:

strategy - to set

getExecutorService

public ExecutorService getExecutorService()

setExecutorService

public void setExecutorService(ExecutorService executorService)

Description copied from interface: CommonConfig

Resets the service used by this framework for spawning threads. Global default is Executors.newFixedThreadPool(GlobalOrchestratorConfig.DEFAULT_FIXED_THREADPOOL_SIZE.

Parameters:

executorService - to set as new default

restoreDefaultExecutorService

public void restoreDefaultExecutorService()

firstInterceptWith

public void firstInterceptWith(TaskRunner runner)

Description copied from interface: CommonConfig

Adds a TaskRunner that will be processed before any existing TaskRunner.

Parameters:

runner - to add

lastInterceptWith

public void lastInterceptWith(TaskRunner runner)

Description copied from interface: CommonConfig

Adds a TaskRunner that will be processed after any existing TaskRunner.

Parameters:

runner - to add

getNumberOfInterceptors

public int getNumberOfInterceptors()

Description copied from interface: CommonConfig

Returns the current number of interceptors, as set by CommonConfig.firstInterceptWith(TaskRunner), CommonConfig.lastInterceptWith(TaskRunner), or for Orchestrators as set from current global settings.

Returns:

interceptor count

removeInterceptor

public void removeInterceptor(TaskRunner taskRunner)

Description copied from interface: CommonConfig

Removes the given TaskRunner from the current list, if it is there. It will exit silently if not there.

Parameters:

taskRunner - to remove

removeAllTaskRunners

public void removeAllTaskRunners()

Description copied from interface: CommonConfig

Removes all interceptors from the current list.

initializeWith

public void initializeWith(BiConsumer<Orchestrator,Object> fn)