001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/db/CmsSqlManager.java,v $
003: * Date : $Date: 2008-02-27 12:05:43 $
004: * Version: $Revision: 1.13 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.db;
033:
034: import java.sql.Connection;
035: import java.sql.DriverManager;
036: import java.sql.SQLException;
037: import java.util.List;
038:
039: /**
040: * Superclass for all SQL manager implementations.<p>
041: *
042: * @author Carsten Weinholz
043: *
044: * @version $Revision: 1.13 $
045: *
046: * @since 6.0.0
047: */
048: public class CmsSqlManager {
049:
050: /** the driver manager. */
051: private CmsDriverManager m_driverManager;
052:
053: /**
054: * Protected constructor to allow only subclassing.<p>
055: */
056: protected CmsSqlManager() {
057:
058: // hides the public constructor
059: }
060:
061: /**
062: * Creates a new SQL manager from the provided driver manager.<p>
063: *
064: * @param driverManager the low level database driver manager
065: */
066: protected CmsSqlManager(CmsDriverManager driverManager) {
067:
068: m_driverManager = driverManager;
069: }
070:
071: /**
072: * Returns the number of active connections managed by a pool.<p>
073: *
074: * @param dbPoolUrl the url of a pool
075: * @return the number of active connections
076: * @throws CmsDbException if something goes wrong
077: */
078: public int getActiveConnections(String dbPoolUrl)
079: throws CmsDbException {
080:
081: return m_driverManager.getActiveConnections(dbPoolUrl);
082: }
083:
084: /**
085: * Returns a connection to the database using the given pool identified by its name.<p>
086: *
087: * @param dbPoolName the pool name
088: * @return a database connection
089: * @throws SQLException if something goes wrong
090: */
091: public Connection getConnection(String dbPoolName)
092: throws SQLException {
093:
094: return getConnectionByUrl(CmsDbPool.DBCP_JDBC_URL_PREFIX
095: + CmsDbPool.OPENCMS_URL_PREFIX + dbPoolName);
096: }
097:
098: /**
099: * Returns a connection to the database using the given pool identified by its full url.<p>
100: *
101: * @param dbPoolUrl the pool url
102: * @return a database connection
103: * @throws SQLException if something goes wrong
104: */
105: public synchronized Connection getConnectionByUrl(String dbPoolUrl)
106: throws SQLException {
107:
108: return DriverManager.getConnection(dbPoolUrl);
109: }
110:
111: /**
112: * Returns a list of available database connection pool names.<p>
113: *
114: * @return a list of database connection pool names
115: */
116: public List getDbPoolUrls() {
117:
118: return CmsDbPool.getDbPoolUrls(m_driverManager
119: .getPropertyConfiguration());
120: }
121:
122: /**
123: * Returns the name of the default database connection pool.<p>
124: *
125: * @return the name of the default database connection pool
126: */
127: public String getDefaultDbPoolName() {
128:
129: return CmsDbPool.getDefaultDbPoolName();
130: }
131:
132: /**
133: * Returns the number of idle connections managed by a pool.<p>
134: *
135: * @param dbPoolUrl the url of a pool
136: * @return the number of idle connections
137: * @throws CmsDbException if something goes wrong
138: */
139: public int getIdleConnections(String dbPoolUrl)
140: throws CmsDbException {
141:
142: return m_driverManager.getIdleConnections(dbPoolUrl);
143: }
144: }
|