org.opencms.db

类 CmsDbPool

java.lang.Object

org.opencms.db.CmsDbPool

public final class CmsDbPool
extends java.lang.Object

Various methods to create DBCP pools.

Only JDBC Driver based pools are supported currently. JNDI DataSource based pools might be added probably later.

Please note: This class is subject to change in later versions. To obtain information about the connections, please use the CmsSqlManager.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DBCP_JDBC_URL_PREFIX This prefix is required to make the JDBC DriverManager return pooled DBCP connections.
static java.lang.String	KEY_CONNECT_ATTEMTS Key for number of connection attempts.
static java.lang.String	KEY_CONNECT_WAITS Key for connection waiting.
static java.lang.String	KEY_DATABASE Prefix for database keys.
static java.lang.String	KEY_DATABASE_NAME Key for the database name.
static java.lang.String	KEY_DATABASE_POOL Key for the pool id.
static java.lang.String	KEY_DATABASE_STATEMENTS Key for statement pooling.
static java.lang.String	KEY_ENTITY_MANAGER_POOL_SIZE Key for the entity manager pool size.
static java.lang.String	KEY_JDBC_DRIVER Key for jdbc driver.
static java.lang.String	KEY_JDBC_URL Key for jdbc url.
static java.lang.String	KEY_JDBC_URL_PARAMS Key for jdbc url params.
static java.lang.String	KEY_MAX_ACTIVE Key for maximum active connections.
static java.lang.String	KEY_MAX_IDLE Key for maximum idle connections.
static java.lang.String	KEY_MAX_WAIT Key for maximum wait time.
static java.lang.String	KEY_MIN_EVICTABLE_IDLE_TIME Key for minimum idle time before a connection is subject to an eviction test.
static java.lang.String	KEY_MIN_IDLE Key for minimum number of connections kept open.
static java.lang.String	KEY_NUM_TESTS_PER_EVICTION_RUN Key for number of tested connections per run.
static java.lang.String	KEY_PASSWORD Key for database password.
static java.lang.String	KEY_POOL_DEFAULT Key for default.
static java.lang.String	KEY_POOL_URL Key for pool url.
static java.lang.String	KEY_POOL_USER Key for pool user.
static java.lang.String	KEY_POOL_VFS Key for vfs pool.
static java.lang.String	KEY_POOLING Key for pooling flag.
static java.lang.String	KEY_TEST_ON_BORROW Key for test on borrow flag.
static java.lang.String	KEY_TEST_QUERY Key for test query.
static java.lang.String	KEY_TEST_WHILE_IDLE Key for test while idle flag.
static java.lang.String	KEY_TIME_BETWEEN_EVICTION_RUNS Key for time between two eviction runs.
static java.lang.String	KEY_USERNAME Key for user name.
static java.lang.String	KEY_WHEN_EXHAUSTED_ACTION Key for "when pool exhausted" action.
static java.lang.String	OPENCMS_DEFAULT_POOL_NAME The name of the opencms default pool.
static java.lang.String	OPENCMS_DEFAULT_POOL_URL The default OpenCms JDBC pool URL.
static java.lang.String	OPENCMS_URL_PREFIX The prefix used for opencms JDBC pools.

方法概要

方法

限定符和类型	方法和说明
static org.apache.commons.dbcp.PoolingDriver	createDriverManagerConnectionPool(CmsParameterConfiguration config, java.lang.String key) Creates a JDBC DriverManager based DBCP connection pool.
static java.lang.String	getDbPoolName(CmsParameterConfiguration configuration, java.lang.String key) Returns the database pool name for a given configuration key.
static java.util.List<java.lang.String>	getDbPoolUrls(CmsParameterConfiguration configuration) Returns a list of available database pool names.
static java.lang.String	getDefaultDbPoolName() Returns the name of the default database connection pool.

从类继承的方法 java.lang.Object

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

字段详细资料

DBCP_JDBC_URL_PREFIX

public static final java.lang.String DBCP_JDBC_URL_PREFIX

This prefix is required to make the JDBC DriverManager return pooled DBCP connections.

另请参阅:

常量字段值

KEY_CONNECT_ATTEMTS

public static final java.lang.String KEY_CONNECT_ATTEMTS

Key for number of connection attempts.

另请参阅:

常量字段值

KEY_CONNECT_WAITS

public static final java.lang.String KEY_CONNECT_WAITS

Key for connection waiting.

另请参阅:

常量字段值

KEY_DATABASE

public static final java.lang.String KEY_DATABASE

Prefix for database keys.

另请参阅:

常量字段值

KEY_DATABASE_NAME

public static final java.lang.String KEY_DATABASE_NAME

Key for the database name.

另请参阅:

常量字段值

KEY_DATABASE_POOL

public static final java.lang.String KEY_DATABASE_POOL

Key for the pool id.

另请参阅:

常量字段值

KEY_DATABASE_STATEMENTS

public static final java.lang.String KEY_DATABASE_STATEMENTS

Key for statement pooling.

另请参阅:

常量字段值

KEY_ENTITY_MANAGER_POOL_SIZE

public static final java.lang.String KEY_ENTITY_MANAGER_POOL_SIZE

