Package org.opencms.db

Class CmsSqlManager

java.lang.Object
org.opencms.db.CmsSqlManager
Direct Known Subclasses:
CmsSqlManager
public class CmsSqlManager extends Object
Superclass for all SQL manager implementations.

Since:
6.0.0

  • Constructor Details

    • CmsSqlManager

      protected CmsSqlManager()
      Protected constructor to allow only subclassing.

    • CmsSqlManager

      protected CmsSqlManager(CmsDriverManager driverManager)
      Creates a new SQL manager from the provided driver manager.

      Parameters:
      driverManager - the low level database driver manager

  • Method Details

    • getActiveConnections

      public int getActiveConnections(String dbPoolUrl) throws CmsDbException
      Returns the number of active connections managed by a pool.

      Parameters:
      dbPoolUrl - the url of a pool
      Returns:
      the number of active connections
      Throws:
      CmsDbException - if something goes wrong

    • getConnection

      public Connection getConnection(String dbPoolName) throws SQLException
      Returns a connection to the database using the given pool identified by its name.

      Parameters:
      dbPoolName - the pool name
      Returns:
      a database connection
      Throws:
      SQLException - if something goes wrong

    • getConnectionByUrl

      public Connection getConnectionByUrl(String dbPoolUrl) throws SQLException
      Returns a connection to the database using the given pool identified by its full url.

      Parameters:
      dbPoolUrl - the pool url
      Returns:
      a database connection
      Throws:
      SQLException - if something goes wrong

    • getDbPoolUrls

      public List<String> getDbPoolUrls()
      Returns a list of available database connection pool names.

      Returns:
      a list of database connection pool names

    • getDefaultDbPoolName

      public String getDefaultDbPoolName()
      Returns the name of the default database connection pool.

      Returns:
      the name of the default database connection pool

    • getIdleConnections

      public int getIdleConnections(String dbPoolUrl) throws CmsDbException
      Returns the number of idle connections managed by a pool.

      Parameters:
      dbPoolUrl - the url of a pool
      Returns:
      the number of idle connections
      Throws:
      CmsDbException - if something goes wrong