Package net.officefloor.frame.impl.construct.managedobjectsource

Class ManagedObjectSourceContextImpl<F extends java.lang.Enum<F>>

java.lang.Object

net.officefloor.frame.impl.construct.source.SourcePropertiesImpl

net.officefloor.frame.impl.construct.source.SourceContextImpl

net.officefloor.frame.impl.construct.managedobjectsource.ManagedObjectSourceContextImpl<F>

All Implemented Interfaces:

ManagedObjectSourceContext<F>, ServiceContext, SourceContext, SourceProperties

public class ManagedObjectSourceContextImpl<F extends java.lang.Enum<F>>
extends SourceContextImpl
implements ManagedObjectSourceContext<F>

Implementation of the ManagedObjectSourceContext.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagedObjectSourceContextImpl.ManagedObjectFunctionDependencyImpl	ManagedObjectFunctionDependency implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MANAGED_OBJECT_RECYCLE_FUNCTION_NAME	Name of the recycle the ManagedFunction.

Constructor Summary

Constructors

Constructor	Description
ManagedObjectSourceContextImpl(java.lang.String managedObjectSourceName, boolean isLoadingType, java.lang.String managedObjectName, ManagingOfficeConfiguration<F> managingOfficeConfiguration, java.lang.String[] additionalProfiles, SourceProperties properties, SourceContext sourceContext, ManagingOfficeBuilder<F> managingOfficeBuilder, OfficeBuilder officeBuilder, java.lang.Object startupNotify)	Initiate.

Method Summary

Modifier and Type	Method	Description
ManagedObjectFunctionDependency	addFunctionDependency(java.lang.String name, java.lang.Class<?> objectType)	Adds a ManagedObjectFunctionDependency.
<o extends java.lang.Enum<o>,f extends java.lang.Enum<f>> ManagedObjectFunctionBuilder<o,f>	addManagedFunction(java.lang.String functionName, ManagedFunctionFactory<o,f> managedFunctionFactory)	Creates the ManagedObjectFunctionBuilder to build a ManagedFunction.
void	addStartupFunction(java.lang.String functionName, java.lang.Object parameter)	Adds a ManagedFunction to invoke on start up of the Office.
ManagedObjectStartupCompletion	createStartupCompletion()	Creates a ManagedObjectStartupCompletion.
java.lang.String[]	flagInitOver(ManagedObjectFunctionEnhancer[] enhancers)	Indicates that the ManagedObjectSource.init(ManagedObjectSourceContext) method has completed.
ManagedObjectPoolConfiguration	getDefaultManagedObjectPoolConfiguration()	Obtains the default ManagedObjectPoolConfiguration.
ManagedObjectSourceFlow	getFlow(int flowIndex)	Obtains the ManagedObjectSourceFlow.
ManagedObjectSourceFlow	getFlow(F key)	Obtains the ManagedObjectSourceFlow.
ManagedObjectSourceContextImpl.ManagedObjectFunctionDependencyImpl[]	getManagedObjectFunctionDependencies()	Obtains the ManagedObjectSourceContextImpl.ManagedObjectFunctionDependencyImpl instances.
<O extends java.lang.Enum<O>,f extends java.lang.Enum<f>> ManagedObjectFunctionBuilder<O,f>	getRecycleFunction(ManagedFunctionFactory<O,f> managedFunctionFactory)	Invoking this method during the ManagedObjectSource.init(ManagedObjectSourceContext) will create recycle functionality for the ManagedObject to be returned to a ManagedObjectPool.
java.lang.String	getRecycleFunctionName()	Obtains the name of the ManagedFunction to recycle this ManagedObject.
ManagedObjectServiceReady[]	getServiceReadiness()	Obtains the ManagedObjectServiceReady instances.
ManagedFunctionInvocation[]	getStartupFunctions()	Obtains the startup ManagedFunctionInvocation instances.
ManagedObjectPoolBuilder	setDefaultManagedObjectPool(ManagedObjectPoolFactory managedObjectPoolFactory)	Specifies the default ManagedObjectPool.