Key for the entity manager pool size.

另请参阅:

常量字段值

KEY_JDBC_DRIVER

public static final java.lang.String KEY_JDBC_DRIVER

Key for jdbc driver.

另请参阅:

常量字段值

KEY_JDBC_URL

public static final java.lang.String KEY_JDBC_URL

Key for jdbc url.

另请参阅:

常量字段值

KEY_JDBC_URL_PARAMS

public static final java.lang.String KEY_JDBC_URL_PARAMS

Key for jdbc url params.

另请参阅:

常量字段值

KEY_MAX_ACTIVE

public static final java.lang.String KEY_MAX_ACTIVE

Key for maximum active connections.

另请参阅:

常量字段值

KEY_MAX_IDLE

public static final java.lang.String KEY_MAX_IDLE

Key for maximum idle connections.

另请参阅:

常量字段值

KEY_MAX_WAIT

public static final java.lang.String KEY_MAX_WAIT

Key for maximum wait time.

另请参阅:

常量字段值

KEY_MIN_EVICTABLE_IDLE_TIME

public static final java.lang.String KEY_MIN_EVICTABLE_IDLE_TIME

Key for minimum idle time before a connection is subject to an eviction test.

另请参阅:

常量字段值

KEY_MIN_IDLE

public static final java.lang.String KEY_MIN_IDLE

Key for minimum number of connections kept open.

另请参阅:

常量字段值

KEY_NUM_TESTS_PER_EVICTION_RUN

public static final java.lang.String KEY_NUM_TESTS_PER_EVICTION_RUN

Key for number of tested connections per run.

另请参阅:

常量字段值

KEY_PASSWORD

public static final java.lang.String KEY_PASSWORD

Key for database password.

另请参阅:

常量字段值

KEY_POOL_DEFAULT

public static final java.lang.String KEY_POOL_DEFAULT

Key for default.

另请参阅:

常量字段值

KEY_POOL_URL

public static final java.lang.String KEY_POOL_URL

Key for pool url.

另请参阅:

常量字段值

KEY_POOL_USER

public static final java.lang.String KEY_POOL_USER

Key for pool user.

另请参阅:

常量字段值

KEY_POOL_VFS

public static final java.lang.String KEY_POOL_VFS

Key for vfs pool.

另请参阅:

常量字段值

KEY_POOLING

public static final java.lang.String KEY_POOLING

Key for pooling flag.

另请参阅:

常量字段值

KEY_TEST_ON_BORROW

public static final java.lang.String KEY_TEST_ON_BORROW

Key for test on borrow flag.

另请参阅:

常量字段值

KEY_TEST_QUERY

public static final java.lang.String KEY_TEST_QUERY

Key for test query.

另请参阅:

常量字段值

KEY_TEST_WHILE_IDLE

public static final java.lang.String KEY_TEST_WHILE_IDLE

Key for test while idle flag.

另请参阅:

常量字段值

KEY_TIME_BETWEEN_EVICTION_RUNS

public static final java.lang.String KEY_TIME_BETWEEN_EVICTION_RUNS

Key for time between two eviction runs.

另请参阅:

常量字段值

KEY_USERNAME

public static final java.lang.String KEY_USERNAME

Key for user name.

另请参阅:

常量字段值

KEY_WHEN_EXHAUSTED_ACTION

public static final java.lang.String KEY_WHEN_EXHAUSTED_ACTION

Key for "when pool exhausted" action.

另请参阅:

常量字段值

OPENCMS_DEFAULT_POOL_NAME

public static final java.lang.String OPENCMS_DEFAULT_POOL_NAME

The name of the opencms default pool.

另请参阅:

常量字段值

OPENCMS_DEFAULT_POOL_URL

public static final java.lang.String OPENCMS_DEFAULT_POOL_URL

The default OpenCms JDBC pool URL.

另请参阅:

常量字段值

OPENCMS_URL_PREFIX

public static final java.lang.String OPENCMS_URL_PREFIX

The prefix used for opencms JDBC pools.

另请参阅:

常量字段值

方法详细资料

createDriverManagerConnectionPool

public static org.apache.commons.dbcp.PoolingDriver createDriverManagerConnectionPool(CmsParameterConfiguration config,
                                                                      java.lang.String key)
                                                                               throws java.lang.Exception

Creates a JDBC DriverManager based DBCP connection pool.

参数:

config - the configuration (opencms.properties)

key - the key of the database pool in the configuration

返回:

String the URL to access the created DBCP pool

抛出:

java.lang.Exception - if the pool could not be initialized

getDbPoolName

public static java.lang.String getDbPoolName(CmsParameterConfiguration configuration,
                             java.lang.String key)

Returns the database pool name for a given configuration key.

参数:

configuration - the configuration

key - a db pool configuration key

返回:

the database pool name

getDbPoolUrls

public static java.util.List<java.lang.String> getDbPoolUrls(CmsParameterConfiguration configuration)

Returns a list of available database pool names.

参数:

configuration - the configuration to read the pool names from

返回:

a list of database pool names

getDefaultDbPoolName

public static java.lang.String getDefaultDbPoolName()

Returns the name of the default database connection pool.

返回:

the name of the default database connection pool