Package net.officefloor.frame.internal.structure

Interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

All Known Implementing Classes:

ManagedObjectMetaDataImpl

public interface ManagedObjectMetaData<O extends java.lang.Enum<O>>

Meta-data of a ManagedObject.

Author:

Daniel Sagenschneider

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.
FunctionState	recycle(ManagedObject managedObject, ManagedObjectCleanup cleanupSequence)	Creates the FunctionState for the recycling of the ManagedObject.

Method Detail

getBoundManagedObjectName

java.lang.String getBoundManagedObjectName()

Obtains the name of the ManagedObject bound within the ManagedObjectScope.

Returns:

Name of the ManagedObject bound within the ManagedObjectScope.

getLogger

java.util.logging.Logger getLogger()

Obtains the Logger for the ManagedObject.

Returns:

Logger for the ManagedObject.

getObjectType

java.lang.Class<?> getObjectType()

Obtains the type of the Object returned from the ManagedObject.

Returns:

Type of the Object returned from the ManagedObject.

getInstanceIndex

int getInstanceIndex()

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.

Returns:

Instance index of the ManagedObject bound to the ManagedObjectIndex.

getFunctionLoop

FunctionLoop getFunctionLoop()

Obtains the FunctionLoop for the ManagedObject.

Returns:

FunctionLoop for the ManagedObject.

getSourcingManagerReference

AssetManagerReference getSourcingManagerReference()

Obtains the AssetManagerReference that manages the sourcing of the ManagedObject.

Returns:

AssetManagerReference that manages the sourcing of the ManagedObject.

getManagedObjectSource

ManagedObjectSource<?,?> getManagedObjectSource()

Obtains the ManagedObjectSource for the ManagedObject.

Returns:

ManagedObjectSource for the ManagedObject.

getManagedObjectPool

ManagedObjectPool getManagedObjectPool()

Obtains the ManagedObjectPool for the ManagedObject.

Returns:

ManagedObjectPool for the ManagedObject.

getStartupFunctions

ManagedObjectStartupFunction[] getStartupFunctions()

Obtains the ManagedObjectStartupFunction instances for the ManagedObjectSource.

Returns:

ManagedObjectStartupFunction instances for the ManagedObjectSource.

getMonitorClock

MonitorClock getMonitorClock()

Obtains the MonitorClock.

Returns:

MonitorClock.

getTimeout

long getTimeout()

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

Returns:

Time out in milliseconds.

isContextAwareManagedObject

boolean isContextAwareManagedObject()

Indicates if the ManagedObject implements ContextAwareManagedObject.

Returns:

true if the ManagedObject implements ContextAwareManagedObject.

isManagedObjectAsynchronous

boolean isManagedObjectAsynchronous()

Indicates if the ManagedObject implements AsynchronousManagedObject.

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

Returns:

true if the ManagedObject implements AsynchronousManagedObject.

getOperationsManagerReference

AssetManagerReference getOperationsManagerReference()

Obtains the AssetManagerReference that manages asynchronous operations on the ManagedObject.

Returns:

AssetManagerReference that manages asynchronous operations on the ManagedObject.

getGovernanceMetaData

ManagedObjectGovernanceMetaData<?>[] getGovernanceMetaData()

Obtains the ManagedObjectGovernanceMetaData applicable to this ManagedObject.

Returns:

ManagedObjectGovernanceMetaData applicable to this ManagedObject.

isCoordinatingManagedObject

boolean isCoordinatingManagedObject()

Indicates if the ManagedObject implements CoordinatingManagedObject.

Returns:

true if the ManagedObject implements CoordinatingManagedObject.

checkReady

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

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.

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

ObjectRegistry<O> createObjectRegistry(ManagedFunctionContainer currentContainer)

Creates the ObjectRegistry for the ManagedObject.

Parameters:

currentContainer - ManagedFunctionContainer.

Returns:

ObjectRegistry.

getPreLoadAdministration

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

Obtains the pre-load ManagedObjectAdministrationMetaData.

Returns:

Pre-load ManagedObjectAdministrationMetaData.

recycle

FunctionState recycle(ManagedObject managedObject,
                      ManagedObjectCleanup cleanupSequence)

Creates the FunctionState for the recycling of the ManagedObject.

Parameters:

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

cleanupSequence - ManagedObjectCleanup.

Returns:

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