Methods inherited from class net.officefloor.frame.impl.construct.source.SourceContextImpl

getClassLoader, getClock, getLogger, getName, getOptionalResource, getProfiles, getResource, isLoadingType, loadClass, loadOptionalClass, loadOptionalService, loadOptionalServices, loadService, loadService, loadServices

Methods inherited from class net.officefloor.frame.impl.construct.source.SourcePropertiesImpl

addProperty, getProperties, getProperty, getProperty, getPropertyNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.api.source.SourceContext

getClassLoader, getClock, getLogger, getName, getOptionalResource, getProfiles, getResource, isLoadingType, loadClass, loadOptionalClass, loadOptionalService, loadOptionalServices, loadService, loadService, loadServices

Methods inherited from interface net.officefloor.frame.api.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Field Detail

MANAGED_OBJECT_RECYCLE_FUNCTION_NAME

public static final java.lang.String MANAGED_OBJECT_RECYCLE_FUNCTION_NAME

Name of the recycle the ManagedFunction.

See Also:

Constant Field Values

Constructor Detail

ManagedObjectSourceContextImpl

public ManagedObjectSourceContextImpl(java.lang.String managedObjectSourceName,
                                      boolean isLoadingType,
                                      java.lang.String managedObjectName,
                                      ManagingOfficeConfiguration<F> managingOfficeConfiguration,
                                      java.lang.String[] additionalProfiles,
                                      SourceProperties properties,
                                      SourceContext sourceContext,
                                      ManagingOfficeBuilder<F> managingOfficeBuilder,
                                      OfficeBuilder officeBuilder,
                                      java.lang.Object startupNotify)

Initiate.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

isLoadingType - Indicates if loading type.

managedObjectName - Name of the ManagedObject.

managingOfficeConfiguration - ManagingOfficeConfiguration.

additionalProfiles - Additional profiles.

properties - Properties.

sourceContext - Delegate SourceContext.

managingOfficeBuilder - ManagingOfficeBuilder.

officeBuilder - OfficeBuilder for the office using the ManagedObjectSource.

startupNotify - Object to notify on start up completion.

Method Detail

flagInitOver

public java.lang.String[] flagInitOver(ManagedObjectFunctionEnhancer[] enhancers)

Indicates that the ManagedObjectSource.init(ManagedObjectSourceContext) method has completed.

Parameters:

enhancers - ManagedObjectFunctionEnhancer instances.

Returns:

Listing of issues in sourcing the ManagedObjectSource.

getDefaultManagedObjectPoolConfiguration

public ManagedObjectPoolConfiguration getDefaultManagedObjectPoolConfiguration()

Obtains the default ManagedObjectPoolConfiguration.

Returns:

Default ManagedObjectPoolConfiguration. May be null if no default ManagedObjectPool.

getRecycleFunctionName

public java.lang.String getRecycleFunctionName()

Obtains the name of the ManagedFunction to recycle this ManagedObject.

Returns:

Name of the ManagedFunction to recycle this ManagedObject or null if no recycling of this ManagedObject.

getManagedObjectFunctionDependencies

public ManagedObjectSourceContextImpl.ManagedObjectFunctionDependencyImpl[] getManagedObjectFunctionDependencies()

Obtains the ManagedObjectSourceContextImpl.ManagedObjectFunctionDependencyImpl instances.

Returns:

ManagedObjectSourceContextImpl.ManagedObjectFunctionDependencyImpl instances.

getStartupFunctions

public ManagedFunctionInvocation[] getStartupFunctions()

Obtains the startup ManagedFunctionInvocation instances.

Returns:

Startup ManagedFunctionInvocation instances.

getServiceReadiness

public ManagedObjectServiceReady[] getServiceReadiness()

Obtains the ManagedObjectServiceReady instances.

Returns:

ManagedObjectServiceReady instances.

setDefaultManagedObjectPool

public ManagedObjectPoolBuilder setDefaultManagedObjectPool(ManagedObjectPoolFactory managedObjectPoolFactory)

Description copied from interface: ManagedObjectSourceContext

Specifies the default ManagedObjectPool.

