com.ebay.bascomtask.config

Interface IBascomConfig

All Known Implementing Classes:

DefaultBascomConfig

public interface IBascomConfig

BascomTask configuration. A standard DefaultBascomConfig implementation is provided, which may be overridden and then set to replaced whatever config is currently in place.

Author:

brendanmccarthy

See Also:

BascomConfigFactory.setConfig(IBascomConfig)

Method Summary

Methods

Modifier and Type	Method and Description
long	getDefaultOrchestratorTimeoutMs() Returns the default value for orchestrator timeout (when Orchestrator.execute() is called).
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.
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) Called after a thread is pulled from the pool and before it starts executing any task.

Method Detail

getExecutor

ExecutorService getExecutor()

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

Returns:

service

getDefaultOrchestratorTimeoutMs

long getDefaultOrchestratorTimeoutMs()

Returns the default value for orchestrator timeout (when Orchestrator.execute() is called). Has no effect when Orchestrator.execute(long) is called, as that method provides an explicit override of the default.

Returns:

the default timeout in milliseconds

See Also:

for system default value

notifyTerminate

void notifyTerminate()

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

notifyThreadStart

void notifyThreadStart(TaskThreadStat threadStat)

Called after a thread is pulled from the pool and before it starts executing any task. Provides an opportunity to set the thread name, or any other related function.

Parameters:

threadStat - metadata for thread

notifyThreadEnd

void notifyThreadEnd(TaskThreadStat threadStat)

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.

Parameters:

threadStat - metadata for thread

getExecutionHook

ITaskClosureGenerator getExecutionHook(Orchestrator orc,
                                     String pass)

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.

Parameters:

orc - on which the execution was invoked

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

Returns:

generator