BoneCP

java.lang.Object
- com.jolbox.bonecp.BoneCP

所有已实现的接口:

java.io.Serializable
```
public class BoneCP
extends java.lang.Object
implements java.io.Serializable
```
Connection pool (main class).

作者:

wwadge

另请参阅:
序列化表格

字段概要

字段
限定符和类型	字段和说明
`private java.util.concurrent.ExecutorService`	`asyncExecutor` Executor service for obtaining a connection in an asynchronous fashion.
`private java.util.concurrent.ExecutorService`	`closeConnectionExecutor` Threads monitoring for bad connection requests.
`protected boolean`	`closeConnectionWatch` If set to true, create a new thread that monitors a connection and displays warnings if application failed to close the connection.
`private long`	`closeConnectionWatchTimeoutInMs` No of ms to wait for thread.join() in connection watch thread.
`private BoneCPConfig`	`config` Configuration object used in constructor.
`private java.util.concurrent.ExecutorService`	`connectionsScheduler` Executor for threads watching each partition to dynamically create new threads/kill off excess ones.
`private long`	`connectionTimeoutInMs` Time to wait before timing out the connection.
`private java.lang.Boolean`	`defaultAutoCommit` Config setting.
`private java.lang.String`	`defaultCatalog` Config setting.
`private java.lang.Boolean`	`defaultReadOnly` Config setting.
`private int`	`defaultTransactionIsolationValue` Config setting.
`private static java.lang.String`	`ERROR_TEST_CONNECTION` Exception message.
`protected boolean`	`externalAuth` Config setting.
`private FinalizableReferenceQueue`	`finalizableRefQueue` Watch for connections that should have been safely closed but the application forgot.
`private java.util.Map<java.sql.Connection,java.lang.ref.Reference<ConnectionHandle>>`	`finalizableRefs` Reference of objects that are to be watched.
`private static java.lang.String`	`KEEPALIVEMETADATA` Constant for keep-alive test
`private java.util.concurrent.ScheduledExecutorService`	`keepAliveScheduler` Handle to factory that creates 1 thread per partition that periodically wakes up and performs some activity on the connection.
`private static Logger`	`logger` Logger class.
`private java.util.concurrent.ScheduledExecutorService`	`maxAliveScheduler` Handle to factory that creates 1 thread per partition that periodically wakes up and performs some activity on the connection.
`static java.lang.String`	`MBEAN_BONECP` JMX constant.
`static java.lang.String`	`MBEAN_CONFIG` JMX constant.
`private javax.management.MBeanServer`	`mbs` JMX support.
`private static java.lang.String[]`	`METADATATABLE` Constant for keep-alive test
`private int`	`partitionCount` Number of partitions passed in constructor.
`private ConnectionPartition[]`	`partitions` Partitions handle.
`protected int`	`poolAvailabilityThreshold` Create more connections when we hit x% of our possible number of connections.
`protected boolean`	`poolShuttingDown` set to true if the connection pool has been flagged as shutting down.
`private java.util.concurrent.ExecutorService`	`releaseHelper` pointer to the thread containing the release helper threads.
`private boolean`	`releaseHelperThreadsConfigured` If set to true, config has specified the use of helper threads.
`private static long`	`serialVersionUID` Serialization UID
`private static java.lang.String`	`SHUTDOWN_LOCATION_TRACE` Exception message.
`private java.lang.String`	`shutdownStackTrace` Placeholder to give more useful info in case of a double shutdown.
`private java.util.concurrent.ExecutorService`	`statementCloseHelperExecutor` pointer to the service containing the statement close helper threads.
`private boolean`	`statementReleaseHelperThreadsConfigured` If set to true, config has specified the use of statement release helper threads.
`private LinkedTransferQueue<StatementHandle>`	`statementsPendingRelease` Scratch queue of statments awaiting to be closed.
`private Statistics`	`statistics` statistics handle.
`private boolean`	`statisticsEnabled` if true, we care about statistics.
`protected java.util.concurrent.locks.Lock`	`terminationLock` Prevent repeated termination of all connections when the DB goes down.
`private static java.lang.String`	`THREAD_CLOSE_CONNECTION_WARNING` Warning message.
`private static java.lang.String`	`UNCLOSED_EXCEPTION_MESSAGE` Exception message.

构造器概要

构造器
构造器和说明

BoneCP(BoneCPConfig config)
Constructor.

构造器
构造器和说明
`BoneCP(BoneCPConfig config)` Constructor.

