Package net.officefloor.frame.impl.construct.office

Class OfficeBuilderImpl

java.lang.Object

net.officefloor.frame.impl.construct.office.OfficeBuilderImpl

All Implemented Interfaces:

OfficeBuilder, OfficeConfiguration

public class OfficeBuilderImpl
extends java.lang.Object
implements OfficeBuilder, OfficeConfiguration

Implements the OfficeBuilder.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
OfficeBuilderImpl(java.lang.String officeName)	Initiate.

Method Summary

Modifier and Type	Method	Description
void	addEscalation(java.lang.Class<? extends java.lang.Throwable> typeOfCause, java.lang.String functionName)	Adds an EscalationFlow for issues not handled within the Office.
<E,F extends java.lang.Enum<F>> GovernanceBuilder<F>	addGovernance(java.lang.String governanceName, java.lang.Class<E> extensionInterface, GovernanceFactory<? super E,F> governanceFactory)	Adds Governance within the Office.
<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> ManagedFunctionBuilder<O,F>	addManagedFunction(java.lang.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(java.lang.String processManagedObjectName, java.lang.String officeManagedObjectName)	Adds a ProcessState bound ManagedObject to this Office.
void	addStartupFunction(java.lang.String functionName, java.lang.Object parameter)	Adds a ManagedFunction to invoke on start up of the Office.
ThreadDependencyMappingBuilder	addThreadManagedObject(java.lang.String threadManagedObjectName, java.lang.String officeManagedObjectName)	Adds a ThreadState bound ManagedObject to this Office.
void	addThreadSynchroniser(ThreadSynchroniserFactory threadSynchroniserFactory)	Adds a ThreadSynchroniser for the ThreadState of the Office.
BoundInputManagedObjectConfiguration[]	getBoundInputManagedObjectConfiguration()	Obtains the configuration of the ManagedObjectSource to be bound for the input ManagedObject.
OfficeBuilder	getBuilder()	Obtains the OfficeBuilder for this Office.
long	getDefaultAsynchronousFlowTimeout()	Obtains the default AsynchronousFlow timeout for AsynchronousFlow instances instigated by the Office.
EscalationConfiguration[]	getEscalationConfiguration()	Obtains the EscalationConfiguration instances for the Office.
FlowBuilder<?>	getFlowBuilder(java.lang.String namespace, java.lang.String functionName)	Obtains a FunctionBuilder registered with this OfficeBuilder.
GovernanceConfiguration<?,?>[]	getGovernanceConfiguration()	Obtains the GovernanceConfiguration.
ManagedFunctionConfiguration<?,?>[]	getManagedFunctionConfiguration()	Obtains the configuration for the ManagedFunction instances.
int	getMaximumFunctionStateChainLength()	Obtains the maximum FunctionState chain length.
MonitorClock	getMonitorClock()	Obtains the MonitorClock.
long	getMonitorOfficeInterval()	Obtains the interval in milli-seconds between each time the OfficeManager monitors the Office.
static java.lang.String	getNamespacedName(java.lang.String namespace, java.lang.String name)	Obtains the name with the added namespace.
java.lang.String	getOfficeDefaultTeamName()	Obtains the default Team name for the Office.
OfficeEnhancer[]	getOfficeEnhancers()	Obtains the OfficeEnhancer instances for this Office.
java.lang.String	getOfficeName()	Obtains the name of this Office.
ManagedObjectConfiguration<?>[]	getProcessManagedObjectConfiguration()	Obtains the ManagedObject instances to be bound to the ProcessState of this Office.
Profiler	getProfiler()	Obtains the Profiler for the Office.
LinkedManagedObjectSourceConfiguration[]	getRegisteredManagedObjectSources()	Obtains the links to the OfficeFloor ManagedObjectSource instances.
LinkedTeamConfiguration[]	getRegisteredTeams()	Obtains the links to the OfficeFloor Team instances.
ManagedFunctionInvocation[]	getStartupFunctions()	Obtains the list of ManagedFunctionInvocation instances referencing the ManagedFunction instances to invoke on Office start up.
ManagedObjectConfiguration<?>[]	getThreadManagedObjectConfiguration()	Obtains the ManagedObject instances to be bound to the ThreadState of this Office.
ThreadSynchroniserFactory[]	getThreadSynchronisers()	Obtains the ThreadSynchroniserFactory instances to synchronise the ThreadLocal state between Team instances.
boolean	isManuallyManageGovernance()	Indicates if manually managing Governance via Administration.
void	registerManagedObjectSource(java.lang.String officeManagedObjectName, java.lang.String officeFloorManagedObjectSourceName)	Registers the ManagedObject within this Office.
void	registerTeam(java.lang.String officeTeamName, java.lang.String officeFloorTeamName)	Registers a Team which will execute ManagedFunction instances within this Office.
void	setBoundInputManagedObject(java.lang.String inputManagedObjectName, java.lang.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(java.lang.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeBuilderImpl

public OfficeBuilderImpl(java.lang.String officeName)

Initiate.

Parameters:

officeName - Name of this Office.

Method Detail

getNamespacedName

public static java.lang.String getNamespacedName(java.lang.String namespace,
                                                 java.lang.String name)

Obtains the name with the added namespace.

Parameters:

namespace - Namespace.

name - Name.

Returns:

Name within the namespace.

setMonitorClock

public void setMonitorClock(MonitorClock clock)

Description copied from interface: OfficeBuilder

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.

Specified by:

setMonitorClock in interface OfficeBuilder

Parameters:

clock - MonitorClock.

setMonitorOfficeInterval

public void setMonitorOfficeInterval(long monitorOfficeInterval)

Description copied from interface: OfficeBuilder

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

Specified by:

setMonitorOfficeInterval in interface OfficeBuilder

Parameters:

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

setMaximumFunctionStateChainLength

public void setMaximumFunctionStateChainLength(int maximumFunctionStateChainLength)

Description copied from interface: OfficeBuilder

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.

Specified by:

setMaximumFunctionStateChainLength in interface OfficeBuilder

Parameters:

maximumFunctionStateChainLength - Maximum FunctionState chain length.

setDefaultAsynchronousFlowTimeout

public void setDefaultAsynchronousFlowTimeout(long timeout)

Description copied from interface: OfficeBuilder

Specifies the default timeout for AsynchronousFlow instances.

Specified by:

setDefaultAsynchronousFlowTimeout in interface OfficeBuilder

Parameters:

timeout - Default timeout.

registerTeam

public void registerTeam(java.lang.String officeTeamName,
                         java.lang.String officeFloorTeamName)

Description copied from interface: OfficeBuilder

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

Specified by:

registerTeam in interface OfficeBuilder

Parameters:

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

officeFloorTeamName - Name of the Team within the OfficeFloor.

setDefaultTeam

public void setDefaultTeam(java.lang.String officeTeamName)

Description copied from interface: OfficeBuilder

Allows optionally specifying the default Team for the Office.

Specified by:

setDefaultTeam in interface OfficeBuilder

Parameters:

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

registerManagedObjectSource

public void registerManagedObjectSource(java.lang.String officeManagedObjectName,
                                        java.lang.String officeFloorManagedObjectSourceName)

Description copied from interface: OfficeBuilder

Registers the ManagedObject within this Office.

Specified by:

registerManagedObjectSource in interface OfficeBuilder

Parameters:

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

officeFloorManagedObjectSourceName - Name of the ManagedObjectSource within the OfficeFloor.

setBoundInputManagedObject

public void setBoundInputManagedObject(java.lang.String inputManagedObjectName,
                                       java.lang.String managedObjectSourceName)

Description copied from interface: OfficeBuilder

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

Specified by:

setBoundInputManagedObject in interface OfficeBuilder

Parameters:

inputManagedObjectName - Input ManagedObject name.

managedObjectSourceName - ManagedObjectSource name.

addThreadManagedObject

public ThreadDependencyMappingBuilder addThreadManagedObject(java.lang.String threadManagedObjectName,
                                                             java.lang.String officeManagedObjectName)

Description copied from interface: OfficeBuilder

Adds a ThreadState bound ManagedObject to this Office.

Dependency scope:

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

Specified by:

addThreadManagedObject in interface OfficeBuilder

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.

addProcessManagedObject

public ThreadDependencyMappingBuilder addProcessManagedObject(java.lang.String processManagedObjectName,
                                                              java.lang.String officeManagedObjectName)

Description copied from interface: OfficeBuilder

Adds a ProcessState bound ManagedObject to this Office.

Dependency scope:

1. Other ManagedObject instances added via this method.

Specified by:

addProcessManagedObject in interface OfficeBuilder

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.

setManuallyManageGovernance

public void setManuallyManageGovernance(boolean isManuallyManageGovernance)

Description copied from interface: OfficeBuilder

Flags whether to manually manage Governance via Administration instances.

Specified by:

setManuallyManageGovernance in interface OfficeBuilder

Parameters:

isManuallyManageGovernance - true to manually manage Governance via Administration instances.

addGovernance

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

Description copied from interface: OfficeBuilder

Adds Governance within the Office.

Specified by:

addGovernance in interface OfficeBuilder

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

public <O extends java.lang.Enum<O>,F extends java.lang.Enum<F>> ManagedFunctionBuilder<O,F> addManagedFunction(java.lang.String functionName,
                                                                                                                            ManagedFunctionFactory<O,F> mangedFunctionFactory)

Description copied from interface: OfficeBuilder

Adds a ManagedFunction to be executed within the Office.

Specified by:

addManagedFunction in interface OfficeBuilder

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.

addOfficeEnhancer

public void addOfficeEnhancer(OfficeEnhancer officeEnhancer)

Description copied from interface: OfficeBuilder

Adds OfficeEnhancer for this Office.

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

Specified by:

addOfficeEnhancer in interface OfficeBuilder

Parameters:

officeEnhancer - OfficeEnhancer.

addEscalation

public void addEscalation(java.lang.Class<? extends java.lang.Throwable> typeOfCause,
                          java.lang.String functionName)

Description copied from interface: OfficeBuilder

Adds an EscalationFlow for issues not handled within the Office.

Specified by:

addEscalation in interface OfficeBuilder

Parameters:

typeOfCause - Type of cause handled by this EscalationFlow.

functionName - Name of ManagedFunction to handle the EscalationFlow.

addStartupFunction

public void addStartupFunction(java.lang.String functionName,
                               java.lang.Object parameter)

Description copied from interface: OfficeBuilder

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

Specified by:

addStartupFunction in interface OfficeBuilder

Parameters:

functionName - Name of ManagedFunction.

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

setProfiler

public void setProfiler(Profiler profiler)

Description copied from interface: OfficeBuilder

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

Specified by:

setProfiler in interface OfficeBuilder

Parameters:

profiler - Profiler.

addThreadSynchroniser

public void addThreadSynchroniser(ThreadSynchroniserFactory threadSynchroniserFactory)

Description copied from interface: OfficeBuilder

Adds a ThreadSynchroniser for the ThreadState of the Office.

Specified by:

addThreadSynchroniser in interface OfficeBuilder

Parameters:

threadSynchroniserFactory - ThreadSynchroniserFactory to create the ThreadSynchroniser.

getOfficeName

public java.lang.String getOfficeName()

Description copied from interface: OfficeConfiguration

Obtains the name of this Office.

Specified by:

getOfficeName in interface OfficeConfiguration

Returns:

Name of this Office.

getMonitorClock

public MonitorClock getMonitorClock()

Description copied from interface: OfficeConfiguration

Obtains the MonitorClock.

Specified by:

getMonitorClock in interface OfficeConfiguration

Returns:

MonitorClock. May be null to use a default implementation.

getMonitorOfficeInterval

public long getMonitorOfficeInterval()

Description copied from interface: OfficeConfiguration

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

Specified by:

getMonitorOfficeInterval in interface OfficeConfiguration

Returns:

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

getMaximumFunctionStateChainLength

public int getMaximumFunctionStateChainLength()

Description copied from interface: OfficeConfiguration

Obtains the maximum FunctionState chain length.

Specified by:

getMaximumFunctionStateChainLength in interface OfficeConfiguration

Returns:

Maximum FunctionState chain length.

getBuilder

public OfficeBuilder getBuilder()

Description copied from interface: OfficeConfiguration

Obtains the OfficeBuilder for this Office.

This is to allow Asset instances (such as a ManagedObjectSource) to provide additional configuration for the Office.

Specified by:

getBuilder in interface OfficeConfiguration

Returns:

OfficeBuilder.

getRegisteredTeams

public LinkedTeamConfiguration[] getRegisteredTeams()

Description copied from interface: OfficeConfiguration

Obtains the links to the OfficeFloor Team instances.

Specified by:

getRegisteredTeams in interface OfficeConfiguration

Returns:

Links to the OfficeFloor Team instances.

getOfficeDefaultTeamName

public java.lang.String getOfficeDefaultTeamName()

Description copied from interface: OfficeConfiguration

Obtains the default Team name for the Office.

Specified by:

getOfficeDefaultTeamName in interface OfficeConfiguration

Returns:

Default Team name for the Office. May be null to use any Team (typically the invoking Thread).

getRegisteredManagedObjectSources

public LinkedManagedObjectSourceConfiguration[] getRegisteredManagedObjectSources()

Description copied from interface: OfficeConfiguration

Obtains the links to the OfficeFloor ManagedObjectSource instances.

Specified by:

getRegisteredManagedObjectSources in interface OfficeConfiguration

Returns:

Links to the OfficeFloor ManagedObjectSource instances.

getBoundInputManagedObjectConfiguration

public BoundInputManagedObjectConfiguration[] getBoundInputManagedObjectConfiguration()

Description copied from interface: OfficeConfiguration

Obtains the configuration of the ManagedObjectSource to be bound for the input ManagedObject.

Specified by:

getBoundInputManagedObjectConfiguration in interface OfficeConfiguration

Returns:

Configuration of the ManagedObjectSource to be bound for the input ManagedObject.

getProcessManagedObjectConfiguration

public ManagedObjectConfiguration<?>[] getProcessManagedObjectConfiguration()

Description copied from interface: OfficeConfiguration

Obtains the ManagedObject instances to be bound to the ProcessState of this Office.

Specified by:

getProcessManagedObjectConfiguration in interface OfficeConfiguration

Returns:

Listing of the configuration of the ManagedObject instances bound to the ProcessState.

getThreadManagedObjectConfiguration

public ManagedObjectConfiguration<?>[] getThreadManagedObjectConfiguration()

Description copied from interface: OfficeConfiguration

Obtains the ManagedObject instances to be bound to the ThreadState of this Office.

Specified by:

getThreadManagedObjectConfiguration in interface OfficeConfiguration

Returns:

Listing of the configuration of the ManagedObject instances bound to the ThreadState.

isManuallyManageGovernance

public boolean isManuallyManageGovernance()

Description copied from interface: OfficeConfiguration

Indicates if manually managing Governance via Administration.

Specified by:

isManuallyManageGovernance in interface OfficeConfiguration

Returns:

true to manually managed Governance.

getGovernanceConfiguration

public GovernanceConfiguration<?,?>[] getGovernanceConfiguration()

Description copied from interface: OfficeConfiguration

Obtains the GovernanceConfiguration.

Specified by:

getGovernanceConfiguration in interface OfficeConfiguration

Returns:

GovernanceConfiguration.

getManagedFunctionConfiguration

public ManagedFunctionConfiguration<?,?>[] getManagedFunctionConfiguration()

Description copied from interface: OfficeConfiguration

Obtains the configuration for the ManagedFunction instances.

Specified by:

getManagedFunctionConfiguration in interface OfficeConfiguration

Returns:

Configuration for the ManagedFunction instances.

getOfficeEnhancers

public OfficeEnhancer[] getOfficeEnhancers()

Description copied from interface: OfficeConfiguration

Obtains the OfficeEnhancer instances for this Office.

Specified by:

getOfficeEnhancers in interface OfficeConfiguration

Returns:

Listing of the OfficeEnhancer for this Office.

getEscalationConfiguration

public EscalationConfiguration[] getEscalationConfiguration()

Description copied from interface: OfficeConfiguration

Obtains the EscalationConfiguration instances for the Office.

Specified by:

getEscalationConfiguration in interface OfficeConfiguration

Returns:

EscalationConfiguration instances for the Office.

getFlowBuilder

public FlowBuilder<?> getFlowBuilder(java.lang.String namespace,
                                     java.lang.String functionName)

Description copied from interface: OfficeConfiguration

Obtains a FunctionBuilder registered with this OfficeBuilder.

This enables addition configuration of ManagedFunction instances registered by a ManagedObjectSource.

Specified by:

getFlowBuilder in interface OfficeConfiguration

Parameters:

namespace - Namespace. Likely the ManagedObjectSource name.

functionName - Name of the ManagedFunction.

Returns:

FlowBuilder for the ManagedFunction.

getStartupFunctions

public ManagedFunctionInvocation[] getStartupFunctions()

Description copied from interface: OfficeConfiguration

Obtains the list of ManagedFunctionInvocation instances referencing the ManagedFunction instances to invoke on Office start up.

Specified by:

getStartupFunctions in interface OfficeConfiguration

Returns:

List of start up ManagedFunctionInvocation references.

getProfiler

public Profiler getProfiler()

Description copied from interface: OfficeConfiguration

Obtains the Profiler for the Office.

Specified by:

getProfiler in interface OfficeConfiguration

Returns:

Profiler for the Office.

getThreadSynchronisers

public ThreadSynchroniserFactory[] getThreadSynchronisers()

Description copied from interface: OfficeConfiguration

Obtains the ThreadSynchroniserFactory instances to synchronise the ThreadLocal state between Team instances.

Specified by:

getThreadSynchronisers in interface OfficeConfiguration

Returns:

ThreadSynchroniserFactory instances.

getDefaultAsynchronousFlowTimeout

public long getDefaultAsynchronousFlowTimeout()

Description copied from interface: OfficeConfiguration

Obtains the default AsynchronousFlow timeout for AsynchronousFlow instances instigated by the Office.

Specified by:

getDefaultAsynchronousFlowTimeout in interface OfficeConfiguration

Returns:

Default AsynchronousFlow timeout for AsynchronousFlow instances instigated by the Office.