Package net.officefloor.jdbc

Class AbstractJdbcManagedObjectSource

java.lang.Object

net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource<O,F>

net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource<None,None>

net.officefloor.jdbc.AbstractJdbcManagedObjectSource

All Implemented Interfaces:

ManagedObjectSource<None,None>

Direct Known Subclasses:

DataSourceManagedObjectSource, ReadOnlyConnectionManagedObjectSource

public abstract class AbstractJdbcManagedObjectSource
extends AbstractManagedObjectSource<None,None>

Abstract ManagedObjectSource for Connection.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractJdbcManagedObjectSource.ConnectionConnectivity	Convenient AbstractJdbcManagedObjectSource.Connectivity implementation to wrap a Connection.
static interface	AbstractJdbcManagedObjectSource.Connectivity	Connectivity.
static interface	AbstractJdbcManagedObjectSource.ConnectivityFactory	Factory for AbstractJdbcManagedObjectSource.Connectivity.

Nested classes/interfaces inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

AbstractAsyncManagedObjectSource.DependencyLabeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.ExecutionLabeller, AbstractAsyncManagedObjectSource.Labeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.MetaDataContext<O extends Enum<O>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_DATA_SOURCE_FACTORY	Property name to specify the DataSourceFactory implementation.
static final String	PROPERTY_DATA_SOURCE_VALIDATE_SQL	Property name to specify the SQL to run to validate the DataSource is configured correctly.

Constructor Summary

Constructors

Constructor	Description
AbstractJdbcManagedObjectSource()

Method Summary

Modifier and Type	Method	Description
protected void	closeDataSource(DataSource dataSource, Logger logger)	Closes the DataSource.
protected ConnectionPoolDataSourceFactory	getConnectionPoolDataSourceFactory(SourceContext context)	Allows overriding to configure a different ConnectionPoolDataSourceFactory.
protected DataSourceFactory	getDataSourceFactory(SourceContext context)	Allows overriding to configure a different DataSourceFactory.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)	Overridden to load meta-data.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)	Overridden to load specifications.
protected void	loadValidateConnectivity(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)	Loads validation of connectivity on start up.
protected final ConnectionPoolDataSource	newConnectionPoolDataSource(SourceContext context)	Creates the ConnectionPoolDataSource.
protected final DataSource	newDataSource(SourceContext context)	Creates the DataSource.
void	setConnectivity(AbstractJdbcManagedObjectSource.ConnectivityFactory connectivityFactory)	Specifies AbstractJdbcManagedObjectSource.ConnectivityFactory for validating connectivity on startup.
protected abstract void	setupActive(ManagedObjectSourceContext<None> mosContext)	Sets up the ManagedObjectSource for active use.
protected abstract void	setupMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)	Sets up the meta-data.
protected void	validateConnectivity(String sql)	Validates connectivity.

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource

getManagedObject, sourceManagedObject

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

getSpecification, init, start, stop

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_DATA_SOURCE_FACTORY

public static final String PROPERTY_DATA_SOURCE_FACTORY

Property name to specify the DataSourceFactory implementation.

See Also:

• Constant Field Values

PROPERTY_DATA_SOURCE_VALIDATE_SQL

public static final String PROPERTY_DATA_SOURCE_VALIDATE_SQL

Property name to specify the SQL to run to validate the DataSource is configured correctly.

See Also:

• Constant Field Values

Constructor Details

AbstractJdbcManagedObjectSource

public AbstractJdbcManagedObjectSource()

Method Details

newDataSource

protected final DataSource newDataSource(SourceContext context)
                                  throws Exception

Creates the DataSource.

Parameters:

context - SourceContext.

Returns:

Created DataSource.

Throws:

Exception - If fails to create the DataSource.

getDataSourceFactory

protected DataSourceFactory getDataSourceFactory(SourceContext context)
                                          throws Exception

Allows overriding to configure a different DataSourceFactory.

Parameters:

context - SourceContext.

Returns:

DataSourceFactory.

Throws:

Exception - If fails to obtain DataSourceFactory.

newConnectionPoolDataSource

protected final ConnectionPoolDataSource newConnectionPoolDataSource(SourceContext context)
                                                              throws Exception

Creates the ConnectionPoolDataSource.

Parameters:

context - SourceContext.

Returns:

Created ConnectionPoolDataSource.

Throws:

Exception - If fails to create the ConnectionPoolDataSource.

getConnectionPoolDataSourceFactory

protected ConnectionPoolDataSourceFactory getConnectionPoolDataSourceFactory(SourceContext context)
                                                                      throws Exception

Allows overriding to configure a different ConnectionPoolDataSourceFactory.

Parameters:

context - SourceContext.

Returns:

ConnectionPoolDataSourceFactory.

Throws:

Exception - If fails to obtain ConnectionPoolDataSourceFactory.

setupMetaData

protected abstract void setupMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)
                               throws Exception

Sets up the meta-data.

Parameters:

context - AbstractAsyncManagedObjectSource.MetaDataContext.

Throws:

Exception - If fails to loader further meta-data.

setupActive

protected abstract void setupActive(ManagedObjectSourceContext<None> mosContext)
                             throws Exception

Sets up the ManagedObjectSource for active use.

Parameters:

mosContext - ManagedObjectSourceContext.

Throws:

Exception - If fails to setup.

loadValidateConnectivity

protected void loadValidateConnectivity(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)
                                 throws Exception

Loads validation of connectivity on start up.

Parameters:

context - AbstractAsyncManagedObjectSource.MetaDataContext.

Throws:

Exception - If fails to load validation.

setConnectivity

public void setConnectivity(AbstractJdbcManagedObjectSource.ConnectivityFactory connectivityFactory)

Specifies AbstractJdbcManagedObjectSource.ConnectivityFactory for validating connectivity on startup.

Parameters:

connectivityFactory - AbstractJdbcManagedObjectSource.ConnectivityFactory.

validateConnectivity

protected void validateConnectivity(String sql)
                             throws Exception

Validates connectivity.

Parameters:

sql - Optional SQL to be executed against the Connection. May be null.

Throws:

Exception - If fails connectivity.

closeDataSource

protected void closeDataSource(DataSource dataSource,
 Logger logger)

Closes the DataSource.

Parameters:

dataSource - DataSource to be closed.

logger - Logger.

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<None,None>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<None,None>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.