方法概要

方法
限定符和类型	方法和说明
`protected java.lang.String`	`captureStackTrace(java.lang.String message)` Throw an exception to capture it so as to be able to print it out later on
`void`	`close()` Just a synonym to shutdown.
`private boolean`	`closeStatement(java.sql.Statement stmt, boolean result)`
`java.util.concurrent.Future<java.sql.Connection>`	`getAsyncConnection()` Obtain a connection asynchronously by queueing a request to obtain a connection in a separate thread.
`BoneCPConfig`	`getConfig()` Gets config object.
`java.sql.Connection`	`getConnection()` Returns a free connection.
`protected FinalizableReferenceQueue`	`getFinalizableRefQueue()` Watch for connections that should have been safely closed but the application forgot.
`protected java.util.Map<java.sql.Connection,java.lang.ref.Reference<ConnectionHandle>>`	`getFinalizableRefs()` Return the finalizable refs handle.
`protected java.util.concurrent.ExecutorService`	`getReleaseHelper()`
`protected java.util.concurrent.ExecutorService`	`getStatementCloseHelperExecutor()` Returns the statementCloseHelper field.
`protected LinkedTransferQueue<StatementHandle>`	`getStatementsPendingRelease()` Returns the statementsPendingRelease field.
`Statistics`	`getStatistics()` Returns a reference to the statistics class.
`int`	`getTotalCreatedConnections()` Return total number of connections created in all partitions.
`int`	`getTotalFree()` Return the number of free connections available to an application right away (excluding connections that can be created dynamically)
`int`	`getTotalLeased()` Return total number of connections currently in use by an application
`protected void`	`initJMX()` Initialises JMX stuff.
`protected void`	`initStmtReleaseHelper(java.lang.String suffix)` Starts off threads released to statement release helpers.
`protected void`	`internalReleaseConnection(ConnectionHandle connectionHandle)` Release a connection by placing the connection back in the pool.
`boolean`	`isConnectionHandleAlive(ConnectionHandle connection)` Sends a dummy statement to the server to keep the connection alive
`protected boolean`	`isReleaseHelperThreadsConfigured()` Returns the releaseHelperThreadsConfigured field.
`protected boolean`	`isStatementReleaseHelperThreadsConfigured()` Returns the statementReleaseHelperThreadsConfigured field.
`private void`	`maybeSignalForMoreConnections(ConnectionPartition connectionPartition)` Tests if this partition has hit a threshold and signal to the pool watch thread to create new connections
`protected java.sql.Connection`	`obtainRawInternalConnection()` Returns a database connection by using Driver.getConnection() or DataSource.getConnection()
`protected void`	`postDestroyConnection(ConnectionHandle handle)` Update counters and call hooks.
`protected void`	`putConnectionBackInPartition(ConnectionHandle connectionHandle)` Places a connection back in the originating partition.
`protected void`	`releaseConnection(java.sql.Connection connection)` Releases the given connection back to the pool.
`protected void`	`setReleaseHelper(java.util.concurrent.ExecutorService releaseHelper)`
`protected void`	`setStatementCloseHelperExecutor(java.util.concurrent.ExecutorService statementCloseHelper)` Sets the statementCloseHelper field.
`void`	`shutdown()` Closes off this connection pool.
`protected void`	`terminateAllConnections()` Closes off all connections in all partitions.
`private void`	`watchConnection(ConnectionHandle connectionHandle)` Starts off a new thread to monitor this connection attempt.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - THREAD_CLOSE_CONNECTION_WARNING
```
private static final java.lang.String THREAD_CLOSE_CONNECTION_WARNING
```
    Warning message.
    
    另请参阅:
    常量字段值
  - serialVersionUID
```
private static final long serialVersionUID
```
    Serialization UID
    
    另请参阅:
    常量字段值
  - ERROR_TEST_CONNECTION
```
private static final java.lang.String ERROR_TEST_CONNECTION
```
    Exception message.
    
    另请参阅:
    常量字段值
  - SHUTDOWN_LOCATION_TRACE
```
private static final java.lang.String SHUTDOWN_LOCATION_TRACE
```
    Exception message.
    
    另请参阅:
    常量字段值
  - UNCLOSED_EXCEPTION_MESSAGE
```
private static final java.lang.String UNCLOSED_EXCEPTION_MESSAGE
```
    Exception message.
    
    另请参阅:
    常量字段值
  - MBEAN_CONFIG