This may be overridden by ManagedObjectBuilder configuration, however allows for a default ManagedObjectPool should one not be configured.

Specified by:

setDefaultManagedObjectPool in interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>

Parameters:

managedObjectPoolFactory - ManagedObjectPoolFactory for the default ManagedObjectPool.

Returns:

ManagedObjectPoolBuilder.

getRecycleFunction

public <O extends java.lang.Enum<O>,f extends java.lang.Enum<f>> ManagedObjectFunctionBuilder<O,f> getRecycleFunction(ManagedFunctionFactory<O,f> managedFunctionFactory)

Description copied from interface: ManagedObjectSourceContext

Invoking this method during the ManagedObjectSource.init(ManagedObjectSourceContext) will create recycle functionality for the ManagedObject to be returned to a ManagedObjectPool.

The initial ManagedFunction will be used as the recycle starting point for this ManagedObject.

Specified by:

getRecycleFunction in interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>

Type Parameters:

O - Dependency key type.

f - Flow key type.

Parameters:

managedFunctionFactory - ManagedFunctionFactory to create the recycle ManagedFunction.

Returns:

ManagedObjectFunctionBuilder to recycle this ManagedObject.

addManagedFunction

public <o extends java.lang.Enum<o>,f extends java.lang.Enum<f>> ManagedObjectFunctionBuilder<o,f> addManagedFunction(java.lang.String functionName,
                                                                                                                                  ManagedFunctionFactory<o,f> managedFunctionFactory)

Description copied from interface: ManagedObjectSourceContext

Creates the ManagedObjectFunctionBuilder to build a ManagedFunction.

Specified by:

addManagedFunction in interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>

Type Parameters:

o - Dependency key type.

f - Flow key type.

Parameters:

functionName - Name of the ManagedFunction.

managedFunctionFactory - ManagedFunctionFactory to create the ManagedFunction.

Returns:

Specific ManagedObjectFunctionBuilder.

addFunctionDependency

public ManagedObjectFunctionDependency addFunctionDependency(java.lang.String name,
                                                             java.lang.Class<?> objectType)

Description copied from interface: ManagedObjectSourceContext

Adds a ManagedObjectFunctionDependency.

Specified by:

addFunctionDependency in interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>

Parameters:

name - Name of the ManagedObjectFunctionDependency.

objectType - Object type.

Returns:

ManagedObjectFunctionDependency.

createStartupCompletion

public ManagedObjectStartupCompletion createStartupCompletion()

Description copied from interface: ManagedObjectSourceContext

Creates a ManagedObjectStartupCompletion.

Specified by:

createStartupCompletion in interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>

Returns:

New ManagedObjectStartupCompletion that must be completed before OfficeFloor servicing.

addStartupFunction

public void addStartupFunction(java.lang.String functionName,
                               java.lang.Object parameter)

Description copied from interface: ManagedObjectSourceContext

Adds a ManagedFunction to invoke on start up of the Office.

The ManagedFunction must be registered by this ManagedObjectSource.

Specified by:

addStartupFunction in interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>

Parameters:

functionName - Name of ManagedFunction registered by this ManagedObjectSource.

parameter - Parameter for the ManagedFunction. Typically the parameter will contain any created ManagedObjectStartupCompletion to enable indicating when startup is complete.

getFlow

public ManagedObjectSourceFlow getFlow(F key)

Description copied from interface: ManagedObjectSourceContext

Obtains the ManagedObjectSourceFlow.

Specified by:

getFlow in interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>

Parameters:

key - Key identifying Flow being invoked by the ManagedObjectSource.

Returns:

ManagedObjectSourceFlow for the key.

getFlow

public ManagedObjectSourceFlow getFlow(int flowIndex)

Description copied from interface: ManagedObjectSourceContext

Obtains the ManagedObjectSourceFlow.

Specified by:

getFlow in interface ManagedObjectSourceContext<F extends java.lang.Enum<F>>

Parameters:

flowIndex - Index identifying the Flow.

Returns:

ManagedObjectSourceFlow for the index.