Package net.officefloor.frame.api.executive

Interface Executive

All Known Implementing Classes:

DefaultExecutive, GoogleAppEngineExecutive, WebThreadAffinityExecutive

public interface Executive

Executive.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.Executor	createExecutor(ProcessIdentifier processIdentifier)	Creates an Executor that MUST execute the Runnable in a different Thread to the caller.
default ProcessIdentifier	createProcessIdentifier(ExecutiveOfficeContext officeContext)	Creates a new ProcessIdentifier.
default java.lang.Thread	createThread(java.lang.String threadName, java.lang.ThreadGroup threadGroup, java.lang.Runnable runnable)	Creates a Thread.
ExecutionStrategy[]	getExcutionStrategies()	Obtains the ExecutionStrategy strategies.
default OfficeManager	getOfficeManager(ProcessIdentifier processIdentifier, OfficeManager defaultOfficeManager)	Obtains the OfficeManager for the ProcessState.
default TeamOversight	getTeamOversight()	Obtains the TeamOversight.
default <T extends java.lang.Throwable> ProcessManager	manageExecution(Execution<T> execution)	Manages the Execution.
default void	processComplete(ProcessIdentifier processIdentifier)	Invokes to notify the ProcessState identified by the ProcessIdentifier is complete.
void	schedule(ProcessIdentifier processIdentifier, long delay, java.lang.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.

Method Detail

createThread

default java.lang.Thread createThread(java.lang.String threadName,
                                      java.lang.ThreadGroup threadGroup,
                                      java.lang.Runnable runnable)

Creates a Thread.

Returns:

New Thread.

getExcutionStrategies

ExecutionStrategy[] getExcutionStrategies()

Obtains the ExecutionStrategy strategies.

Returns:

ExecutionStrategy instances.

getTeamOversight

default TeamOversight getTeamOversight()

Obtains the TeamOversight.

Returns:

TeamOversight.

startManaging

void startManaging(ExecutiveStartContext context)
            throws java.lang.Exception

Starts managing the OfficeFloor.

Parameters:

context - ExecutiveStartContext.

Throws:

java.lang.Exception - If fails to start managing.

manageExecution

default <T extends java.lang.Throwable> ProcessManager manageExecution(Execution<T> execution)
                                                                throws T extends java.lang.Throwable

Manages the Execution.

The Thread.currentThread() will provide the inbound Thread.

Type Parameters:

T - Type of Throwable thrown.

Parameters:

execution - Execution to be undertaken.

Returns:

ProcessManager for the ProcessState.

Throws:

T - Propagation of failure from Execution.

T extends java.lang.Throwable

createProcessIdentifier

default ProcessIdentifier createProcessIdentifier(ExecutiveOfficeContext officeContext)

Creates a new ProcessIdentifier.

Parameters:

officeContext - ExecutiveOfficeContext.

Returns:

New ProcessIdentifier.

getOfficeManager

default OfficeManager getOfficeManager(ProcessIdentifier processIdentifier,
                                       OfficeManager defaultOfficeManager)

Obtains the OfficeManager for the ProcessState.

Parameters:

processIdentifier - ProcessIdentifier created by this Executive for the ProcessState.

defaultOfficeManager - Default OfficeManager.

Returns:

OfficeManager for the ProcessState.

createExecutor

java.util.concurrent.Executor createExecutor(ProcessIdentifier processIdentifier)

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.

Parameters:

processIdentifier - ProcessIdentifier of ProcessState requiring the Executor.

Returns:

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

schedule

void schedule(ProcessIdentifier processIdentifier,
              long delay,
              java.lang.Runnable runnable)

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.

Parameters:

processIdentifier - ProcessIdentifier of the ProcessState requiring the scheduled execution.

delay - Delay in milliseconds to execute the Runnable.

runnable - Runnable to execute.

processComplete

default void processComplete(ProcessIdentifier processIdentifier)

Invokes to notify the ProcessState identified by the ProcessIdentifier is complete.

Parameters:

processIdentifier - ProcessIdentifier of the complete ProcessState.

stopManaging

void stopManaging()
           throws java.lang.Exception

Stops managing the OfficeFloor.

Throws:

java.lang.Exception - If fails to stop managing.