Package net.officefloor.frame.impl.execute.managedobject

Class ManagedObjectMetaDataImpl<O extends java.lang.Enum<O>>

java.lang.Object

net.officefloor.frame.impl.execute.managedobject.ManagedObjectMetaDataImpl<O>

All Implemented Interfaces:

ManagedObjectMetaData<O>

public class ManagedObjectMetaDataImpl<O extends java.lang.Enum<O>>
extends java.lang.Object
implements ManagedObjectMetaData<O>

Meta-data of the ManagedObject.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor

Description

ManagedObjectMetaDataImpl(java.lang.String boundManagedObjectName, java.lang.Class<?> objectType, int instanceIndex, ManagedObjectSource<?,?> source, ManagedObjectPool pool, boolean isContextAwareManagedObject, AssetManagerReference sourcingManagerReference, boolean isManagedObjectAsynchronous, AssetManagerReference operationsManagerReference, boolean isCoordinatingManagedObject, ManagedObjectIndex[] dependencyMapping, long timeout, ManagedObjectGovernanceMetaData<?>[] governanceMetaData, java.util.logging.Logger logger)

Instantiate.

Method Summary

Modifier and Type	Method	Description
FunctionState	checkReady(ManagedFunctionContainer managedFunction, ManagedObjectReadyCheck check, ManagedObjectContainer currentContainer)	Creates a FunctionState to check if the dependencies of this ManagedObject are ready.
ObjectRegistry<O>	createObjectRegistry(ManagedFunctionContainer currentContainer)	Creates the ObjectRegistry for the ManagedObject.
java.lang.String	getBoundManagedObjectName()	Obtains the name of the ManagedObject bound within the ManagedObjectScope.
FunctionLoop	getFunctionLoop()	Obtains the FunctionLoop for the ManagedObject.
ManagedObjectGovernanceMetaData<?>[]	getGovernanceMetaData()	Obtains the ManagedObjectGovernanceMetaData applicable to this ManagedObject.
int	getInstanceIndex()	Obtains the instance index of the ManagedObject bound to the ManagedObjectIndex.
java.util.logging.Logger	getLogger()	Obtains the Logger for the ManagedObject.
ManagedObjectPool	getManagedObjectPool()	Obtains the ManagedObjectPool for the ManagedObject.
ManagedObjectSource<?,?>	getManagedObjectSource()	Obtains the ManagedObjectSource for the ManagedObject.
MonitorClock	getMonitorClock()	Obtains the MonitorClock.
java.lang.Class<?>	getObjectType()	Obtains the type of the Object returned from the ManagedObject.
AssetManagerReference	getOperationsManagerReference()	Obtains the AssetManagerReference that manages asynchronous operations on the ManagedObject.
ManagedObjectAdministrationMetaData<?,?,?>[]	getPreLoadAdministration()	Obtains the pre-load ManagedObjectAdministrationMetaData.
AssetManagerReference	getSourcingManagerReference()	Obtains the AssetManagerReference that manages the sourcing of the ManagedObject.
ManagedObjectStartupFunction[]	getStartupFunctions()	Obtains the ManagedObjectStartupFunction instances for the ManagedObjectSource.
long	getTimeout()	Obtains the time out in milliseconds for the asynchronous operation to complete.
boolean	isContextAwareManagedObject()	Indicates if the ManagedObject implements ContextAwareManagedObject.
boolean	isCoordinatingManagedObject()	Indicates if the ManagedObject implements CoordinatingManagedObject.
boolean	isManagedObjectAsynchronous()	Indicates if the ManagedObject implements AsynchronousManagedObject.
void	loadRemainingState(OfficeMetaData officeMetaData, ManagedObjectStartupFunction[] startupFunctions, FlowMetaData recycleFlowMetaData, ManagedObjectAdministrationMetaData<?,?,?>[] preloadAdministration)	Loads the remaining state of this ManagedObjectMetaData.
FunctionState	recycle(ManagedObject managedObject, ManagedObjectCleanup cleanup)	Creates the FunctionState for the recycling of the ManagedObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedObjectMetaDataImpl

public ManagedObjectMetaDataImpl(java.lang.String boundManagedObjectName,
                                 java.lang.Class<?> objectType,
                                 int instanceIndex,
                                 ManagedObjectSource<?,?> source,
                                 ManagedObjectPool pool,
                                 boolean isContextAwareManagedObject,
                                 AssetManagerReference sourcingManagerReference,
                                 boolean isManagedObjectAsynchronous,
                                 AssetManagerReference operationsManagerReference,
                                 boolean isCoordinatingManagedObject,
                                 ManagedObjectIndex[] dependencyMapping,
                                 long timeout,
                                 ManagedObjectGovernanceMetaData<?>[] governanceMetaData,
                                 java.util.logging.Logger logger)