```
public static final java.lang.String MBEAN_CONFIG
```
    JMX constant.
    
    另请参阅:
    常量字段值
  - MBEAN_BONECP
```
public static final java.lang.String MBEAN_BONECP
```
    JMX constant.
    
    另请参阅:
    常量字段值
  - METADATATABLE
```
private static final java.lang.String[] METADATATABLE
```
    Constant for keep-alive test
  - KEEPALIVEMETADATA
```
private static final java.lang.String KEEPALIVEMETADATA
```
    Constant for keep-alive test
    
    另请参阅:
    常量字段值
  - poolAvailabilityThreshold
```
protected final int poolAvailabilityThreshold
```
    Create more connections when we hit x% of our possible number of connections.
  - partitionCount
```
private int partitionCount
```
    Number of partitions passed in constructor.
  - partitions
```
private ConnectionPartition[] partitions
```
    Partitions handle.
  - keepAliveScheduler
```
private java.util.concurrent.ScheduledExecutorService keepAliveScheduler
```
    Handle to factory that creates 1 thread per partition that periodically wakes up and performs some activity on the connection.
  - maxAliveScheduler
```
private java.util.concurrent.ScheduledExecutorService maxAliveScheduler
```
    Handle to factory that creates 1 thread per partition that periodically wakes up and performs some activity on the connection.
  - connectionsScheduler
```
private java.util.concurrent.ExecutorService connectionsScheduler
```
    Executor for threads watching each partition to dynamically create new threads/kill off excess ones.
  - config
```
private BoneCPConfig config
```
    Configuration object used in constructor.
  - releaseHelperThreadsConfigured
```
private boolean releaseHelperThreadsConfigured
```
    If set to true, config has specified the use of helper threads.
  - releaseHelper
```
private java.util.concurrent.ExecutorService releaseHelper
```
    pointer to the thread containing the release helper threads.
  - statementCloseHelperExecutor
```
private java.util.concurrent.ExecutorService statementCloseHelperExecutor
```
    pointer to the service containing the statement close helper threads.
  - asyncExecutor
```
private java.util.concurrent.ExecutorService asyncExecutor
```
    Executor service for obtaining a connection in an asynchronous fashion.
  - logger
```
private static Logger logger
```
    Logger class.
  - mbs
```
private javax.management.MBeanServer mbs
```
    JMX support.
  - terminationLock
```
protected java.util.concurrent.locks.Lock terminationLock
```
    Prevent repeated termination of all connections when the DB goes down.
  - closeConnectionWatch
```
protected boolean closeConnectionWatch
```
    If set to true, create a new thread that monitors a connection and displays warnings if application failed to close the connection.
  - closeConnectionExecutor
```
private java.util.concurrent.ExecutorService closeConnectionExecutor
```
    Threads monitoring for bad connection requests.
  - poolShuttingDown
```
protected volatile boolean poolShuttingDown
```
    set to true if the connection pool has been flagged as shutting down.
  - shutdownStackTrace
```
private java.lang.String shutdownStackTrace
```
    Placeholder to give more useful info in case of a double shutdown.
  - finalizableRefs
```
private final java.util.Map<java.sql.Connection,java.lang.ref.Reference<ConnectionHandle>> finalizableRefs
```
    Reference of objects that are to be watched.
  - finalizableRefQueue
```
private FinalizableReferenceQueue finalizableRefQueue
```
    Watch for connections that should have been safely closed but the application forgot.
  - connectionTimeoutInMs
```
private long connectionTimeoutInMs
```
    Time to wait before timing out the connection. Default in config is Long.MAX_VALUE milliseconds.
  - closeConnectionWatchTimeoutInMs
```
private long closeConnectionWatchTimeoutInMs
```
    No of ms to wait for thread.join() in connection watch thread.
  - statementReleaseHelperThreadsConfigured
```
private boolean statementReleaseHelperThreadsConfigured
```
    If set to true, config has specified the use of statement release helper threads.
  - statementsPendingRelease
```
private LinkedTransferQueue<StatementHandle> statementsPendingRelease
```
    Scratch queue of statments awaiting to be closed.
  - statisticsEnabled
```
private boolean statisticsEnabled
```
    if true, we care about statistics.
  - statistics
```
private Statistics statistics
```
    statistics handle.
  - defaultReadOnly
```
private java.lang.Boolean defaultReadOnly
```
    Config setting.
  - defaultCatalog
