Package net.officefloor.frame.impl.execute.executive

Class DefaultExecutive

java.lang.Object

net.officefloor.frame.api.executive.source.impl.AbstractExecutiveSource

net.officefloor.frame.impl.execute.executive.DefaultExecutive

All Implemented Interfaces:

BackgroundScheduler, ExecutionStrategy, Executive, ExecutiveSource

public class DefaultExecutive
extends AbstractExecutiveSource
implements Executive, ExecutionStrategy, BackgroundScheduler

Default Executive.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.frame.api.executive.source.impl.AbstractExecutiveSource

AbstractExecutiveSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXECUTION_STRATEGY_NAME	Default ExecutionStrategy name.

Constructor Summary

Constructors

Constructor	Description
DefaultExecutive()	Default construct to be used as ExecutiveSource.
DefaultExecutive(ThreadFactoryManufacturer threadFactoryManufacturer)	Instantiate to use as Executive.

Method Summary

Modifier and Type	Method	Description
Executive	createExecutive(ExecutiveSourceContext context)	Creates the Executive.
Executor	createExecutor(ProcessIdentifier processIdentifier)	Creates an Executor that MUST execute the Runnable in a different Thread to the caller.
ExecutionStrategy[]	getExcutionStrategies()	Obtains the ExecutionStrategy strategies.
Map<String,ThreadFactory[]>	getExecutionStrategyMap()	Obtains the ExecutionStrategy instances by name.
String	getExecutionStrategyName()	Obtains the name of the ExecutionStrategy.
ThreadFactory[]	getThreadFactories()	Obtains the ThreadFactory instances for the various Thread instances of this ExecutionStrategy.
protected void	loadSpecification(AbstractExecutiveSource.SpecificationContext context)	Overridden to load specification.
void	schedule(long delay, Runnable runnable)	Schedules the Runnable to be executed after the delay.
void	schedule(ProcessIdentifier processIdentifier, long delay, Runnable runnable)	Schedules the Runnable to execute so many milliseconds in the future.
void	startManaging(ExecutiveStartContext context)	Starts managing the OfficeFloor.
void	stopManaging()	Stops managing the OfficeFloor.

Methods inherited from class net.officefloor.frame.api.executive.source.impl.AbstractExecutiveSource

getSpecification

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.api.executive.Executive

createProcessIdentifier, createThread, getOfficeManager, getTeamOversight, manageExecution, processComplete

Field Details

EXECUTION_STRATEGY_NAME

public static final String EXECUTION_STRATEGY_NAME

Default ExecutionStrategy name.

See Also:

• Constant Field Values

Constructor Details

DefaultExecutive

public DefaultExecutive()

Default construct to be used as ExecutiveSource.

DefaultExecutive

public DefaultExecutive(ThreadFactoryManufacturer threadFactoryManufacturer)

Instantiate to use as Executive.

Parameters:

threadFactoryManufacturer - ThreadFactoryManufacturer.

Method Details

getExecutionStrategyMap

public Map<String,ThreadFactory[]> getExecutionStrategyMap()

Obtains the ExecutionStrategy instances by name.

Returns:

ExecutionStrategy instances by name.

loadSpecification

protected void loadSpecification(AbstractExecutiveSource.SpecificationContext context)

Description copied from class: AbstractExecutiveSource

Overridden to load specification.

Specified by:

loadSpecification in class AbstractExecutiveSource

Parameters:

context - AbstractExecutiveSource.SpecificationContext.

createExecutive

public Executive createExecutive(ExecutiveSourceContext context)
                          throws Exception

Description copied from interface: ExecutiveSource

Creates the Executive.

Specified by:

createExecutive in interface ExecutiveSource

Parameters:

context - ExecutiveSourceContext.

Returns:

Executive.

Throws:

Exception - If fails to configure the ExecutiveSource.

getExcutionStrategies

public ExecutionStrategy[] getExcutionStrategies()

Description copied from interface: Executive

Obtains the ExecutionStrategy strategies.

Specified by:

getExcutionStrategies in interface Executive

Returns:

ExecutionStrategy instances.

startManaging

public void startManaging(ExecutiveStartContext context)
                   throws Exception

Description copied from interface: Executive

Starts managing the OfficeFloor.

Specified by:

startManaging in interface Executive

Parameters:

context - ExecutiveStartContext.

Throws:

Exception - If fails to start managing.

createExecutor

public Executor createExecutor(ProcessIdentifier processIdentifier)

Description copied from interface: Executive

Creates an Executor that MUST execute the Runnable in a different Thread to the caller.

This is used in various places within OfficeFloor:

• By ManagedFunction in executing Runnable in another Thread
• To avoid stack over flow issues, the stack call chain is broken by invoking further FunctionState delegation in another Thread. This allows further depth to a thread stack than offered by a single Thread.

Specified by:

createExecutor in interface Executive

Parameters:

processIdentifier - ProcessIdentifier of ProcessState requiring the Executor.

Returns:

Executor that will execute Runnable instances in a different Thread to caller.

schedule

public void schedule(ProcessIdentifier processIdentifier,
 long delay,
 Runnable runnable)

Description copied from interface: Executive

Schedules the Runnable to execute so many milliseconds in the future.

Note that the Executive may determine the ProcessState complete and not execute the Runnable.

Specified by:

schedule in interface Executive

Parameters:

processIdentifier - ProcessIdentifier of the ProcessState requiring the scheduled execution.

delay - Delay in milliseconds to execute the Runnable.

runnable - Runnable to execute.

stopManaging

public void stopManaging()
                  throws Exception

Description copied from interface: Executive

Stops managing the OfficeFloor.

Specified by:

stopManaging in interface Executive

Throws:

Exception - If fails to stop managing.

schedule

public void schedule(long delay,
 Runnable runnable)

Description copied from interface: BackgroundScheduler

Schedules the Runnable to be executed after the delay.

Specified by:

schedule in interface BackgroundScheduler

Parameters:

delay - Delay in milliseconds.

runnable - Runnable.

getExecutionStrategyName

public String getExecutionStrategyName()

Description copied from interface: ExecutionStrategy

Obtains the name of the ExecutionStrategy.

Specified by:

getExecutionStrategyName in interface ExecutionStrategy

Returns:

Name of the ExecutionStrategy.

getThreadFactories

public ThreadFactory[] getThreadFactories()

Description copied from interface: ExecutionStrategy

Obtains the ThreadFactory instances for the various Thread instances of this ExecutionStrategy.

Specified by:

getThreadFactories in interface ExecutionStrategy

Returns:

ThreadFactory instances.