Interface OfficeConfiguration
- All Known Implementing Classes:
OfficeBuilderImpl
public interface OfficeConfiguration
Configuration of an
Office.- Author:
- Daniel Sagenschneider
-
Method Summary
Modifier and TypeMethodDescriptionObtains the configuration of theManagedObjectSourceto be bound for the inputManagedObject.Obtains theOfficeBuilderfor thisOffice.longObtains the defaultAsynchronousFlowtimeout forAsynchronousFlowinstances instigated by theOffice.Obtains theEscalationConfigurationinstances for theOffice.FlowBuilder<?>getFlowBuilder(String namespace, String functionName) Obtains aFunctionBuilderregistered with thisOfficeBuilder.GovernanceConfiguration<?,?>[] Obtains theGovernanceConfiguration.ManagedFunctionConfiguration<?,?>[] Obtains the configuration for theManagedFunctioninstances.intObtains the maximumFunctionStatechain length.Obtains theMonitorClock.longObtains the interval in milli-seconds between each time theOfficeManagermonitors theOffice.Obtains theOfficeEnhancerinstances for thisOffice.Obtains the name of thisOffice.Obtains the links to theOfficeFloorManagedObjectSourceinstances.Obtains the links to theOfficeFloorTeaminstances.Obtains the list ofManagedFunctionInvocationinstances referencing theManagedFunctioninstances to invoke onOfficestart up.Obtains theThreadSynchroniserFactoryinstances to synchronise theThreadLocalstate betweenTeaminstances.booleanIndicates if manually managingGovernanceviaAdministration.
-
Method Details
-
getOfficeName
String getOfficeName()Obtains the name of thisOffice.- Returns:
- Name of this
Office.
-
getMonitorClock
MonitorClock getMonitorClock()Obtains theMonitorClock.- Returns:
MonitorClock. May benullto use a default implementation.
-
getMonitorOfficeInterval
long getMonitorOfficeInterval()Obtains the interval in milli-seconds between each time theOfficeManagermonitors theOffice.- Returns:
- Interval in milli-seconds between each time the
OfficeManagermonitors theOffice.
-
getMaximumFunctionStateChainLength
int getMaximumFunctionStateChainLength()Obtains the maximumFunctionStatechain length.- Returns:
- Maximum
FunctionStatechain length.
-
getOfficeDefaultTeamName
String getOfficeDefaultTeamName() -
getBuilder
OfficeBuilder getBuilder()Obtains the
OfficeBuilderfor thisOffice.This is to allow
Assetinstances (such as aManagedObjectSource) to provide additional configuration for theOffice.- Returns:
OfficeBuilder.
-
getRegisteredTeams
LinkedTeamConfiguration[] getRegisteredTeams()Obtains the links to theOfficeFloorTeaminstances.- Returns:
- Links to the
OfficeFloorTeaminstances.
-
getRegisteredManagedObjectSources
LinkedManagedObjectSourceConfiguration[] getRegisteredManagedObjectSources()Obtains the links to theOfficeFloorManagedObjectSourceinstances.- Returns:
- Links to the
OfficeFloorManagedObjectSourceinstances.
-
getBoundInputManagedObjectConfiguration
BoundInputManagedObjectConfiguration[] getBoundInputManagedObjectConfiguration()Obtains the configuration of theManagedObjectSourceto be bound for the inputManagedObject.- Returns:
- Configuration of the
ManagedObjectSourceto be bound for the inputManagedObject.
-
getProcessManagedObjectConfiguration
ManagedObjectConfiguration<?>[] getProcessManagedObjectConfiguration()- Returns:
- Listing of the configuration of the
ManagedObjectinstances bound to theProcessState.
-
getThreadManagedObjectConfiguration
ManagedObjectConfiguration<?>[] getThreadManagedObjectConfiguration()- Returns:
- Listing of the configuration of the
ManagedObjectinstances bound to theThreadState.
-
getGovernanceConfiguration
GovernanceConfiguration<?,?>[] getGovernanceConfiguration()Obtains theGovernanceConfiguration.- Returns:
GovernanceConfiguration.
-
isManuallyManageGovernance
boolean isManuallyManageGovernance()Indicates if manually managingGovernanceviaAdministration.- Returns:
trueto manually managedGovernance.
-
getManagedFunctionConfiguration
ManagedFunctionConfiguration<?,?>[] getManagedFunctionConfiguration()Obtains the configuration for theManagedFunctioninstances.- Returns:
- Configuration for the
ManagedFunctioninstances.
-
getOfficeEnhancers
OfficeEnhancer[] getOfficeEnhancers()Obtains theOfficeEnhancerinstances for thisOffice.- Returns:
- Listing of the
OfficeEnhancerfor thisOffice.
-
getEscalationConfiguration
EscalationConfiguration[] getEscalationConfiguration()Obtains theEscalationConfigurationinstances for theOffice.- Returns:
EscalationConfigurationinstances for theOffice.
-
getFlowBuilder
Obtains a
FunctionBuilderregistered with thisOfficeBuilder.This enables addition configuration of
ManagedFunctioninstances registered by aManagedObjectSource.- Parameters:
namespace- Namespace. Likely theManagedObjectSourcename.functionName- Name of theManagedFunction.- Returns:
FlowBuilderfor theManagedFunction.
-
getStartupFunctions
ManagedFunctionInvocation[] getStartupFunctions()Obtains the list ofManagedFunctionInvocationinstances referencing theManagedFunctioninstances to invoke onOfficestart up.- Returns:
- List of start up
ManagedFunctionInvocationreferences.
-
getProfiler
Profiler getProfiler() -
getThreadSynchronisers
ThreadSynchroniserFactory[] getThreadSynchronisers()Obtains theThreadSynchroniserFactoryinstances to synchronise theThreadLocalstate betweenTeaminstances.- Returns:
ThreadSynchroniserFactoryinstances.
-
getDefaultAsynchronousFlowTimeout
long getDefaultAsynchronousFlowTimeout()Obtains the defaultAsynchronousFlowtimeout forAsynchronousFlowinstances instigated by theOffice.- Returns:
- Default
AsynchronousFlowtimeout forAsynchronousFlowinstances instigated by theOffice.
-