Package net.officefloor.jdbc

Class AbstractConnectionManagedObjectSource

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.AbstractConnectionManagedObjectSource

All Implemented Interfaces:

ManagedObjectSource<None,None>

Direct Known Subclasses:

ConnectionManagedObjectSource, DataSourceManagedObjectSource, ReadOnlyConnectionManagedObjectSource

public abstract class AbstractConnectionManagedObjectSource
extends AbstractManagedObjectSource<None,None>

Abstract ManagedObjectSource for Connection.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_DATA_SOURCE_FACTORY	Property name to specify the DataSourceFactory implementation.
static java.lang.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
AbstractConnectionManagedObjectSource()

Method Summary

Modifier and Type	Method	Description
protected void	closeDataSource(javax.sql.DataSource dataSource, java.util.logging.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 abstract void	loadFurtherMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)	Enables overriding to load further meta-data.
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 javax.sql.ConnectionPoolDataSource	newConnectionPoolDataSource(SourceContext context)	Creates the ConnectionPoolDataSource.
protected javax.sql.DataSource	newDataSource(SourceContext context)	Creates the DataSource.
void	setConnectivity(AbstractConnectionManagedObjectSource.ConnectivityFactory connectivityFactory)	Specifies AbstractConnectionManagedObjectSource.ConnectivityFactory for validating connectivity on startup.
protected void	validateConnectivity(java.lang.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 Detail

PROPERTY_DATA_SOURCE_FACTORY

public static final java.lang.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 java.lang.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 Detail

AbstractConnectionManagedObjectSource

public AbstractConnectionManagedObjectSource()

Method Detail

newDataSource

protected final javax.sql.DataSource newDataSource(SourceContext context)
                                            throws java.lang.Exception

Creates the DataSource.

Parameters:

context - SourceContext.

Returns:

Created DataSource.

Throws:

java.lang.Exception - If fails to create the DataSource.

getDataSourceFactory

protected DataSourceFactory getDataSourceFactory(SourceContext context)
                                          throws java.lang.Exception

Allows overriding to configure a different DataSourceFactory.

Parameters:

context - SourceContext.

Returns:

DataSourceFactory.

Throws:

java.lang.Exception - If fails to obtain DataSourceFactory.

newConnectionPoolDataSource

protected final javax.sql.ConnectionPoolDataSource newConnectionPoolDataSource(SourceContext context)
                                                                        throws java.lang.Exception

Creates the ConnectionPoolDataSource.

Parameters:

context - SourceContext.

Returns:

Created ConnectionPoolDataSource.

Throws:

java.lang.Exception - If fails to create the ConnectionPoolDataSource.

getConnectionPoolDataSourceFactory

protected ConnectionPoolDataSourceFactory getConnectionPoolDataSourceFactory(SourceContext context)
                                                                      throws java.lang.Exception

Allows overriding to configure a different ConnectionPoolDataSourceFactory.

Parameters:

context - SourceContext.

Returns:

ConnectionPoolDataSourceFactory.

Throws:

java.lang.Exception - If fails to obtain ConnectionPoolDataSourceFactory.

loadFurtherMetaData

protected abstract void loadFurtherMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)
                                     throws java.lang.Exception

Enables overriding to load further meta-data.

Parameters:

context - AbstractAsyncManagedObjectSource.MetaDataContext.

Throws:

java.lang.Exception - If fails to loader further meta-data.

loadValidateConnectivity

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

Loads validation of connectivity on start up.

Parameters:

context - AbstractAsyncManagedObjectSource.MetaDataContext.

Throws:

java.lang.Exception - If fails to load validation.

setConnectivity

public void setConnectivity(AbstractConnectionManagedObjectSource.ConnectivityFactory connectivityFactory)

Specifies AbstractConnectionManagedObjectSource.ConnectivityFactory for validating connectivity on startup.

Parameters:

connectivityFactory - AbstractConnectionManagedObjectSource.ConnectivityFactory.

validateConnectivity

protected void validateConnectivity(java.lang.String sql)
                             throws java.lang.Exception

Validates connectivity.

Parameters:

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

Throws:

java.lang.Exception - If fails connectivity.

closeDataSource

protected void closeDataSource(javax.sql.DataSource dataSource,
                               java.util.logging.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 java.lang.Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<None,None>

Parameters:

context - Meta-data.

Throws:

java.lang.Exception - If fails to load the meta-data.