Instantiate.

Parameters:

boundManagedObjectName - Name of the ManagedObject bound within the ManagedObjectScope.

objectType - Type of the Object returned from the ManagedObject.

instanceIndex - Instance index.

source - ManagedObjectSource of the ManagedObject.

pool - ManagedObjectPool of the ManagedObject.

isContextAwareManagedObject - true if the ManagedObject is ContextAwareManagedObject.

sourcingManagerReference - AssetManagerReference to manage the sourcing of the ManagedObject instances.

isManagedObjectAsynchronous - true if the ManagedObject is AsynchronousManagedObject.

operationsManagerReference - AssetManagerReference to manage the asynchronous operations on the ManagedObject instances.

isCoordinatingManagedObject - true if the ManagedObject is CoordinatingManagedObject.

dependencyMapping - ManagedObjectIndex for the dependencies in the index order required.

timeout - Timeout of an asynchronous operation by the ManagedObject being managed.

governanceMetaData - ManagedObjectGovernanceMetaData instances applicable to this ManagedObject.

logger - Logger for the ManagedObject.

Method Detail

loadRemainingState

public void loadRemainingState(OfficeMetaData officeMetaData,
                               ManagedObjectStartupFunction[] startupFunctions,
                               FlowMetaData recycleFlowMetaData,
                               ManagedObjectAdministrationMetaData<?,?,?>[] preloadAdministration)

Loads the remaining state of this ManagedObjectMetaData.

Parameters:

officeMetaData - OfficeMetaData of the Office containing this ManagedObjectMetaData.

startupFunctions - ManagedObjectStartupFunction instances for this ManagedObjectSource.

recycleFlowMetaData - FlowMetaData for the recycling of this ManagedObject.

preloadAdministration - Pre-load ManagedObjectAdministrationMetaData.

getBoundManagedObjectName

public java.lang.String getBoundManagedObjectName()

Description copied from interface: ManagedObjectMetaData

Obtains the name of the ManagedObject bound within the ManagedObjectScope.

Specified by:

getBoundManagedObjectName in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

Name of the ManagedObject bound within the ManagedObjectScope.

getLogger

public java.util.logging.Logger getLogger()

Description copied from interface: ManagedObjectMetaData

Obtains the Logger for the ManagedObject.

Specified by:

getLogger in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

Logger for the ManagedObject.

getObjectType

public java.lang.Class<?> getObjectType()

Description copied from interface: ManagedObjectMetaData

Obtains the type of the Object returned from the ManagedObject.

Specified by:

getObjectType in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

Type of the Object returned from the ManagedObject.

getInstanceIndex

public int getInstanceIndex()

Description copied from interface: ManagedObjectMetaData

Obtains the instance index of the ManagedObject bound to the ManagedObjectIndex.

ManagedObjectSource instances that invoke ProcessState instances with the same type of Object may all be bound to the same ManagedObjectIndex.

Specified by:

getInstanceIndex in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

Instance index of the ManagedObject bound to the ManagedObjectIndex.

getSourcingManagerReference

public AssetManagerReference getSourcingManagerReference()

Description copied from interface: ManagedObjectMetaData

Obtains the AssetManagerReference that manages the sourcing of the ManagedObject.

Specified by:

getSourcingManagerReference in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

AssetManagerReference that manages the sourcing of the ManagedObject.

getManagedObjectSource

public ManagedObjectSource<?,?> getManagedObjectSource()

Description copied from interface: ManagedObjectMetaData

Obtains the ManagedObjectSource for the ManagedObject.

Specified by:

getManagedObjectSource in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

ManagedObjectSource for the ManagedObject.

getManagedObjectPool

public ManagedObjectPool getManagedObjectPool()

Description copied from interface: ManagedObjectMetaData

Obtains the ManagedObjectPool for the ManagedObject.

Specified by:

getManagedObjectPool in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

ManagedObjectPool for the ManagedObject.

getStartupFunctions

public ManagedObjectStartupFunction[] getStartupFunctions()

Description copied from interface: ManagedObjectMetaData

Obtains the ManagedObjectStartupFunction instances for the ManagedObjectSource.

Specified by:

getStartupFunctions in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

ManagedObjectStartupFunction instances for the ManagedObjectSource.

