com.ebay.bascomtask.config

Class DefaultBascomConfig

java.lang.Object

com.ebay.bascomtask.config.DefaultBascomConfig

All Implemented Interfaces:

IBascomConfig

public class DefaultBascomConfig
extends Object
implements IBascomConfig

Constructor Summary

Constructors

Constructor and Description
DefaultBascomConfig()

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	constructThreadId(TaskThreadStat threadStat, String id, String name, int max)
long	getDefaultOrchestratorTimeoutMs() 30-second default timeout.
ITaskClosureGenerator	getExecutionHook(Orchestrator orc, String pass) Returns a generator for use within an orchestration execution scope -- i.e.
ExecutorService	getExecutor() The pool from which threads are drawn as needed for parallel execution.
int	getThreadNameWidthMax() Indicates the width max for thread names such that when exceeded a '..' string will be provided in place of any more predecessors.
void	notifyTerminate() Called on shutdown (when it is possible to do so, typically in a stand-alone program only).
void	notifyThreadEnd(TaskThreadStat threadStat) Called after a thread is has finished executing a task and there are no other tasks ready to execute.
void	notifyThreadStart(TaskThreadStat threadStat) Sets the thread name.
protected void	setThreadName(TaskThreadStat threadStat) Sets the name of given thread like so:
static void	shutdownAndAwaitTermination(ExecutorService pool) Standard way to shutdown an executor as defined in ExecutorService shutdown, used by this class and also made public here for convenience.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBascomConfig

public DefaultBascomConfig()

Method Detail

getExecutor

public ExecutorService getExecutor()

Description copied from interface: IBascomConfig

The pool from which threads are drawn as needed for parallel execution.

Specified by:

getExecutor in interface IBascomConfig

Returns:

service

getDefaultOrchestratorTimeoutMs

public long getDefaultOrchestratorTimeoutMs()

30-second default timeout.

Specified by:

getDefaultOrchestratorTimeoutMs in interface IBascomConfig

Returns:

the default timeout in milliseconds

See Also:

for system default value

notifyTerminate

public void notifyTerminate()

Description copied from interface: IBascomConfig

Called on shutdown (when it is possible to do so, typically in a stand-alone program only).

Specified by:

notifyTerminate in interface IBascomConfig

shutdownAndAwaitTermination

public static void shutdownAndAwaitTermination(ExecutorService pool)

Standard way to shutdown an executor as defined in ExecutorService shutdown, used by this class and also made public here for convenience.

Parameters:

pool - to shutdown

getThreadNameWidthMax

public int getThreadNameWidthMax()

Indicates the width max for thread names such that when exceeded a '..' string will be provided in place of any more predecessors. This is not an absolute width since the thread id and name is always included as well as the thread local index. It just prevents arbitrarily long thread names for very heavily nested thread spawn chains.

Returns:

the string width indicating when to stop including thread predecessors

notifyThreadStart

public void notifyThreadStart(TaskThreadStat threadStat)

Sets the thread name.

Specified by:

notifyThreadStart in interface IBascomConfig

Parameters:

threadStat - of the thread which is being started

See Also:

setThreadName(TaskThreadStat)

setThreadName

protected void setThreadName(TaskThreadStat threadStat)

Sets the name of given thread like so:

BT:ID:NAME#..11.12.13.14

Where:

• "BT:" is a standard prefix
• ID is the orchestrator id
• The orchestrator NAME is only included if not null
• The last value (14 above) is the local thread index in the orchestrator
• Any values preceding the last are the threads which spawned it
• A '..' indicates there are more predecessors which are not included

Parameters:

threadStat - of the thread which is being started

constructThreadId

protected static String constructThreadId(TaskThreadStat threadStat,
                       String id,
                       String name,
                       int max)

notifyThreadEnd

public void notifyThreadEnd(TaskThreadStat threadStat)

Description copied from interface: IBascomConfig

Called after a thread is has finished executing a task and there are no other tasks ready to execute. Provides an opportunity to clear any thread state.

Specified by:

notifyThreadEnd in interface IBascomConfig

Parameters:

threadStat - metadata for thread

getExecutionHook

public ITaskClosureGenerator getExecutionHook(Orchestrator orc,
                                     String pass)

Description copied from interface: IBascomConfig

Returns a generator for use within an orchestration execution scope -- i.e. called once for each top-level invocation of Orchestrator.execute(long, String). Subclasses can provide their own version instead of the default which generates TaskMethodClosure instances directly. The returned value can be a singleton or created for each call if the subclass needs to keep its own state.

Specified by:

getExecutionHook in interface IBascomConfig

Parameters:

orc - on which the execution was invoked

pass - provided as param to Orchestrator.execute(long, String)

Returns:

generator