Class DatabaseConnection

All Implemented Interfaces:
AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent
Direct Known Subclasses:
FailoverJdbcConnection, JdbcConnection, JdbcPooledConnectionImpl

public abstract class DatabaseConnection extends AllowsRetriesConnection

Abstract class containing configuration for JDBC Connection classes.

  • Constructor Details

    • DatabaseConnection

      public DatabaseConnection()
  • Method Details

    • prepareConnection

      protected void prepareConnection() throws CoreException
      Specified by:
      prepareConnection in class AdaptrisConnectionImp
      Throws:
      CoreException
    • initConnection

      protected final void initConnection() throws CoreException

      Initialisation ensures that the configured driver implementation is available for use. It does not perform connection verification. This is done by start or upon the first call to prepareStatement()

      Specified by:
      initConnection in class AdaptrisConnectionImp
      Throws:
      CoreException - if the driver implementation was not available.
    • loadDriverClass

      protected static void loadDriverClass(String clazz)
    • startConnection

      protected final void startConnection() throws CoreException

      Starting this connection means that an initial attempt is made to connect to the database. The connection could previously have been started by a call to getConnection

      Specified by:
      startConnection in class AdaptrisConnectionImp
      Throws:
      CoreException - if the connection could not be started.
      See Also:
    • stopConnection

      protected final void stopConnection()
      Description copied from class: AdaptrisConnectionImp
      Stop the underlying connection.
      Specified by:
      stopConnection in class AdaptrisConnectionImp
      See Also:
    • closeConnection

      protected final void closeConnection()
      Description copied from class: AdaptrisConnectionImp
      Close the underlying connection.
      Specified by:
      closeConnection in class AdaptrisConnectionImp
    • setAutoCommit

      public void setAutoCommit(Boolean b)

      Sets whether to auto-commit.

      Parameters:
      b - whether to auto-commit; default is true.
    • getAutoCommit

      public Boolean getAutoCommit()

      Returns whether to auto-commit.

      Returns:
      whether to auto-commit
    • autoCommit

      public boolean autoCommit()
    • setDebugMode

      public void setDebugMode(Boolean dbg)

      Set this connection's debug mode.

      In debug mode there is additional logging for reconnection attempts.

      Parameters:
      dbg - this connection's debug mode
    • getDebugMode

      public Boolean getDebugMode()

      Returns this connection's debug mode.

      Returns:
      this connection's debug mode
    • debugMode

      public boolean debugMode()
    • asDataSource

      public DataSource asDataSource() throws SQLException
      Expose this DatabaseConnection as a DataSource
      Returns:
      a DataSource implementation
      Throws:
      SQLException
      See Also:
    • connect

      public final Connection connect() throws SQLException

      Returns the underlying SQLConnection.

      Returns:
      the underlying SQLConnection
      Throws:
      SQLException - if the connection was not valid, and reconnection failed
    • makeConnection

      protected abstract Connection makeConnection() throws SQLException

      Make the connection.

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

      Returns:
      a java.sql.Connection
      Throws:
      SQLException - if the connection could not be made.
      See Also:
    • initialiseDatabaseConnection

      protected abstract void initialiseDatabaseConnection() throws CoreException

      Initialise the underlying database connection.

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

      Throws:
      CoreException - wrapping any underlying exception.
    • startDatabaseConnection

      protected abstract void startDatabaseConnection() throws CoreException

      Initialise the underlying database connection.

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

      Throws:
      CoreException - wrapping any underlying exception.
    • stopDatabaseConnection

      protected abstract void stopDatabaseConnection()

      Initialise the underlying database connection.

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

    • closeDatabaseConnection

      protected abstract void closeDatabaseConnection()

      Initialise the underlying database connection.

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

    • getConnectionName

      protected abstract String getConnectionName()

      Returns a name for this connection for logging purposes.

      Returns:
      a name for this connection for logging purposes
    • checkInternalState

      protected void checkInternalState() throws SQLException
      Throws:
      SQLException
    • setAlwaysValidateConnection

      public void setAlwaysValidateConnection(Boolean b)

      Set whether to always validate the database connection.

      Validating the connection means that the test-statement is executed every time connect() is invoked. Depending on the test statement in question this might have an impact upon performance.

      Parameters:
      b - whether to always validate the database connection; defaults to false.
    • getAlwaysValidateConnection

      public Boolean getAlwaysValidateConnection()

      Returns whether to always validate the database connection.

      Returns:
      whether to always validate the database connection
    • alwaysValidateConnection

      public boolean alwaysValidateConnection()
    • equals

      public abstract boolean equals(Object o)

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

      Overrides:
      equals in class Object
      See Also:
    • hashCode

      public abstract int hashCode()

      Force implementations to over-ride hashcode.

      Overrides:
      hashCode in class Object
      See Also:
    • getUsername

      public String getUsername()
    • setUsername

      public void setUsername(String s)
      Set the username used to access the database.
      Parameters:
      s -
    • getPassword

      public String getPassword()
    • setPassword

      public void setPassword(String s)
      Set the password used to access the database.
      Parameters:
      s - the password which might be encoded using an available password scheme from Password
    • getConnectionProperties

      public KeyValuePairSet getConnectionProperties()
      Get any additional connection properties that have been configured.
      Returns:
      any additional properties
    • setConnectionProperties

      public void setConnectionProperties(KeyValuePairSet p)
      Set any additional connection properties.

      If additional connection properties are set, then any configured username/password will be applied to the connection properties against the key 'user' and 'password' respectively. If you have configured thos properties in the connection-properties element, then make sure that you do not configure setUsername(String) or setPassword(String).

      Parameters:
      p - any additional properties over and above username/password.
    • connectionProperties

      protected Properties connectionProperties() throws PasswordException
      Throws:
      PasswordException