Package net.officefloor.frame.api.managedobject.source

Interface ManagedObjectSource<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

All Known Implementing Classes:

AbstractAsyncManagedObjectSource, AbstractHttpServerImplementationTestCase.CancelConnectionManagedObjectSource, AbstractJdbcManagedObjectSource, AbstractManagedObjectSource, AccessControlManagedObjectSource, ApplicationContextManagedObjectSource, AuthenticationContextManagedObjectSource, AuthenticationManagedObjectSource, ClassManagedObjectSource, ConnectionManagedObjectSource, CosmosAsyncClientManagedObjectSource, CosmosAsyncDatabaseManagedObjectSource, CosmosAsyncEntitiesManagedObjectSource, CosmosClientManagedObjectSource, CosmosDatabaseManagedObjectSource, CosmosEntitiesManagedObjectSource, DataNucleusJpaManagedObjectSource, DataSourceManagedObjectSource, DefaultHttpAccessControlManagedObjectSource, DefaultHttpAuthenticationManagedObjectSource, DynamoDbMapperManagedObjectSource, FlatXmlUnmarshallerManagedObjectSource, FlywayManagedObjectSource, FlywayMigrateManagedObjectSource, GoogleIdTokenVerifierManagedObjectSource, H2DataSourceManagedObjectSource, H2ReadOnlyConnectionManagedObjectSource, HibernateJpaManagedObjectSource, HttpAccessControlManagedObjectSource, HttpApplicationObjectManagedObjectSource, HttpApplicationStateManagedObjectSource, HttpArgumentManagedObjectSource, HttpAuthenticationManagedObjectSource, HttpChallengeContextManagedObjectSource, HttpObjectManagedObjectSource, HttpRequestObjectManagedObjectSource, HttpRequestStateManagedObjectSource, HttpResourceCacheManagedObjectSource, HttpResourceStoreManagedObjectSource, HttpSecurityExecuteManagedObjectSource, HttpSecurityManagedObjectAdapterSource, HttpServerSocketManagedObjectSource, HttpSessionManagedObjectSource, HttpSessionObjectManagedObjectSource, InMemoryJwtAuthorityRepositoryManagedObjectSource, InMemoryJwtAuthorityRepositoryManagedObjectSource, JndiLdapManagedObjectSource, JpaManagedObjectSource, JwtAuthorityManagedObjectSource, JwtClaimsManagedObjectSource, ManagedObjectLoaderUtil.CollectMetaDataContextManagedObjectSource, MockCredentialStoreManagedObjectSource, MockManagedObjectSource, ObjectResponseManagedObjectSource, PasswordFileManagedObjectSource, PayPalHttpClientManagedObjectSource, PostgreSqlDataSourceManagedObjectSource, PostgreSqlReadOnlyConnectionManagedObjectSource, R2dbcManagedObjectSource, ReadOnlyConnectionManagedObjectSource, ServletServicerManagedObjectSource, Singleton, SpringBeanManagedObjectSource, TestManagedObject.TestManagedObjectSource, TreeXmlMarshallerManagedObjectSource, TreeXmlUnmarshallerManagedObjectSource, VariableManagedObjectSource, WebClientManagedObjectSource

public interface ManagedObjectSource<O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Source to obtain a particular type of ManagedObject.

Implemented by the ManagedObject provider.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
ManagedObjectSourceSpecification	getSpecification()	Obtains the specification for this.
ManagedObjectSourceMetaData<O,F>	init(ManagedObjectSourceContext<F> context)	Initialises the ManagedObjectSource.
void	sourceManagedObject(ManagedObjectUser user)	Sources a ManagedObject from this ManagedObjectSource.
void	start(ManagedObjectExecuteContext<F> context)	Called once after init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.
void	stop()	Called to notify that the OfficeFloor is being closed.

Method Detail

getSpecification

ManagedObjectSourceSpecification getSpecification()

Obtains the specification for this.

This will be called before any other methods, therefore this method must be able to return the specification immediately after a default constructor instantiation.

Returns:

Specification of this.

init

ManagedObjectSourceMetaData<O,F> init(ManagedObjectSourceContext<F> context)
                                     throws java.lang.Exception

Initialises the ManagedObjectSource.

Parameters:

context - ManagedObjectSourceContext to use in initialising.

Returns:

Meta-data to describe this.

Throws:

java.lang.Exception - Should the ManagedObjectSource fail to configure itself from the input properties.

start

void start(ManagedObjectExecuteContext<F> context)
    throws java.lang.Exception

Called once after init(ManagedObjectSourceContext) to indicate this ManagedObjectSource should start execution.

On invocation of this method, ProcessState instances may be invoked via the ManagedObjectExecuteContext.

Parameters:

context - ManagedObjectExecuteContext to use in starting this ManagedObjectSource.

Throws:

java.lang.Exception - Should the ManagedObjectSource fail to start execution.

sourceManagedObject

void sourceManagedObject(ManagedObjectUser user)

Sources a ManagedObject from this ManagedObjectSource.

Parameters:

user - ManagedObjectUser interested in using the ManagedObject.

stop

void stop()

Called to notify that the OfficeFloor is being closed.

On return from this method, no further ProcessState instances may be invoked.