Package com.avoka.core.cayenne

Class CoreDataSource

java.lang.Object
com.avoka.core.cayenne.CoreDataSource
All Implemented Interfaces:
Wrapper, CommonDataSource, DataSource
public class CoreDataSource extends Object implements DataSource
Provides a DataSource wrapper for JDBC DataSource interface to enable configuring JDBC query timeouts.

To set the query timeout in seconds the the JVM property com.avoka.core.cayenne.query.timeout.

Since:
4.1.0

  • Constructor Details

    • CoreDataSource

      public CoreDataSource(DataSource dataSource)
      Create a monitored data source given the data source.
      Parameters:
      dataSource - the data source

    • CoreDataSource

      public CoreDataSource(DataSource dataSource, Integer queryTimeout)
      Create a monitored data source given the data source.
      Parameters:
      dataSource - the data source
      queryTimeout - the JDBC statement timeout (seconds)

  • Method Details

    • getConnection

      public Connection getConnection() throws SQLException

      Attempts to establish a connection with the data source that this DataSource object represents.

      Specified by:
      getConnection in interface DataSource
      Returns:
      a connection to the data source
      Throws:
      SQLException - if a database access error occurs

    • getConnection

      public Connection getConnection(String username, String password) throws SQLException

      Attempts to establish a connection with the data source that this DataSource object represents.

      Specified by:
      getConnection in interface DataSource
      Parameters:
      username - the database user on whose behalf the connection is being made
      password - the user's password
      Returns:
      a connection to the data source
      Throws:
      SQLException - if a database access error occurs

    • getLogWriter

      public PrintWriter getLogWriter() throws SQLException

      Retrieves the log writer for this DataSource object.

      The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.Drivermanager class. When a DataSource object is created, the log writer is initially null; in other words, the default is for logging to be disabled.

      Specified by:
      getLogWriter in interface CommonDataSource
      Specified by:
      getLogWriter in interface DataSource
      Returns:
      the log writer for this data source or null if logging is disabled
      Throws:
      SQLException - if a database access error occurs
      See Also:

    • getLoginTimeout

      public int getLoginTimeout() throws SQLException
      Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created, the login timeout is initially zero.
      Specified by:
      getLoginTimeout in interface CommonDataSource
      Specified by:
      getLoginTimeout in interface DataSource
      Returns:
      the data source login time limit
      Throws:
      SQLException - if a database access error occurs.
      See Also:

    • setLogWriter

      public void setLogWriter(PrintWriter out) throws SQLException

      Sets the log writer for this DataSource object to the given java.io.PrintWriter object.

      The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the java.sql.Drivermanager class. When a DataSource object is created the log writer is initially null; in other words, the default is for logging to be disabled.

      Specified by:
      setLogWriter in interface CommonDataSource
      Specified by:
      setLogWriter in interface DataSource
      Parameters:
      out - the new log writer; to disable logging, set to null
      Throws:
      SQLException - if a database access error occurs
      See Also:

    • setLoginTimeout

      public void setLoginTimeout(int seconds) throws SQLException

      Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created, the login timeout is initially zero.

      Specified by:
      setLoginTimeout in interface CommonDataSource
      Specified by:
      setLoginTimeout in interface DataSource
      Parameters:
      seconds - the data source login time limit
      Throws:
      SQLException - if a database access error occurs.
      See Also:

    • unwrap

      public <T> T unwrap(Class<T> iface) throws SQLException
      Unwrap.
      Specified by:
      unwrap in interface Wrapper
      Type Parameters:
      T - the generic type
      Parameters:
      iface - the iface
      Returns:
      the t
      Throws:
      SQLException - the sQL exception
      See Also:

    • isWrapperFor

      public boolean isWrapperFor(Class<?> iface) throws SQLException
      Checks if is wrapper for.
      Specified by:
      isWrapperFor in interface Wrapper
      Parameters:
      iface - the iface
      Returns:
      true, if is wrapper for
      Throws:
      SQLException - the sQL exception
      See Also:

    • getParentLogger

      public Logger getParentLogger() throws SQLFeatureNotSupportedException
      Specified by:
      getParentLogger in interface CommonDataSource
      Returns:
      the parent logger
      Throws:
      SQLFeatureNotSupportedException - if not supported
      See Also: