Package net.officefloor.server.appengine

Class GoogleAppEngineExecutive

java.lang.Object

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

net.officefloor.server.appengine.GoogleAppEngineExecutive

All Implemented Interfaces:

ExecutionStrategy, Executive, ExecutiveSource, TeamOversight

public class GoogleAppEngineExecutive
extends AbstractExecutiveSource
implements Executive, ExecutionStrategy, TeamOversight

Executive for Google AppEngine.

Author:

Daniel Sagenschneider

Nested Class Summary

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

AbstractExecutiveSource.SpecificationContext

Constructor Summary

Constructors

Constructor	Description
GoogleAppEngineExecutive()

Method Summary

Modifier and Type	Method	Description
Executive	createExecutive(ExecutiveSourceContext context)	Creates the Executive.
java.util.concurrent.Executor	createExecutor(ProcessIdentifier processIdentifier)	Creates an Executor that MUST execute the Runnable in a different Thread to the caller.
ProcessIdentifier	createProcessIdentifier(ExecutiveOfficeContext officeContext)	Creates a new ProcessIdentifier.
Team	createTeam(ExecutiveContext context)	Creates the Team.
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.
java.lang.String	getExecutionStrategyName()	Obtains the name of the ExecutionStrategy.
OfficeManager	getOfficeManager(ProcessIdentifier processIdentifier, OfficeManager defaultOfficeManager)	Obtains the OfficeManager for the ProcessState.
TeamOversight	getTeamOversight()	Obtains the TeamOversight.
java.util.concurrent.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	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.

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

manageExecution

Constructor Detail

GoogleAppEngineExecutive

public GoogleAppEngineExecutive()

Method Detail

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 java.lang.Exception

Description copied from interface: ExecutiveSource

Creates the Executive.

Specified by:

createExecutive in interface ExecutiveSource

Parameters:

context - ExecutiveSourceContext.

Returns:

Executive.

Throws:

java.lang.Exception - If fails to configure the ExecutiveSource.

createThread

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

Description copied from interface: Executive

Creates a Thread.

Specified by:

createThread in interface Executive

Returns:

New Thread.

getExcutionStrategies

public ExecutionStrategy[] getExcutionStrategies()

Description copied from interface: Executive

Obtains the ExecutionStrategy strategies.

Specified by:

getExcutionStrategies in interface Executive

Returns:

ExecutionStrategy instances.

getTeamOversight

public TeamOversight getTeamOversight()

Description copied from interface: Executive

Obtains the TeamOversight.

Specified by:

getTeamOversight in interface Executive

Returns:

TeamOversight.

startManaging

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

Description copied from interface: Executive

Starts managing the OfficeFloor.

Specified by:

startManaging in interface Executive

Parameters:

context - ExecutiveStartContext.

Throws:

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

createProcessIdentifier

public ProcessIdentifier createProcessIdentifier(ExecutiveOfficeContext officeContext)

Description copied from interface: Executive

Creates a new ProcessIdentifier.

Specified by:

createProcessIdentifier in interface Executive

Parameters:

officeContext - ExecutiveOfficeContext.

Returns:

New ProcessIdentifier.

getOfficeManager

public OfficeManager getOfficeManager(ProcessIdentifier processIdentifier,
                                      OfficeManager defaultOfficeManager)

Description copied from interface: Executive

Obtains the OfficeManager for the ProcessState.

Specified by:

getOfficeManager in interface Executive

Parameters:

processIdentifier - ProcessIdentifier created by this Executive for the ProcessState.

defaultOfficeManager - Default OfficeManager.

Returns:

OfficeManager for the ProcessState.

createExecutor

public java.util.concurrent.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,
                     java.lang.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.

processComplete

public void processComplete(ProcessIdentifier processIdentifier)

Description copied from interface: Executive

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

Specified by:

processComplete in interface Executive

Parameters:

processIdentifier - ProcessIdentifier of the complete ProcessState.

stopManaging

public void stopManaging()
                  throws java.lang.Exception

Description copied from interface: Executive

Stops managing the OfficeFloor.

Specified by:

stopManaging in interface Executive

Throws:

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

getExecutionStrategyName

public java.lang.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 java.util.concurrent.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.

createTeam

public Team createTeam(ExecutiveContext context)
                throws java.lang.Exception

Description copied from interface: TeamOversight

Creates the Team.

This is expected to delegate to the TeamSource to create the Team. However, the Executive may decide to wrap the Team or provide multiple Team instances with assigning algorithm (such as taking advantage of Thread affinity). The choice is, however, ultimately left to the Executive to manage the Team instances.

Specified by:

createTeam in interface TeamOversight

Parameters:

context - ExecutiveContext.

Returns:

Team.

Throws:

java.lang.Exception - If fails to configure the TeamSource.