com.ebay.bascomtask.core

Interface CommonConfig

All Known Subinterfaces:

Orchestrator

All Known Implementing Classes:

Engine

public interface CommonConfig

Configuration settings. GlobalOrchestratorConfig and Orchestrator both implement this class, allowing these values to be set at either level. On its creation, an Orchestrator's values are set from the current global settings.

Author:

Brendan McCarthy

Method Summary

Modifier and Type	Method and Description
void	firstInterceptWith(TaskRunner taskRunner) Adds a TaskRunner that will be processed before any existing TaskRunner.
ExecutorService	getExecutorService()
int	getNumberOfInterceptors() Returns the current number of interceptors, as set by firstInterceptWith(TaskRunner), 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	lastInterceptWith(TaskRunner taskRunner) 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.
default void	setTimeout(long duration, TimeUnit timeUnit) Calls setTimeoutMs(long) after calculating the millisecond duration from the supplied arguments.
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.

Method Detail

restoreConfigurationDefaults

void restoreConfigurationDefaults(Object arg)

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

getSpawnMode

SpawnMode getSpawnMode()

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

void setSpawnMode(SpawnMode mode)

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

long getTimeoutMs()

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

Returns:

current timeout

setTimeoutMs

void setTimeoutMs(long ms)

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

Parameters:

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

setTimeout

default void setTimeout(long duration,
                        TimeUnit timeUnit)

Calls setTimeoutMs(long) after calculating the millisecond duration from the supplied arguments.

Parameters:

duration - to timeout after

timeUnit - to apply

getTimeoutStrategy

TimeoutStrategy getTimeoutStrategy()

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

Returns:

default or strategy last set by setTimeoutStrategy(TimeoutStrategy)

setTimeoutStrategy

void setTimeoutStrategy(TimeoutStrategy strategy)

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

Parameters:

strategy - to set

getExecutorService

ExecutorService getExecutorService()

setExecutorService

void setExecutorService(ExecutorService executorService)

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

void restoreDefaultExecutorService()

firstInterceptWith

void firstInterceptWith(TaskRunner taskRunner)

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

Parameters:

taskRunner - to add

lastInterceptWith

void lastInterceptWith(TaskRunner taskRunner)

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

Parameters:

taskRunner - to add

getNumberOfInterceptors

int getNumberOfInterceptors()

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

Returns:

interceptor count

removeInterceptor

void removeInterceptor(TaskRunner taskRunner)

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

Parameters:

taskRunner - to remove

removeAllTaskRunners

void removeAllTaskRunners()

Removes all interceptors from the current list.