Package net.officefloor.frame.api.build

Interface OfficeBuilder

All Known Implementing Classes:

OfficeBuilderImpl

public interface OfficeBuilder

Builder of an Office.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	addEscalation(Class<? extends Throwable> typeOfCause, String functionName)	Adds an EscalationFlow for issues not handled within the Office.
<E, F extends Enum<F>> GovernanceBuilder<F>	addGovernance(String governanceName, Class<E> extensionInterface, GovernanceFactory<? super E,F> governanceFactory)	Adds Governance within the Office.
<O extends Enum<O>, F extends Enum<F>> ManagedFunctionBuilder<O,F>	addManagedFunction(String functionName, ManagedFunctionFactory<O,F> mangedFunctionFactory)	Adds a ManagedFunction to be executed within the Office.
void	addOfficeEnhancer(OfficeEnhancer officeEnhancer)	Adds OfficeEnhancer for this Office.
ThreadDependencyMappingBuilder	addProcessManagedObject(String processManagedObjectName, String officeManagedObjectName)	Adds a ProcessState bound ManagedObject to this Office.
void	addStartupFunction(String functionName, Object parameter)	Adds a ManagedFunction to invoke on start up of the Office.
ThreadDependencyMappingBuilder	addThreadManagedObject(String threadManagedObjectName, String officeManagedObjectName)	Adds a ThreadState bound ManagedObject to this Office.
void	addThreadSynchroniser(ThreadSynchroniserFactory threadSynchroniserFactory)	Adds a ThreadSynchroniser for the ThreadState of the Office.
void	registerManagedObjectSource(String officeManagedObjectName, String officeFloorManagedObjectSourceName)	Registers the ManagedObject within this Office.
void	registerTeam(String officeTeamName, String officeFloorTeamName)	Registers a Team which will execute ManagedFunction instances within this Office.
void	setBoundInputManagedObject(String inputManagedObjectName, String managedObjectSourceName)	Specifies the input ManagedObject to be bound to the ProcessState should there be multiple instances and it was not input.
void	setDefaultAsynchronousFlowTimeout(long timeout)	Specifies the default timeout for AsynchronousFlow instances.
void	setDefaultTeam(String officeTeamName)	Allows optionally specifying the default Team for the Office.
void	setManuallyManageGovernance(boolean isManuallyManageGovernance)	Flags whether to manually manage Governance via Administration instances.
void	setMaximumFunctionStateChainLength(int maximumFunctionStateChainLength)	Specifies the maximum FunctionState chain length.
void	setMonitorClock(MonitorClock clock)	Allows providing an MonitorClock implementation to obtain the current time.
void	setMonitorOfficeInterval(long monitorOfficeInterval)	Specifies the interval in milli-seconds between each time the OfficeManager monitors the Office.
void	setProfiler(Profiler profiler)	Allows to optionally specify a Profiler that listens in on profiling information of the Office.

Method Details

setMonitorClock

void setMonitorClock(MonitorClock clock)

Allows providing an MonitorClock implementation to obtain the current time.

Should no MonitorClock be provided, a default implementation will be used.

Typically this is useful in testing to fix to a deterministic time. However, should there be native implementations of keeping time that is efficient, this enables overriding the default implementation.

Parameters:

clock - MonitorClock.

setMonitorOfficeInterval

void setMonitorOfficeInterval(long monitorOfficeInterval)

Specifies the interval in milli-seconds between each time the OfficeManager monitors the Office.

Parameters:

monitorOfficeInterval - Interval in milli-seconds between each time the OfficeManager monitors the Office.

setMaximumFunctionStateChainLength

void setMaximumFunctionStateChainLength(int maximumFunctionStateChainLength)

Specifies the maximum FunctionState chain length.

This value is a trade off between limiting Thread stack calls and performance. Setting this value low runs the risk of StackOverflowError occurring in having recursively call into the FunctionState chain. Setting this value high, has more Thread overheads in breaking the recursive chain, slowing performance.

Parameters:

maximumFunctionStateChainLength - Maximum FunctionState chain length.

setDefaultAsynchronousFlowTimeout

void setDefaultAsynchronousFlowTimeout(long timeout)

Specifies the default timeout for AsynchronousFlow instances.

Parameters:

timeout - Default timeout.

registerTeam

void registerTeam(String officeTeamName,
 String officeFloorTeamName)

Registers a Team which will execute ManagedFunction instances within this Office.

Parameters:

officeTeamName - Name of the Team to be referenced locally by this Office.

officeFloorTeamName - Name of the Team within the OfficeFloor.

setDefaultTeam

void setDefaultTeam(String officeTeamName)