```
private java.lang.String defaultCatalog
```
    Config setting.
  - defaultTransactionIsolationValue
```
private int defaultTransactionIsolationValue
```
    Config setting.
  - defaultAutoCommit
```
private java.lang.Boolean defaultAutoCommit
```
    Config setting.
  - externalAuth
```
protected boolean externalAuth
```
    Config setting.
- 构造器详细资料
  - BoneCP
```
public BoneCP(BoneCPConfig config)
       throws java.sql.SQLException
```
    Constructor.
    
    参数:
    config - Configuration for pool
    
    抛出:
    
    java.sql.SQLException - on error
- 方法详细资料
  - shutdown
```
public void shutdown()
```
    Closes off this connection pool.
  - close
```
public void close()
```
    Just a synonym to shutdown.
  - terminateAllConnections
```
protected void terminateAllConnections()
```
    Closes off all connections in all partitions.
  - postDestroyConnection
```
protected void postDestroyConnection(ConnectionHandle handle)
```
    Update counters and call hooks.
    
    参数:
    handle - connection handle.
  - obtainRawInternalConnection
```
protected java.sql.Connection obtainRawInternalConnection()
                                                   throws java.sql.SQLException
```
    Returns a database connection by using Driver.getConnection() or DataSource.getConnection()
    
    返回:
    Connection handle
    
    抛出:
    
    java.sql.SQLException - on error
  - initStmtReleaseHelper
```
protected void initStmtReleaseHelper(java.lang.String suffix)
```
    Starts off threads released to statement release helpers.
    
    参数:
    suffix - of pool
  - initJMX
```
protected void initJMX()
```
    Initialises JMX stuff.
  - getConnection
```
public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
```
    Returns a free connection.
    
    返回:
    Connection handle.
    
    抛出:
    
    java.sql.SQLException
  - watchConnection
```
private void watchConnection(ConnectionHandle connectionHandle)
```
    Starts off a new thread to monitor this connection attempt.
    
    参数:
    connectionHandle - to monitor
  - captureStackTrace
```
protected java.lang.String captureStackTrace(java.lang.String message)
```
    Throw an exception to capture it so as to be able to print it out later on
    
    参数:
    message - message to display
    
    返回:
    Stack trace message
  - getAsyncConnection
```
public java.util.concurrent.Future<java.sql.Connection> getAsyncConnection()
```
    Obtain a connection asynchronously by queueing a request to obtain a connection in a separate thread. Use as follows:
    Future<Connection> result = pool.getAsyncConnection();
    ... do something else in your application here ...
    Connection connection = result.get(); // get the connection
    
    返回:
    A Future task returning a connection.
  - maybeSignalForMoreConnections
```
private void maybeSignalForMoreConnections(ConnectionPartition connectionPartition)
```
    Tests if this partition has hit a threshold and signal to the pool watch thread to create new connections
    
    参数:
    connectionPartition - to test for.
  - releaseConnection
```
protected void releaseConnection(java.sql.Connection connection)
                          throws java.sql.SQLException
```
    Releases the given connection back to the pool.
    
    参数:
    connection - to release
    
    抛出:
    
    java.sql.SQLException
  - internalReleaseConnection
```
protected void internalReleaseConnection(ConnectionHandle connectionHandle)
                                  throws java.sql.SQLException
```
    Release a connection by placing the connection back in the pool.
    
    参数:
    connectionHandle - Connection being released.
    
    抛出:
    
    java.sql.SQLException
  - putConnectionBackInPartition
```
protected void putConnectionBackInPartition(ConnectionHandle connectionHandle)
                                     throws java.sql.SQLException
```
    Places a connection back in the originating partition.
    
    参数:
    connectionHandle - to place back
    
    抛出:
    
    java.sql.SQLException - on error
  - isConnectionHandleAlive
```
public boolean isConnectionHandleAlive(ConnectionHandle connection)
```
    Sends a dummy statement to the server to keep the connection alive
    
    参数:
    connection - Connection handle to perform activity on
    
    返回:
    true if test query worked, false otherwise
  - closeStatement
```
private boolean closeStatement(java.sql.Statement stmt,
                     boolean result)
```
    参数:
    stmt -
    result -
    
    返回:
    false on failure.
  - getTotalLeased
```
public int getTotalLeased()
```
    Return total number of connections currently in use by an application
    
    返回:
    no of leased connections
  - getTotalFree
