Package net.officefloor.frame.internal.configuration

Interface OfficeConfiguration

All Known Implementing Classes:

OfficeBuilderImpl

public interface OfficeConfiguration

Configuration of an Office.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
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(String namespace, 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.
String	getOfficeDefaultTeamName()	Obtains the default Team name for the Office.
OfficeEnhancer[]	getOfficeEnhancers()	Obtains the OfficeEnhancer instances for this Office.
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.

Method Details

getOfficeName

String getOfficeName()

Obtains the name of this Office.

Returns:

Name of this Office.

getMonitorClock

MonitorClock getMonitorClock()

Obtains the MonitorClock.

Returns:

MonitorClock. May be null to use a default implementation.

getMonitorOfficeInterval

long getMonitorOfficeInterval()

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

Returns:

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

getMaximumFunctionStateChainLength

int getMaximumFunctionStateChainLength()

Obtains the maximum FunctionState chain length.

Returns:

Maximum FunctionState chain length.

getOfficeDefaultTeamName

String getOfficeDefaultTeamName()

Obtains the default Team name for the Office.

Returns:

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

getBuilder

OfficeBuilder getBuilder()

Obtains the OfficeBuilder for this Office.

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

Returns:

OfficeBuilder.

getRegisteredTeams

LinkedTeamConfiguration[] getRegisteredTeams()

Obtains the links to the OfficeFloor Team instances.

Returns:

Links to the OfficeFloor Team instances.

getRegisteredManagedObjectSources

LinkedManagedObjectSourceConfiguration[] getRegisteredManagedObjectSources()

Obtains the links to the OfficeFloor ManagedObjectSource instances.

Returns:

Links to the OfficeFloor ManagedObjectSource instances.

getBoundInputManagedObjectConfiguration

BoundInputManagedObjectConfiguration[] getBoundInputManagedObjectConfiguration()

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

Returns:

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

getProcessManagedObjectConfiguration

ManagedObjectConfiguration<?>[] getProcessManagedObjectConfiguration()

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

Returns:

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

getThreadManagedObjectConfiguration

ManagedObjectConfiguration<?>[] getThreadManagedObjectConfiguration()

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

Returns:

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

getGovernanceConfiguration

GovernanceConfiguration<?,?>[] getGovernanceConfiguration()

Obtains the GovernanceConfiguration.

Returns:

GovernanceConfiguration.

isManuallyManageGovernance

boolean isManuallyManageGovernance()

Indicates if manually managing Governance via Administration.

Returns:

true to manually managed Governance.

getManagedFunctionConfiguration

ManagedFunctionConfiguration<?,?>[] getManagedFunctionConfiguration()

Obtains the configuration for the ManagedFunction instances.

Returns:

Configuration for the ManagedFunction instances.

getOfficeEnhancers

OfficeEnhancer[] getOfficeEnhancers()

Obtains the OfficeEnhancer instances for this Office.

Returns:

Listing of the OfficeEnhancer for this Office.

getEscalationConfiguration

EscalationConfiguration[] getEscalationConfiguration()

Obtains the EscalationConfiguration instances for the Office.

Returns:

EscalationConfiguration instances for the Office.

getFlowBuilder

FlowBuilder<?> getFlowBuilder(String namespace,
 String functionName)

Obtains a FunctionBuilder registered with this OfficeBuilder.

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

Parameters:

namespace - Namespace. Likely the ManagedObjectSource name.

functionName - Name of the ManagedFunction.

Returns:

FlowBuilder for the ManagedFunction.

getStartupFunctions

ManagedFunctionInvocation[] getStartupFunctions()

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

Returns:

List of start up ManagedFunctionInvocation references.

getProfiler

Profiler getProfiler()

Obtains the Profiler for the Office.

Returns:

Profiler for the Office.

getThreadSynchronisers

ThreadSynchroniserFactory[] getThreadSynchronisers()

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

Returns:

ThreadSynchroniserFactory instances.

getDefaultAsynchronousFlowTimeout

long getDefaultAsynchronousFlowTimeout()

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

Returns:

Default AsynchronousFlow timeout for AsynchronousFlow instances instigated by the Office.