Allows optionally specifying the default Team for the Office.

Parameters:

officeTeamName - Name of the Team within this Office to use as default Team.

registerManagedObjectSource

void registerManagedObjectSource(String officeManagedObjectName,
 String officeFloorManagedObjectSourceName)

Registers the ManagedObject within this Office.

Parameters:

officeManagedObjectName - Name of the ManagedObject to be referenced locally by this Office.

officeFloorManagedObjectSourceName - Name of the ManagedObjectSource within the OfficeFloor.

setBoundInputManagedObject

void setBoundInputManagedObject(String inputManagedObjectName,
 String managedObjectSourceName)

Specifies the input ManagedObject to be bound to the ProcessState should there be multiple instances and it was not input.

Parameters:

inputManagedObjectName - Input ManagedObject name.

managedObjectSourceName - ManagedObjectSource name.

addProcessManagedObject

ThreadDependencyMappingBuilder addProcessManagedObject(String processManagedObjectName,
 String officeManagedObjectName)

Adds a ProcessState bound ManagedObject to this Office.

Dependency scope:

1. Other ManagedObject instances added via this method.

Parameters:

processManagedObjectName - Name to link the ManagedObject for ManagedFunction instances.

officeManagedObjectName - Name of the ManagedObject registered within this Office.

Returns:

ThreadDependencyMappingBuilder to build any necessary dependencies for the ManagedObject. See scope above.

addThreadManagedObject

ThreadDependencyMappingBuilder addThreadManagedObject(String threadManagedObjectName,
 String officeManagedObjectName)

Adds a ThreadState bound ManagedObject to this Office.

Dependency scope:

1. Other ManagedObject instances added via this method.
2. ProcessState bound ManagedObject instances.

Parameters:

threadManagedObjectName - Name to link the ManagedObject for ManagedFunction instances.

officeManagedObjectName - Name of theManagedObject registered within this Office.

Returns:

ThreadDependencyMappingBuilder to build any necessary dependencies for the ManagedObject. See scope above.

setManuallyManageGovernance

void setManuallyManageGovernance(boolean isManuallyManageGovernance)

Flags whether to manually manage Governance via Administration instances.

Parameters:

isManuallyManageGovernance - true to manually manage Governance via Administration instances.

addGovernance

<E,
F extends Enum<F>> GovernanceBuilder<F> addGovernance(String governanceName,
 Class<E> extensionInterface,
 GovernanceFactory<? super E,F> governanceFactory)

Adds Governance within the Office.

Type Parameters:

E - Extension interface type.

F - Flow key type.

Parameters:

governanceName - Name of the Governance to be referenced locally by this Office.

extensionInterface - Extension interface.

governanceFactory - GovernanceFactory class.

Returns:

GovernanceBuilder.

addManagedFunction

<O extends Enum<O>,
F extends Enum<F>>
ManagedFunctionBuilder<O,F> addManagedFunction(String functionName,
 ManagedFunctionFactory<O,F> mangedFunctionFactory)

Adds a ManagedFunction to be executed within the Office.

Type Parameters:

O - Dependency key type.

F - Flow key type.

Parameters:

functionName - Name of the ManagedFunction.

mangedFunctionFactory - ManagedFunctionFactory to create the ManagedFunction.

Returns:

ManagedFunctionBuilder for the ManagedFunction.

addEscalation

void addEscalation(Class<? extends Throwable> typeOfCause,
 String functionName)

Adds an EscalationFlow for issues not handled within the Office.

Parameters:

typeOfCause - Type of cause handled by this EscalationFlow.

functionName - Name of ManagedFunction to handle the EscalationFlow.

addStartupFunction

void addStartupFunction(String functionName,
 Object parameter)

Adds a ManagedFunction to invoke on start up of the Office.

Parameters:

functionName - Name of ManagedFunction.

parameter - Parameter value to be passed to the ManagedFunction. May be null.

addOfficeEnhancer

void addOfficeEnhancer(OfficeEnhancer officeEnhancer)

Adds OfficeEnhancer for this Office.

This enables enhancing the Office after the ManagedObjectSource instances are registered.

Parameters:

officeEnhancer - OfficeEnhancer.

setProfiler

void setProfiler(Profiler profiler)

Allows to optionally specify a Profiler that listens in on profiling information of the Office.

Parameters:

profiler - Profiler.

addThreadSynchroniser

void addThreadSynchroniser(ThreadSynchroniserFactory threadSynchroniserFactory)

Adds a ThreadSynchroniser for the ThreadState of the Office.

Parameters:

threadSynchroniserFactory - ThreadSynchroniserFactory to create the ThreadSynchroniser.