```
public int getTotalFree()
```
    Return the number of free connections available to an application right away (excluding connections that can be created dynamically)
    
    返回:
    number of free connections
  - getTotalCreatedConnections
```
public int getTotalCreatedConnections()
```
    Return total number of connections created in all partitions.
    
    返回:
    number of created connections
  - getConfig
```
public BoneCPConfig getConfig()
```
    Gets config object.
    
    返回:
    config object
  - getReleaseHelper
```
protected java.util.concurrent.ExecutorService getReleaseHelper()
```
    返回:
    the releaseHelper
  - setReleaseHelper
```
protected void setReleaseHelper(java.util.concurrent.ExecutorService releaseHelper)
```
    参数:
    releaseHelper - the releaseHelper to set
  - getFinalizableRefs
```
protected java.util.Map<java.sql.Connection,java.lang.ref.Reference<ConnectionHandle>> getFinalizableRefs()
```
    Return the finalizable refs handle.
    
    返回:
    the finalizableRefs value.
  - getFinalizableRefQueue
```
protected FinalizableReferenceQueue getFinalizableRefQueue()
```
    Watch for connections that should have been safely closed but the application forgot.
    
    返回:
    the finalizableRefQueue
  - getStatementCloseHelperExecutor
```
protected java.util.concurrent.ExecutorService getStatementCloseHelperExecutor()
```
    Returns the statementCloseHelper field.
    
    返回:
    statementCloseHelper
  - setStatementCloseHelperExecutor
```
protected void setStatementCloseHelperExecutor(java.util.concurrent.ExecutorService statementCloseHelper)
```
    Sets the statementCloseHelper field.
    
    参数:
    statementCloseHelper - the statementCloseHelper to set
  - isReleaseHelperThreadsConfigured
```
protected boolean isReleaseHelperThreadsConfigured()
```
    Returns the releaseHelperThreadsConfigured field.
    
    返回:
    releaseHelperThreadsConfigured
  - isStatementReleaseHelperThreadsConfigured
```
protected boolean isStatementReleaseHelperThreadsConfigured()
```
    Returns the statementReleaseHelperThreadsConfigured field.
    
    返回:
    statementReleaseHelperThreadsConfigured
  - getStatementsPendingRelease
```
protected LinkedTransferQueue<StatementHandle> getStatementsPendingRelease()
```
    Returns the statementsPendingRelease field.
    
    返回:
    statementsPendingRelease
  - getStatistics
```
public Statistics getStatistics()
```
    Returns a reference to the statistics class.
    
    返回:
    statistics

类 BoneCP

字段概要

构造器概要

方法概要

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

字段详细资料

THREAD_CLOSE_CONNECTION_WARNING

serialVersionUID

ERROR_TEST_CONNECTION

SHUTDOWN_LOCATION_TRACE

UNCLOSED_EXCEPTION_MESSAGE

MBEAN_CONFIG

MBEAN_BONECP

METADATATABLE

KEEPALIVEMETADATA

poolAvailabilityThreshold

partitionCount

partitions

keepAliveScheduler

maxAliveScheduler

connectionsScheduler

config

releaseHelperThreadsConfigured

releaseHelper

statementCloseHelperExecutor

asyncExecutor

logger

mbs

terminationLock

closeConnectionWatch

closeConnectionExecutor

poolShuttingDown

shutdownStackTrace

finalizableRefs

finalizableRefQueue

connectionTimeoutInMs

closeConnectionWatchTimeoutInMs

statementReleaseHelperThreadsConfigured

statementsPendingRelease

statisticsEnabled

statistics

defaultReadOnly

defaultCatalog

defaultTransactionIsolationValue

defaultAutoCommit

externalAuth

构造器详细资料

BoneCP

方法详细资料

shutdown

close

terminateAllConnections

postDestroyConnection

obtainRawInternalConnection

initStmtReleaseHelper

initJMX

getConnection

watchConnection

captureStackTrace

getAsyncConnection

maybeSignalForMoreConnections

releaseConnection

internalReleaseConnection

putConnectionBackInPartition

isConnectionHandleAlive

closeStatement

getTotalLeased

getTotalFree

getTotalCreatedConnections

getConfig

getReleaseHelper

setReleaseHelper

getFinalizableRefs

getFinalizableRefQueue

getStatementCloseHelperExecutor

setStatementCloseHelperExecutor

isReleaseHelperThreadsConfigured

isStatementReleaseHelperThreadsConfigured

getStatementsPendingRelease

getStatistics