Package com.adaptris.core.jdbc

Class JdbcConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.core.AllowsRetriesConnection

com.adaptris.core.jdbc.DatabaseConnection

com.adaptris.core.jdbc.JdbcConnection

All Implemented Interfaces:

AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent

@ComponentProfile(summary="Connect to a database using a JDBC driver",
                  tag="connections,jdbc")
public class JdbcConnection
extends DatabaseConnection

Implementation of AdaptrisConnectionImp for JDBC.

In the adapter configuration file this class is aliased as jdbc-connection which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisConnectionImp

log

Constructor Summary

Constructors

Constructor	Description
JdbcConnection()
JdbcConnection(java.lang.String url, java.lang.String driver)	Convenience constructor.

Method Summary

Modifier and Type	Method	Description
protected void	closeDatabaseConnection()	Initialise the underlying database connection.
boolean	equals(java.lang.Object o)	Force implementations to over-ride equals with a semantic implementation.
protected java.lang.String	getConnectionName()	Returns a name for this connection for logging purposes.
java.lang.String	getConnectUrl()	Returns the connection string to use for this JDBC source.
int	hashCode()	Force implementations to over-ride hashcode.
protected void	initialiseDatabaseConnection()	Initialise the underlying database connection.
protected java.sql.Connection	makeConnection()	Make the connection.
void	setConnectUrl(java.lang.String s)	Sets the connection string to use for this JDBC source.
protected void	startDatabaseConnection()	Initialise the underlying database connection.
protected void	stopDatabaseConnection()	Initialise the underlying database connection.

Methods inherited from class com.adaptris.core.jdbc.DatabaseConnection

alwaysValidateConnection, asDataSource, autoCommit, checkInternalState, closeConnection, connect, connectionProperties, debugMode, getAlwaysValidateConnection, getAutoCommit, getConnectionProperties, getDebugMode, getDriverImp, getPassword, getUsername, initConnection, loadDriverClass, prepareConnection, setAlwaysValidateConnection, setAutoCommit, setConnectionProperties, setDebugMode, setDriverImp, setPassword, setUsername, startConnection, stopConnection

Methods inherited from class com.adaptris.core.AllowsRetriesConnection

connectionAttempts, connectionRetryInterval, createLoggingStatement, getConnectionAttempts, getConnectionRetryInterval, logWarning, setConnectionAttempts, setConnectionRetryInterval

Methods inherited from class com.adaptris.core.AdaptrisConnectionImp

addExceptionListener, addMessageConsumer, addMessageProducer, changeState, cloneForTesting, close, connectionErrorHandler, getConnectionErrorHandler, getUniqueId, getWorkersFirstOnShutdown, init, prepare, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setUniqueId, setWorkersFirstOnShutdown, start, stop, workersFirstOnShutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcConnection

public JdbcConnection()

JdbcConnection

public JdbcConnection(java.lang.String url,
                      java.lang.String driver)

Convenience constructor.

Parameters:

url - the URL.

driver - the JDBC driver.

Method Detail

initialiseDatabaseConnection

protected void initialiseDatabaseConnection()
                                     throws CoreException

Description copied from class: DatabaseConnection

Initialise the underlying database connection.

This abstract method should be implemented by concrete sub-classes to initialise any components other than the DriverManager.

Specified by:

initialiseDatabaseConnection in class DatabaseConnection

Throws:

CoreException - wrapping any underlying exception.

See Also:

DatabaseConnection.initialiseDatabaseConnection()

startDatabaseConnection

protected void startDatabaseConnection()
                                throws CoreException

Description copied from class: DatabaseConnection

Initialise the underlying database connection.

This abstract method should be implemented by concrete sub-classes to initialise any components other than the DriverManager.

Specified by:

startDatabaseConnection in class DatabaseConnection

Throws:

CoreException - wrapping any underlying exception.

See Also:

DatabaseConnection.startDatabaseConnection()

stopDatabaseConnection

protected void stopDatabaseConnection()

Description copied from class: DatabaseConnection

Initialise the underlying database connection.

This abstract method should be implemented by concrete sub-classes to stop any components other than the DriverManager.

Specified by:

stopDatabaseConnection in class DatabaseConnection

See Also:

DatabaseConnection.stopDatabaseConnection()

closeDatabaseConnection

protected void closeDatabaseConnection()

Description copied from class: DatabaseConnection

Initialise the underlying database connection.

This abstract method should be implemented by concrete sub-classes to close any components.

Specified by:

closeDatabaseConnection in class DatabaseConnection

makeConnection

protected java.sql.Connection makeConnection()
                                      throws java.sql.SQLException

Description copied from class: DatabaseConnection

Make the connection.

This abstract method should be implemented by concrete sub-classes to make or check the current connection to the Jdbc source.

Specified by:

makeConnection in class DatabaseConnection

Returns:

a java.sql.Connection

Throws:

java.sql.SQLException - if the connection could not be made.

See Also:

DatabaseConnection.makeConnection()

getConnectUrl

public java.lang.String getConnectUrl()

Returns the connection string to use for this JDBC source.

Returns:

the connection string to use for this JDBC source

setConnectUrl

public void setConnectUrl(java.lang.String s)

Sets the connection string to use for this JDBC source.

Parameters:

s - the connection string to use for this JDBC source

equals

public boolean equals(java.lang.Object o)

Description copied from class: DatabaseConnection

Force implementations to over-ride equals with a semantic implementation.

Specified by:

equals in class DatabaseConnection

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Description copied from class: DatabaseConnection

Force implementations to over-ride hashcode.

Specified by:

hashCode in class DatabaseConnection

See Also:

Object.hashCode()

getConnectionName

protected java.lang.String getConnectionName()

Description copied from class: DatabaseConnection

Returns a name for this connection for logging purposes.

Specified by:

getConnectionName in class DatabaseConnection

Returns:

a name for this connection for logging purposes

See Also:

DatabaseConnection.getConnectionName()