Package net.officefloor.frame.internal.configuration

Interface ManagedObjectSourceConfiguration<F extends Enum<F>,MS extends ManagedObjectSource<?,F>>

All Known Implementing Classes:

ManagedObjectBuilderImpl

public interface ManagedObjectSourceConfiguration<F extends Enum<F>,MS extends ManagedObjectSource<?,F>>

Configuration of a ManagedObjectSource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
String[]	getAdditionalProfiles()	Obtains the additional profiles.
ManagedObjectFunctionEnhancer[]	getManagedObjectFunctionEnhancers()	Obtains the ManagedObjectFunctionEnhancer instances.
ManagedObjectPoolConfiguration	getManagedObjectPoolConfiguration()	Obtains the ManagedObjectPoolConfiguration for this ManagedObjectSource.
MS	getManagedObjectSource()	Obtains the ManagedObjectSource instance to use.
Class<MS>	getManagedObjectSourceClass()	Obtains the Class of the ManagedObjectSource.
String	getManagedObjectSourceName()	Obtains the name of this ManagedObjectSource.
ManagingOfficeConfiguration<F>	getManagingOfficeConfiguration()	Obtains the ManagingOfficeConfiguration detailing the Office responsible for managing this ManagedObjectSource.
SourceProperties	getProperties()	Obtains the SourceProperties to initialise the ManagedObjectSource.
String[]	getStartupAfter()	Obtains the names of the ManagedObjectSource to start up after.
String[]	getStartupBefore()	Obtains the names of the ManagedObjectSource to start up before.
long	getTimeout()	Obtains the timeout to: to source the ManagedObject have asynchronous operations on the ManagedObject complete

Method Details

getManagedObjectSourceName

String getManagedObjectSourceName()

Obtains the name of this ManagedObjectSource.

Returns:

Name of this ManagedObjectSource.

getManagedObjectSource

MS getManagedObjectSource()

Obtains the ManagedObjectSource instance to use.

Returns:

ManagedObjectSource instance to use. This may be null and therefore the getManagedObjectSourceClass() should be used to obtain the ManagedObjectSource.

getManagedObjectSourceClass

Class<MS> getManagedObjectSourceClass()

Obtains the Class of the ManagedObjectSource.

Returns:

Class of the ManagedObjectSource. Will be null if a ManagedObjectSource instance is configured.

getAdditionalProfiles

String[] getAdditionalProfiles()

Obtains the additional profiles.

Returns:

Additional profiles.

getProperties

SourceProperties getProperties()

Obtains the SourceProperties to initialise the ManagedObjectSource.

Returns:

SourceProperties to initialise the ManagedObjectSource.

getManagedObjectFunctionEnhancers

ManagedObjectFunctionEnhancer[] getManagedObjectFunctionEnhancers()

Obtains the ManagedObjectFunctionEnhancer instances.

Returns:

ManagedObjectFunctionEnhancer instances.

getManagingOfficeConfiguration

ManagingOfficeConfiguration<F> getManagingOfficeConfiguration()

Obtains the ManagingOfficeConfiguration detailing the Office responsible for managing this ManagedObjectSource.

Returns:

ManagingOfficeConfiguration.

getManagedObjectPoolConfiguration

ManagedObjectPoolConfiguration getManagedObjectPoolConfiguration()

Obtains the ManagedObjectPoolConfiguration for this ManagedObjectSource.

Returns:

ManagedObjectPoolConfiguration for this ManagedObjectSource or null if not to be pooled.

getTimeout

long getTimeout()

Obtains the timeout to:

1. to source the ManagedObject
2. have asynchronous operations on the ManagedObject complete

Returns:

Timeout.

getStartupBefore

String[] getStartupBefore()

Obtains the names of the ManagedObjectSource to start up before.

Returns:

Names of the ManagedObjectSource to start up before.

getStartupAfter

String[] getStartupAfter()

Obtains the names of the ManagedObjectSource to start up after.

Returns:

Names of the ManagedObjectSource to start up after.