Interface ManagedObjectMetaData<O extends Enum<O>>
- All Known Implementing Classes:
ManagedObjectMetaDataImpl
public interface ManagedObjectMetaData<O extends Enum<O>>
Meta-data of a
ManagedObject.- Author:
- Daniel Sagenschneider
-
Method Summary
Modifier and TypeMethodDescriptioncheckReady(ManagedFunctionContainer managedFunction, ManagedObjectReadyCheck check, ManagedObjectContainer currentContainer) Creates aFunctionStateto check if the dependencies of thisManagedObjectare ready.createObjectRegistry(ManagedFunctionContainer currentContainer) Creates theObjectRegistryfor theManagedObject.Obtains the name of theManagedObjectbound within theManagedObjectScope.Obtains theFunctionLoopfor theManagedObject.Obtains theManagedObjectGovernanceMetaDataapplicable to thisManagedObject.intObtains the instance index of theManagedObjectbound to theManagedObjectIndex.Obtains theLoggerfor theManagedObject.Obtains theManagedObjectPoolfor theManagedObject.ManagedObjectSource<?,?> Obtains theManagedObjectSourcefor theManagedObject.Obtains theMonitorClock.Class<?>Obtains the type of theObjectreturned from theManagedObject.Obtains theAssetManagerReferencethat manages asynchronous operations on theManagedObject.ManagedObjectAdministrationMetaData<?,?, ?>[] Obtains the pre-loadManagedObjectAdministrationMetaData.Obtains theAssetManagerReferencethat manages the sourcing of theManagedObject.Obtains theManagedObjectStartupFunctioninstances for theManagedObjectSource.longObtains the time out in milliseconds for the asynchronous operation to complete.booleanIndicates if theManagedObjectimplementsContextAwareManagedObject.booleanIndicates if theManagedObjectimplementsCoordinatingManagedObject.booleanIndicates if theManagedObjectimplementsAsynchronousManagedObject.recycle(ManagedObject managedObject, ManagedObjectCleanup cleanupSequence) Creates theFunctionStatefor the recycling of theManagedObject.
-
Method Details
-
getBoundManagedObjectName
String getBoundManagedObjectName()Obtains the name of theManagedObjectbound within theManagedObjectScope.- Returns:
- Name of the
ManagedObjectbound within theManagedObjectScope.
-
getLogger
Logger getLogger()Obtains theLoggerfor theManagedObject.- Returns:
Loggerfor theManagedObject.
-
getObjectType
Class<?> getObjectType()Obtains the type of theObjectreturned from theManagedObject.- Returns:
- Type of the
Objectreturned from theManagedObject.
-
getInstanceIndex
int getInstanceIndex()Obtains the instance index of the
ManagedObjectbound to theManagedObjectIndex.ManagedObjectSourceinstances that invokeProcessStateinstances with the same type of Object may all be bound to the sameManagedObjectIndex.- Returns:
- Instance index of the
ManagedObjectbound to theManagedObjectIndex.
-
getFunctionLoop
FunctionLoop getFunctionLoop()Obtains theFunctionLoopfor theManagedObject.- Returns:
FunctionLoopfor theManagedObject.
-
getSourcingManagerReference
AssetManagerReference getSourcingManagerReference()Obtains theAssetManagerReferencethat manages the sourcing of theManagedObject.- Returns:
AssetManagerReferencethat manages the sourcing of theManagedObject.
-
getManagedObjectSource
ManagedObjectSource<?,?> getManagedObjectSource()Obtains theManagedObjectSourcefor theManagedObject.- Returns:
ManagedObjectSourcefor theManagedObject.
-
getManagedObjectPool
ManagedObjectPool getManagedObjectPool()Obtains theManagedObjectPoolfor theManagedObject.- Returns:
ManagedObjectPoolfor theManagedObject.
-
getStartupFunctions
ManagedObjectStartupFunction[] getStartupFunctions()Obtains theManagedObjectStartupFunctioninstances for theManagedObjectSource.- Returns:
ManagedObjectStartupFunctioninstances for theManagedObjectSource.
-
getMonitorClock
MonitorClock getMonitorClock()Obtains theMonitorClock.- 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 theManagedObjectimplementsContextAwareManagedObject.- Returns:
trueif theManagedObjectimplementsContextAwareManagedObject.
-
isManagedObjectAsynchronous
boolean isManagedObjectAsynchronous()Indicates if the
ManagedObjectimplementsAsynchronousManagedObject.Should the
ManagedObjectimplementAsynchronousManagedObjectthen it will require checking if ready.- Returns:
trueif theManagedObjectimplementsAsynchronousManagedObject.
-
getOperationsManagerReference
AssetManagerReference getOperationsManagerReference()Obtains theAssetManagerReferencethat manages asynchronous operations on theManagedObject.- Returns:
AssetManagerReferencethat manages asynchronous operations on theManagedObject.
-
getGovernanceMetaData
ManagedObjectGovernanceMetaData<?>[] getGovernanceMetaData()Obtains theManagedObjectGovernanceMetaDataapplicable to thisManagedObject.- Returns:
ManagedObjectGovernanceMetaDataapplicable to thisManagedObject.
-
isCoordinatingManagedObject
boolean isCoordinatingManagedObject()Indicates if theManagedObjectimplementsCoordinatingManagedObject.- Returns:
trueif theManagedObjectimplementsCoordinatingManagedObject.
-
checkReady
FunctionState checkReady(ManagedFunctionContainer managedFunction, ManagedObjectReadyCheck check, ManagedObjectContainer currentContainer) Creates a
FunctionStateto check if the dependencies of thisManagedObjectare ready.Should a
ManagedObjectnot be ready, then will latch theManagedFunctionContainerto wait for theManagedObjectto be ready.- Parameters:
managedFunction-ManagedFunctionContainerrequesting the check of theManagedObjectto be ready.check-ManagedObjectReadyCheck.currentContainer- Optional able to include the currentManagedObjectContainerfor thisManagedObjectMetaDatain ready check. May benullto not include.- Returns:
FunctionStateinstances to check if the dependencies of thisManagedObjectare ready.
-
createObjectRegistry
Creates theObjectRegistryfor theManagedObject.- Parameters:
currentContainer-ManagedFunctionContainer.- Returns:
ObjectRegistry.
-
getPreLoadAdministration
ManagedObjectAdministrationMetaData<?,?, getPreLoadAdministration()?>[] Obtains the pre-loadManagedObjectAdministrationMetaData.- Returns:
- Pre-load
ManagedObjectAdministrationMetaData.
-
recycle
Creates theFunctionStatefor the recycling of theManagedObject.- Parameters:
managedObject-ManagedObjectto be recycled. Obtained by theRecycleManagedObjectParameter.getManagedObject().cleanupSequence-ManagedObjectCleanup.- Returns:
FunctionStatefor the recycling thisManagedObjectornullif no recycling is required for thisManagedObject.
-