getTimeout

public long getTimeout()

Description copied from interface: ManagedObjectMetaData

Obtains the time out in milliseconds for the asynchronous operation to complete.

Specified by:

getTimeout in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

Time out in milliseconds.

isContextAwareManagedObject

public boolean isContextAwareManagedObject()

Description copied from interface: ManagedObjectMetaData

Indicates if the ManagedObject implements ContextAwareManagedObject.

Specified by:

isContextAwareManagedObject in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

true if the ManagedObject implements ContextAwareManagedObject.

isManagedObjectAsynchronous

public boolean isManagedObjectAsynchronous()

Description copied from interface: ManagedObjectMetaData

Indicates if the ManagedObject implements AsynchronousManagedObject.

Should the ManagedObject implement AsynchronousManagedObject then it will require checking if ready.

Specified by:

isManagedObjectAsynchronous in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

true if the ManagedObject implements AsynchronousManagedObject.

getOperationsManagerReference

public AssetManagerReference getOperationsManagerReference()

Description copied from interface: ManagedObjectMetaData

Obtains the AssetManagerReference that manages asynchronous operations on the ManagedObject.

Specified by:

getOperationsManagerReference in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

AssetManagerReference that manages asynchronous operations on the ManagedObject.

isCoordinatingManagedObject

public boolean isCoordinatingManagedObject()

Description copied from interface: ManagedObjectMetaData

Indicates if the ManagedObject implements CoordinatingManagedObject.

Specified by:

isCoordinatingManagedObject in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

true if the ManagedObject implements CoordinatingManagedObject.

getFunctionLoop

public FunctionLoop getFunctionLoop()

Description copied from interface: ManagedObjectMetaData

Obtains the FunctionLoop for the ManagedObject.

Specified by:

getFunctionLoop in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

FunctionLoop for the ManagedObject.

getMonitorClock

public MonitorClock getMonitorClock()

Description copied from interface: ManagedObjectMetaData

Obtains the MonitorClock.

Specified by:

getMonitorClock in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

MonitorClock.

checkReady

public FunctionState checkReady(ManagedFunctionContainer managedFunction,
                                ManagedObjectReadyCheck check,
                                ManagedObjectContainer currentContainer)

Description copied from interface: ManagedObjectMetaData

Creates a FunctionState to check if the dependencies of this ManagedObject are ready.

Should a ManagedObject not be ready, then will latch the ManagedFunctionContainer to wait for the ManagedObject to be ready.

Specified by:

checkReady in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Parameters:

managedFunction - ManagedFunctionContainer requesting the check of the ManagedObject to be ready.

check - ManagedObjectReadyCheck.

currentContainer - Optional able to include the current ManagedObjectContainer for this ManagedObjectMetaData in ready check. May be null to not include.

Returns:

FunctionState instances to check if the dependencies of this ManagedObject are ready.

createObjectRegistry

public ObjectRegistry<O> createObjectRegistry(ManagedFunctionContainer currentContainer)

Description copied from interface: ManagedObjectMetaData

Creates the ObjectRegistry for the ManagedObject.

Specified by:

createObjectRegistry in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Parameters:

currentContainer - ManagedFunctionContainer.

Returns:

ObjectRegistry.

getGovernanceMetaData

public ManagedObjectGovernanceMetaData<?>[] getGovernanceMetaData()

Description copied from interface: ManagedObjectMetaData

Obtains the ManagedObjectGovernanceMetaData applicable to this ManagedObject.

Specified by:

getGovernanceMetaData in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

ManagedObjectGovernanceMetaData applicable to this ManagedObject.

getPreLoadAdministration

public ManagedObjectAdministrationMetaData<?,?,?>[] getPreLoadAdministration()

Description copied from interface: ManagedObjectMetaData

Obtains the pre-load ManagedObjectAdministrationMetaData.

Specified by:

getPreLoadAdministration in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Returns:

Pre-load ManagedObjectAdministrationMetaData.

recycle

public FunctionState recycle(ManagedObject managedObject,
                             ManagedObjectCleanup cleanup)

Description copied from interface: ManagedObjectMetaData

Creates the FunctionState for the recycling of the ManagedObject.

Specified by:

recycle in interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Parameters:

managedObject - ManagedObject to be recycled. Obtained by the RecycleManagedObjectParameter.getManagedObject().

cleanup - ManagedObjectCleanup.

Returns:

FunctionState for the recycling this ManagedObject or null if no recycling is required for this ManagedObject.