weblogic.jdbc.common.internal

Class DataSourceRuntimeMBeanImpl

java.lang.Object

weblogic.management.runtime.RuntimeMBeanDelegate

weblogic.jdbc.common.internal.DataSourceRuntimeMBeanImpl

All Implemented Interfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, ComponentRuntimeMBean, JDBCDataSourceRuntimeMBean, RuntimeMBean, WebLogicMBean

Direct Known Subclasses:

AbstractDataSourceRuntimeImpl, OracleDataSourceRuntimeImpl

public class DataSourceRuntimeMBeanImpl
extends RuntimeMBeanDelegate
implements JDBCDataSourceRuntimeMBean

The Runtime MBean for Data Sources

Excluded in public API Reference.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DataSourceRuntimeMBeanImpl.OperationRequest

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	beanName
protected java.lang.String	databaseProductName
protected java.lang.String	databaseProductVersion
private java.lang.String	defaultForConnectionMetadata
protected java.lang.String	driverName
private JDBCDriverRuntimeMBean	driverRTMBean
protected java.lang.String	driverVersion
protected weblogic.common.resourcepool.ResourcePoolGroup	group
(package private) JDBCDataSourceTaskRuntimeMBeanImpl	lastTask
private java.sql.DatabaseMetaData	metaData
private java.util.concurrent.locks.ReentrantLock	metaDataLock
protected boolean	needMetaData
protected JDBCConnectionPool	pool
static java.lang.String	PROGRESS_FAILED
static java.lang.String	PROGRESS_PROCESSING
static java.lang.String	PROGRESS_SUCCESS
private JDBCReplayStatisticsRuntimeMBean	replayStatisticsRuntimeMBean
private static int	TASK_AFTERLIFE_TIME_MILLIS
private java.util.Set<JDBCDataSourceTaskRuntimeMBeanImpl>	tasks

Fields inherited from class weblogic.management.runtime.RuntimeMBeanDelegate

descriptor, name, parent, registered, type

Fields inherited from interface weblogic.management.runtime.ComponentRuntimeMBean

ACTIVATED, NEW, PREPARED, UNPREPARED, UPDATE_PENDING

Constructor Summary

Constructors

Constructor and Description
DataSourceRuntimeMBeanImpl(JDBCConnectionPool pool, weblogic.common.resourcepool.ResourcePoolGroup group, java.lang.String beanName, RuntimeMBean parent, RuntimeMBean restParent, DescriptorBean descriptor)
DataSourceRuntimeMBeanImpl(JDBCConnectionPool pool, java.lang.String beanName, RuntimeMBean parent, RuntimeMBean restParent, DescriptorBean descriptor)

Method Summary

Modifier and Type	Method and Description
boolean	addWorkManagerRuntime(WorkManagerRuntimeMBean wmRuntime) Adds the RuntimeMBean for a WorkManager defined in this component
private void	clearCachedValues()
void	clearOldTaskRuntimes()
void	clearStatementCache() Clears the cache of Prepared and Callable Statements maintained for each connection in the pool.
private void	doOperation(boolean shutdown, int operationSecs, JDBCDataSourceTaskRuntimeMBeanImpl task)
void	dumpPool() Prints out information about all the connections in the connection pool in the data source.
void	dumpPoolProfile() Prints out profile information about the data source.
void	forceShutdown() Forcefully shuts down a data source that has a health state of Running, including forcing the disconnection of all current connection users.
void	forceSuspend() Forcefully suspends a data source that has the health state of Running, including disconnecting all current connection users.
int	getActiveConnectionsAverageCount() Average number of active connections in this instance of the data source.
int	getActiveConnectionsCurrentCount() Returns the current total active connections.
int	getActiveConnectionsHighCount() Returns the high water mark of active connections in this DataSourceRuntimeMBean.
long	getCommitOutcomeRetryTotalCount() The cumulative total number of commit outcome query retries conducted before resolving the outcome or exceeding the retry seconds in this data source since the data source was deployed.
int	getConnectionDelayTime() Returns averaged time necessary to get a connection from the database.
int	getConnectionsTotalCount() Returns the total number of JDBC connections in this DataSourceRuntimeMBean since the pool is instantiated.
int	getCurrCapacity() The current count of JDBC connections in the connection pool in the data source.
int	getCurrCapacityHighCount() Highest number of database connections available or in use (current capacity) in this instance of the data source since the data source was deployed.
java.lang.String	getDatabaseProductName() The product name of the database that this data source is connected to.
java.lang.String	getDatabaseProductVersion() The product version of the database that this data source is connected to.
int	getDeploymentState() The current deployment state of the module.
java.lang.String	getDriverName() The product name of the JDBC driver that this data source is configured to use.
java.lang.String	getDriverVersion() The version of the JDBC driver that this data source is configured to use.
long	getFailedRepurposeCount() The number of repurpose errors that have occurred since the datasource was deployed.
long	getFailedReserveRequestCount() The cumulative, running count of requests for a connection from this data source that could not be fulfilled.
int	getFailuresToReconnectCount() Returns number of cases when a connection pool attempted to refresh a connection to a database and failed.
int	getHighestNumAvailable() Highest number of database connections that were idle and available to be used by an application at any time in this instance of the data source since the data source was deployed.
int	getHighestNumUnavailable() Highest number of database connections that were in use by applications or being tested by the system in this instance of the data source since the data source was deployed.
JDBCDriverRuntimeMBean	getJDBCDriverRuntime() Gets the JDBCDriverRuntimeMBean associated with this data source.
JDBCReplayStatisticsRuntimeMBean	getJDBCReplayStatisticsRuntimeMBean() Get the statistics for replay only if the datasource is using an Oracle replay driver for 12.1.0.2 and later.
JDBCDataSourceTaskRuntimeMBean	getLastTask() Get the last datasource Task
int	getLeakedConnectionCount() Returns number of leaked connections.
private void	getMetaData()
java.lang.String	getModuleId() Returns the identifier for this Component.
int	getNumAvailable() The number of database connections that are currently idle and available to be used by applications in this instance of the data source.
int	getNumUnavailable() The number of connections currently in use by applications or being tested in this instance of the data source.
long	getPrepStmtCacheAccessCount() The cumulative, running count of the number of times that the statement cache was accessed.
long	getPrepStmtCacheAddCount() The cumulative, running count of the number of statements added to the statement cache.
int	getPrepStmtCacheCurrentSize() The number of prepared and callable statements currently cached in the statement cache.
long	getPrepStmtCacheDeleteCount() The cumulative, running count of statements discarded from the cache.
int	getPrepStmtCacheHitCount() Returns frequency of use of prepared statements cache - a cumulative, running count of the use of each cached statement
int	getPrepStmtCacheMissCount() Returns number of cases the cache does not satisfy the statement - a similar count (with SQL) of cases when the cache does not have a cached statement to satisfy a request.
java.util.Properties	getProperties() Return the properties for a pool.
long	getRepurposeCount() The number of times connections have been repurposed since the datasource was deployed.
long	getReserveRequestCount() The cumulative, running count of requests for a connection from this data source.
long	getResolvedAsCommittedTotalCount() The cumulative total number of commit outcomes successfully resolved as committed in this data source since the data source was deployed.
long	getResolvedAsNotCommittedTotalCount() The cumulative total number of commit outcomes successfully resolved as not committed in this data source since the data source was deployed.
java.lang.String	getState() Returns state of the pool.
JDBCDataSourceTaskRuntimeMBean[]	getTasks() Get preexisting DataSource Tasks
long	getUnresolvedTotalCount() The cumulative total number of commit outcomes unsuccessfully resolved in this data source since the data source was deployed.
java.lang.String	getVersionJDBCDriver() Returns the version of the JDBC driver, in the format of concatenating the Driver class name with 'major: XX, minor: YY'.
int	getWaitingForConnectionCurrentCount() Returns the current total waiting for a connection.
long	getWaitingForConnectionFailureTotal() The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually failed to get a connection.
int	getWaitingForConnectionHighCount() Returns the high water mark of waiters for a connection in this DataSourceRuntimeMBean.
long	getWaitingForConnectionSuccessTotal() The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually succeeded in getting a connection.
long	getWaitingForConnectionTotal() The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection, including those that eventually got a connection and those that did not get a connection.
int	getWaitSecondsHighCount() Returns the number of seconds the longest waiter for a connection waited
WorkManagerRuntimeMBean[]	getWorkManagerRuntimes() Get the runtime mbeans for all work managers defined in this component
boolean	isEnabled() Returns true if the pool enabled.
boolean	isOperationAllowed(java.lang.String operation) Indicates whether the specified operation is valid based on the state of the underlying DataSource.
protected void	lookupMetaData()
boolean	poolExists(java.lang.String poolName) Does a pool with the given name exist?
void	reset() Resets the connection pool in the data source by shutting down and recreating all available database connections in the pool.
void	resetStatistics() Reset statistics counters to zero.
void	resume() Restores all access to and operations on a data source that has a health state of Suspended.
void	setDeploymentState(int state) Sets the value of the deploymentState attribute.
void	setJDBCDriverRuntime(JDBCDriverRuntimeMBean mbean) Sets the JDBCDriverRuntimeMBean associated with this data source.
private JDBCDataSourceTaskRuntimeMBeanImpl	setTask(boolean shutdown)
void	shrink() Shrinks the database connection pool in the data source to either the current number of reserved connections or the initial size of the connection pool, which ever is greater.
void	shutdown() Gracefully, synchronously shuts down a data source that has a health state of Running.
JDBCDataSourceTaskRuntimeMBean	shutdown(int operationSecs) Gracefully, asynchronously shuts down a data source that has a health state of Running.
void	start() Starts a data source that has a health state of Shutdown.
void	suspend() Synchronously, gracefully suspends a data source that has the health state of Running and disables existing connections.
JDBCDataSourceTaskRuntimeMBean	suspend(int operationSecs) Asynchronously, gracefully suspends a data source that has the health state of Running and disables existing connections.
java.lang.String	testPool() Tests the connection pool in the data source by reserving and releasing a connection from it.
private void	throwGroupOperationUnsupported()

Methods inherited from class weblogic.management.runtime.RuntimeMBeanDelegate

_createHelper, _postSet, _postSet, _postSet, _postSet, _postSet, addChild, addNotificationListener, addPropertyChangeListener, createChildCopy, getAttribute, getAttributes, getMBeanInfo, getMetaData, getName, getNotificationInfo, getObjectName, getParent, getParentAttribute, getPropertyChangeListeners, getRegistrationManager, getRestParent, getType, invoke, isCachingDisabled, isEditable, isRegistered, pluralize, postDeregister, postRegister, preDeregister, preRegister, register, removeChild, removeNotificationListener, removePropertyChangeListener, setAttribute, setAttributes, setMetaData, setName, setParent, setRestParent, setRuntimeMBeanHelper, setType, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, preDeregister, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Field Detail

PROGRESS_SUCCESS

public static final java.lang.String PROGRESS_SUCCESS

See Also:

Constant Field Values

PROGRESS_FAILED

public static final java.lang.String PROGRESS_FAILED

See Also:

Constant Field Values

PROGRESS_PROCESSING

public static final java.lang.String PROGRESS_PROCESSING

See Also:

Constant Field Values

pool

protected JDBCConnectionPool pool

group

protected weblogic.common.resourcepool.ResourcePoolGroup group

driverRTMBean

private JDBCDriverRuntimeMBean driverRTMBean

metaDataLock

private java.util.concurrent.locks.ReentrantLock metaDataLock

metaData

private java.sql.DatabaseMetaData metaData

beanName

private java.lang.String beanName

replayStatisticsRuntimeMBean

private JDBCReplayStatisticsRuntimeMBean replayStatisticsRuntimeMBean

tasks

private java.util.Set<JDBCDataSourceTaskRuntimeMBeanImpl> tasks

TASK_AFTERLIFE_TIME_MILLIS

private static final int TASK_AFTERLIFE_TIME_MILLIS

See Also:

Constant Field Values

lastTask

JDBCDataSourceTaskRuntimeMBeanImpl lastTask

defaultForConnectionMetadata

private final java.lang.String defaultForConnectionMetadata

See Also:

Constant Field Values

driverVersion

protected java.lang.String driverVersion

databaseProductName

protected java.lang.String databaseProductName

databaseProductVersion

protected java.lang.String databaseProductVersion

driverName

protected java.lang.String driverName

needMetaData

protected volatile boolean needMetaData

Constructor Detail

DataSourceRuntimeMBeanImpl

public DataSourceRuntimeMBeanImpl(JDBCConnectionPool pool,
                                  java.lang.String beanName,
                                  RuntimeMBean parent,
                                  RuntimeMBean restParent,
                                  DescriptorBean descriptor)
                           throws ManagementException

Throws:

ManagementException

DataSourceRuntimeMBeanImpl

public DataSourceRuntimeMBeanImpl(JDBCConnectionPool pool,
                                  weblogic.common.resourcepool.ResourcePoolGroup group,
                                  java.lang.String beanName,
                                  RuntimeMBean parent,
                                  RuntimeMBean restParent,
                                  DescriptorBean descriptor)
                           throws ManagementException

Throws:

ManagementException

Method Detail

getDeploymentState

public int getDeploymentState()

Description copied from interface: ComponentRuntimeMBean

The current deployment state of the module.

A module can be in one and only one of the following states. State can be changed via deployment or administrator console.

• UNPREPARED. State indicating at this module is neither prepared or active.
• PREPARED. State indicating at this module of this application is prepared, but not active. The classes have been loaded and the module has been validated.
• ACTIVATED. State indicating at this module is currently active.
• NEW. State indicating this module has just been created and is being initialized.

Specified by:

getDeploymentState in interface ComponentRuntimeMBean

Returns:

The deploymentState value

See Also:

ComponentRuntimeMBean.setDeploymentState(int)

setDeploymentState

public void setDeploymentState(int state)

Description copied from interface: ComponentRuntimeMBean

Sets the value of the deploymentState attribute.

Specified by:

setDeploymentState in interface ComponentRuntimeMBean

Parameters:

state - The new deploymentState value

See Also:

ComponentRuntimeMBean.getDeploymentState()

addWorkManagerRuntime

public boolean addWorkManagerRuntime(WorkManagerRuntimeMBean wmRuntime)

Description copied from interface: ComponentRuntimeMBean

Adds the RuntimeMBean for a WorkManager defined in this component

Specified by:

addWorkManagerRuntime in interface ComponentRuntimeMBean

getWorkManagerRuntimes

public WorkManagerRuntimeMBean[] getWorkManagerRuntimes()

Description copied from interface: ComponentRuntimeMBean

Get the runtime mbeans for all work managers defined in this component

Specified by:

getWorkManagerRuntimes in interface ComponentRuntimeMBean

getModuleId

public java.lang.String getModuleId()

Description copied from interface: ComponentRuntimeMBean

Returns the identifier for this Component. The identifier is unique within the application.

Typical modules will use the URI for their id. Web Modules will return their context-root since the web-uri may not be unique within an EAR.

Specified by:

getModuleId in interface ComponentRuntimeMBean

Returns:

the module id

testPool

public java.lang.String testPool()

Description copied from interface: JDBCDataSourceRuntimeMBean

Tests the connection pool in the data source by reserving and releasing a connection from it.

If the pool configuration attribute TestConnectionsOnReserve is enabled, the acquired connection is also tested as part of the reserve operation.

Specified by:

testPool in interface JDBCDataSourceRuntimeMBean

Returns:

Null upon success, else returns stacktrace.

See Also:

weblogic.management.configuration.JDBCConnectionPoolMBean

getLeakedConnectionCount

public int getLeakedConnectionCount()

Returns number of leaked connections. Leaked connection is a connection that was checked out from the pool but was not returned to the pool by calling close().

Specified by:

getLeakedConnectionCount in interface JDBCDataSourceRuntimeMBean

Returns:

The number of leaked connections.

isEnabled

public boolean isEnabled()

Returns true if the pool enabled. Returns false if the pool disabled

Specified by:

isEnabled in interface JDBCDataSourceRuntimeMBean

Returns:

Boolean indicating whether the data source is enabled or disabled.

getState

public java.lang.String getState()

Returns state of the pool. RUNNING - normal operation SHUTDOWN - pool has just been shutdown SUSPENDED - pool has been administratively disabled UNHEALTHY - no good connections available in in the pool

Specified by:

getState in interface JDBCDataSourceRuntimeMBean

Returns:

Current state of the connection pool.

getFailuresToReconnectCount

public int getFailuresToReconnectCount()

Returns number of cases when a connection pool attempted to refresh a connection to a database and failed.

Specified by:

getFailuresToReconnectCount in interface JDBCDataSourceRuntimeMBean

Returns:

Number of failed attempts to refresh a database connection.

getConnectionDelayTime

public int getConnectionDelayTime()

Returns averaged time necessary to get a connection from the database. This is how long it takes to get a connection from the pool. It is calculated as summary time to connect divided by summary number of connections Return value is microseconds.

Specified by:

getConnectionDelayTime in interface JDBCDataSourceRuntimeMBean

Returns:

Average amount of time to get a physical database connection.

getPrepStmtCacheAccessCount

public long getPrepStmtCacheAccessCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative, running count of the number of times that the statement cache was accessed.

Specified by:

getPrepStmtCacheAccessCount in interface JDBCDataSourceRuntimeMBean

Returns:

Count of the number of times that the statement cache was accessed.

getPrepStmtCacheAddCount

public long getPrepStmtCacheAddCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative, running count of the number of statements added to the statement cache.

Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements added to the caches for all connections in the connection pool.

Specified by:

getPrepStmtCacheAddCount in interface JDBCDataSourceRuntimeMBean

Returns:

Count of the number of statements added to the statement cache.

getPrepStmtCacheDeleteCount

public long getPrepStmtCacheDeleteCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative, running count of statements discarded from the cache.

Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements that were discarded from the caches for all connections in the connection pool.

Specified by:

getPrepStmtCacheDeleteCount in interface JDBCDataSourceRuntimeMBean

Returns:

Count of statements discarded from the statement cache.

getPrepStmtCacheCurrentSize

public int getPrepStmtCacheCurrentSize()

Description copied from interface: JDBCDataSourceRuntimeMBean

The number of prepared and callable statements currently cached in the statement cache.

Each connection in the connection pool has its own cache of statements. This number is the sum of the number of statements in the caches for all connections in the connection pool.

Specified by:

getPrepStmtCacheCurrentSize in interface JDBCDataSourceRuntimeMBean

Returns:

Number of prepared and callable statements currently cached the statement cache.

getPrepStmtCacheHitCount

public int getPrepStmtCacheHitCount()

Returns frequency of use of prepared statements cache - a cumulative, running count of the use of each cached statement

Specified by:

getPrepStmtCacheHitCount in interface JDBCDataSourceRuntimeMBean

Returns:

Frequency of use of prepared statements in the cache.

Excluded in public API Reference.

getPrepStmtCacheMissCount

public int getPrepStmtCacheMissCount()

Returns number of cases the cache does not satisfy the statement - a similar count (with SQL) of cases when the cache does not have a cached statement to satisfy a request.

Specified by:

getPrepStmtCacheMissCount in interface JDBCDataSourceRuntimeMBean

Returns:

Number of cases the cache does not satisfy the statement request.

Excluded in public API Reference.

getActiveConnectionsCurrentCount

public int getActiveConnectionsCurrentCount()

Returns the current total active connections.

Specified by:

getActiveConnectionsCurrentCount in interface JDBCDataSourceRuntimeMBean

Returns:

Current total number of active connections.

getWaitingForConnectionCurrentCount

public int getWaitingForConnectionCurrentCount()

Returns the current total waiting for a connection.

Specified by:

getWaitingForConnectionCurrentCount in interface JDBCDataSourceRuntimeMBean

Returns:

Current total number of requests waiting for a connection.

getVersionJDBCDriver

public java.lang.String getVersionJDBCDriver()

Returns the version of the JDBC driver, in the format of concatenating the Driver class name with 'major: XX, minor: YY'.

Specified by:

getVersionJDBCDriver in interface JDBCDataSourceRuntimeMBean

Returns:

JDBC driver class name

getActiveConnectionsHighCount

public int getActiveConnectionsHighCount()

Returns the high water mark of active connections in this DataSourceRuntimeMBean. The count starts at zero each time the DataSourceRuntimeMBean is instantiated. Note that this is an optimization method for a highly useful statistic that could be implemented less efficiently using change notification.

Specified by:

getActiveConnectionsHighCount in interface JDBCDataSourceRuntimeMBean

Returns:

Highest number of active database connections.

getWaitingForConnectionHighCount

public int getWaitingForConnectionHighCount()

Returns the high water mark of waiters for a connection in this DataSourceRuntimeMBean. The count starts at zero each time the DataSourceRuntimeMBean is instantiated. Note that this is an optimization method for a highly useful statistic that could be implemented less efficiently using change notification.

Specified by:

getWaitingForConnectionHighCount in interface JDBCDataSourceRuntimeMBean

Returns:

The high water mark of waiters for a connection. from this pool.

getWaitingForConnectionTotal

public long getWaitingForConnectionTotal()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection, including those that eventually got a connection and those that did not get a connection.

Specified by:

getWaitingForConnectionTotal in interface JDBCDataSourceRuntimeMBean

Returns:

Cumulative count of waiters for connections.

getWaitingForConnectionSuccessTotal

public long getWaitingForConnectionSuccessTotal()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually succeeded in getting a connection.

Specified by:

getWaitingForConnectionSuccessTotal in interface JDBCDataSourceRuntimeMBean

Returns:

Cumulative count of waiters that successfully obtained a connection.

getWaitingForConnectionFailureTotal

public long getWaitingForConnectionFailureTotal()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative, running count of requests for a connection from this data source that had to wait before getting a connection and eventually failed to get a connection.

Waiting connection requests can fail for a variety of reasons, including waiting for longer than the ConnectionReserveTimeoutSeconds.

Specified by:

getWaitingForConnectionFailureTotal in interface JDBCDataSourceRuntimeMBean

Returns:

Cumulative count of waiters that were unable to obtain a connection.

getWaitSecondsHighCount

public int getWaitSecondsHighCount()

Returns the number of seconds the longest waiter for a connection waited

Specified by:

getWaitSecondsHighCount in interface JDBCDataSourceRuntimeMBean

Returns:

The number of seconds of the longest wait time.

getConnectionsTotalCount

public int getConnectionsTotalCount()

Returns the total number of JDBC connections in this DataSourceRuntimeMBean since the pool is instantiated.

Specified by:

getConnectionsTotalCount in interface JDBCDataSourceRuntimeMBean

Returns:

The cumulative total number of JDBC connections created in this data source.

getCurrCapacity

public int getCurrCapacity()

Description copied from interface: JDBCDataSourceRuntimeMBean

The current count of JDBC connections in the connection pool in the data source.

Specified by:

getCurrCapacity in interface JDBCDataSourceRuntimeMBean

Returns:

The current capacity of this pool.

getCurrCapacityHighCount

public int getCurrCapacityHighCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

Highest number of database connections available or in use (current capacity) in this instance of the data source since the data source was deployed.

Specified by:

getCurrCapacityHighCount in interface JDBCDataSourceRuntimeMBean

Returns:

The high watermark of current capacity of this data source.

getNumAvailable

public int getNumAvailable()

Description copied from interface: JDBCDataSourceRuntimeMBean

The number of database connections that are currently idle and available to be used by applications in this instance of the data source.

Specified by:

getNumAvailable in interface JDBCDataSourceRuntimeMBean

Returns:

The number of available connections in this data source.

getHighestNumAvailable

public int getHighestNumAvailable()

Description copied from interface: JDBCDataSourceRuntimeMBean

Highest number of database connections that were idle and available to be used by an application at any time in this instance of the data source since the data source was deployed.

Specified by:

getHighestNumAvailable in interface JDBCDataSourceRuntimeMBean

Returns:

The highest number of available connections in this pool.

getNumUnavailable

public int getNumUnavailable()

Description copied from interface: JDBCDataSourceRuntimeMBean

The number of connections currently in use by applications or being tested in this instance of the data source.

Specified by:

getNumUnavailable in interface JDBCDataSourceRuntimeMBean

Returns:

The number of connections currently in use for this pool.

getHighestNumUnavailable

public int getHighestNumUnavailable()

Description copied from interface: JDBCDataSourceRuntimeMBean

Highest number of database connections that were in use by applications or being tested by the system in this instance of the data source since the data source was deployed.

Specified by:

getHighestNumUnavailable in interface JDBCDataSourceRuntimeMBean

Returns:

The highest number of connections used in this pool.

getActiveConnectionsAverageCount

public int getActiveConnectionsAverageCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

Average number of active connections in this instance of the data source.

Active connections are connections in use by an application. This value is only valid if the resource is configured to allow shrinking.

Specified by:

getActiveConnectionsAverageCount in interface JDBCDataSourceRuntimeMBean

Returns:

The running average of active connections.

getReserveRequestCount

public long getReserveRequestCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative, running count of requests for a connection from this data source.

Specified by:

getReserveRequestCount in interface JDBCDataSourceRuntimeMBean

Returns:

The cumulative count of requests for connections from this data source.

getFailedReserveRequestCount

public long getFailedReserveRequestCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative, running count of requests for a connection from this data source that could not be fulfilled.

Specified by:

getFailedReserveRequestCount in interface JDBCDataSourceRuntimeMBean

Returns:

The cumulative count of failed requests for a connection from this data source.

getRepurposeCount

public long getRepurposeCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The number of times connections have been repurposed since the datasource was deployed.

Specified by:

getRepurposeCount in interface JDBCDataSourceRuntimeMBean

Returns:

The repurpose count.

getFailedRepurposeCount

public long getFailedRepurposeCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The number of repurpose errors that have occurred since the datasource was deployed.

Specified by:

getFailedRepurposeCount in interface JDBCDataSourceRuntimeMBean

Returns:

The number of repurpose errors.

getResolvedAsCommittedTotalCount

public long getResolvedAsCommittedTotalCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative total number of commit outcomes successfully resolved as committed in this data source since the data source was deployed. This does not refer to the number of outcome query retries used to resolve the outcomes.

Specified by:

getResolvedAsCommittedTotalCount in interface JDBCDataSourceRuntimeMBean

Returns:

The cumulative total of successful commit outcomes resolved as committed in this data source.

getResolvedAsNotCommittedTotalCount

public long getResolvedAsNotCommittedTotalCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative total number of commit outcomes successfully resolved as not committed in this data source since the data source was deployed. This does not refer to the number of outcome query retries used to resolve the outcomes.

Specified by:

getResolvedAsNotCommittedTotalCount in interface JDBCDataSourceRuntimeMBean

Returns:

The cumulative total of successful commit outcomes resolved as not committed in this data source.

getUnresolvedTotalCount

public long getUnresolvedTotalCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative total number of commit outcomes unsuccessfully resolved in this data source since the data source was deployed. This does not refer to the number of outcome query retries used to resolve the outcomes.

Specified by:

getUnresolvedTotalCount in interface JDBCDataSourceRuntimeMBean

Returns:

The cumulative total of unsuccessful commit outcomes resolved in this data source.

getCommitOutcomeRetryTotalCount

public long getCommitOutcomeRetryTotalCount()

Description copied from interface: JDBCDataSourceRuntimeMBean

The cumulative total number of commit outcome query retries conducted before resolving the outcome or exceeding the retry seconds in this data source since the data source was deployed.

Specified by:

getCommitOutcomeRetryTotalCount in interface JDBCDataSourceRuntimeMBean

Returns:

The cumulative total of commit outcome query retries in this data source.

shrink

public void shrink()
            throws ResourceException

Description copied from interface: JDBCDataSourceRuntimeMBean

Shrinks the database connection pool in the data source to either the current number of reserved connections or the initial size of the connection pool, which ever is greater.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

shrink in interface JDBCDataSourceRuntimeMBean

Throws:

ResourceException

reset

public void reset()
           throws ResourceException

Description copied from interface: JDBCDataSourceRuntimeMBean

Resets the connection pool in the data source by shutting down and recreating all available database connections in the pool.

Use when a data source is in the health state of Unhealthy and needs to be reinitialized.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

reset in interface JDBCDataSourceRuntimeMBean

Throws:

ResourceException

suspend

public void suspend()
             throws ResourceException

Description copied from interface: JDBCDataSourceRuntimeMBean

Synchronously, gracefully suspends a data source that has the health state of Running and disables existing connections. This operation immediately marks the data source as suspended and no further connections are created. Idle (not reserved) connections are marked as disabled. After a timeout period for the suspend operation, all remaining connections in the pool are marked as suspended and the following exception is thrown for any operations on the connection, indicating that the data source is suspended: java.sql.SQLRecoverableException: Connection has been administratively disabled. Try later. If graceful suspend is done as part of a graceful shutdown operation, connections are immediately closed when no longer reserved or at the end of the timeout period. If not done as part of a shutdown operation, these connections remain in the pool and are not closed because the pool may be resumed.

By default, the timeout period is 60 seconds. You can change the value of this timeout period by configuring or dynamically setting Inactive Connection Timeout Seconds to a non-zero value.

Setting IgnoreInUseConnectionsEnabled to false causes the operation to fail if in-use connections exist.

If successful, the health state is set to Suspended.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

suspend in interface JDBCDataSourceRuntimeMBean

Throws:

ResourceException

forceSuspend

public void forceSuspend()
                  throws ResourceException

Description copied from interface: JDBCDataSourceRuntimeMBean

Forcefully suspends a data source that has the health state of Running, including disconnecting all current connection users. All current connections are closed and recreated.

If successful, the health state is set to Suspended.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

forceSuspend in interface JDBCDataSourceRuntimeMBean

Throws:

ResourceException

resume

public void resume()
            throws ResourceException

Description copied from interface: JDBCDataSourceRuntimeMBean

Restores all access to and operations on a data source that has a health state of Suspended.

If successful, the health state is set to Running.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

resume in interface JDBCDataSourceRuntimeMBean

Throws:

ResourceException

shutdown

public void shutdown()
              throws ResourceException

Description copied from interface: JDBCDataSourceRuntimeMBean

Gracefully, synchronously shuts down a data source that has a health state of Running. A graceful (non-forced) datasource shutdown operation involves first gracefully suspending the data source and then releasing the associated resources including the connections. See the description above for details of gracefully suspending the datasource. After the datasource is gracefully suspended, all remaining in-use connections are closed and the datasource is marked as shut down.

If successful, the health state is set to Shutdown.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

shutdown in interface JDBCDataSourceRuntimeMBean

Throws:

ResourceException

forceShutdown

public void forceShutdown()
                   throws ResourceException

Description copied from interface: JDBCDataSourceRuntimeMBean

Forcefully shuts down a data source that has a health state of Running, including forcing the disconnection of all current connection users.

If successful, the health state is set to Shutdown.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

forceShutdown in interface JDBCDataSourceRuntimeMBean

Throws:

ResourceException

suspend

public JDBCDataSourceTaskRuntimeMBean suspend(int operationSecs)
                                       throws ResourceException

Description copied from interface: JDBCDataSourceRuntimeMBean

Asynchronously, gracefully suspends a data source that has the health state of Running and disables existing connections. This operation immediately marks the data source as suspended and no further connections are created. Idle (not reserved) connections are marked as disabled. After a timeout period for the suspend operation, all remaining connections in the pool are marked as suspended and the following exception is thrown for any operations on the connection, indicating that the data source is suspended: java.sql.SQLRecoverableException: Connection has been administratively disabled. Try later. These connections remain in the pool and are not closed because the pool may be resumed.

Setting IgnoreInUseConnectionsEnabled to false causes the operation to fail if in-use connections exist.

If successful, the health state is set to Suspended.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

suspend in interface JDBCDataSourceRuntimeMBean

Parameters:

operationSecs - The number of seconds to allow the operation to run before stopping processing. If set to 0, the default is used. The default is to use Inactive Connection Timeout Seconds if set or 60 seconds. If you want a minimal timeout, set the value to 1. If you want no timeout, set it to a large value (not recommended).

Returns:

The task so that status of the background operation can be checked. The task getProgress() method returns TaskRuntimeMBean.PROGRESS_SUCCESS ("success"), TaskRuntimeMBean.PROGRESS_FAILED ("failed"), or TaskRuntimeMBean.PROGRESS_PROCESSING ("processing"). The getStatus() method returns "SUCCESS", "FAILURE", and now "PROCESSING".

Throws:

ResourceException

shutdown

public JDBCDataSourceTaskRuntimeMBean shutdown(int operationSecs)
                                        throws ResourceException

Description copied from interface: JDBCDataSourceRuntimeMBean

Gracefully, asynchronously shuts down a data source that has a health state of Running. A graceful (non-forced) datasource shutdown operation involves first gracefully suspending the data source and then releasing the associated resources including the connections. See the description above for details of gracefully suspending the datasource. After the datasource is gracefully suspended, all remaining in-use connections are closed and the datasource is marked as shut down.

Setting IgnoreInUseConnectionsEnabled to false causes the operation to fail if in-use connections exist.

If successful, the health state is set to Shutdown.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

shutdown in interface JDBCDataSourceRuntimeMBean

Parameters:

operationSecs - The number of seconds to allow the operation to run before stopping processing. If set to 0, the default is used. The default is to use Inactive Connection Timeout Seconds if set or 60 seconds. If you want a minimal timeout, set the value to 1. If you want no timeout, set it to a large value (not recommended).

Returns:

The task so that status of the background operation can be checked. The task getProgress() method returns TaskRuntimeMBean.PROGRESS_SUCCESS ("success"), TaskRuntimeMBean.PROGRESS_FAILED ("failed"), or TaskRuntimeMBean.PROGRESS_PROCESSING ("processing"). The getStatus() method returns "SUCCESS", "FAILURE", and now "PROCESSING".

Throws:

ResourceException

setTask

private JDBCDataSourceTaskRuntimeMBeanImpl setTask(boolean shutdown)

doOperation

private void doOperation(boolean shutdown,
                         int operationSecs,
                         JDBCDataSourceTaskRuntimeMBeanImpl task)
                  throws ResourceException

Throws:

ResourceException

getProperties

public java.util.Properties getProperties()
                                   throws ResourceException

Return the properties for a pool.

This is a privileged method, and can only be invoked on a client that has specified an authorized Principal.

Specified by:

getProperties in interface JDBCDataSourceRuntimeMBean

Returns:

The properties for a data source.

Throws:

java.lang.Exception - if there is an error

ResourceException

poolExists

public boolean poolExists(java.lang.String poolName)
                   throws java.lang.Exception

Does a pool with the given name exist?

This is a privileged method, and can only be invoked on a client that has specified an authorized Principal.

Specified by:

poolExists in interface JDBCDataSourceRuntimeMBean

Parameters:

name - Name of the pool being looked for

Throws:

java.lang.Exception - if there is an error

clearStatementCache

public void clearStatementCache()
                         throws java.lang.Exception

Clears the cache of Prepared and Callable Statements maintained for each connection in the pool.

Specified by:

clearStatementCache in interface JDBCDataSourceRuntimeMBean

Throws:

java.lang.Exception - if there is an error

dumpPool

public void dumpPool()
              throws java.lang.Exception

Description copied from interface: JDBCDataSourceRuntimeMBean

Prints out information about all the connections in the connection pool in the data source.

Specified by:

dumpPool in interface JDBCDataSourceRuntimeMBean

Throws:

java.lang.Exception

dumpPoolProfile

public void dumpPoolProfile()
                     throws java.lang.Exception

Description copied from interface: JDBCDataSourceRuntimeMBean

Prints out profile information about the data source.

Specified by:

dumpPoolProfile in interface JDBCDataSourceRuntimeMBean

Throws:

java.lang.Exception

setJDBCDriverRuntime

public void setJDBCDriverRuntime(JDBCDriverRuntimeMBean mbean)

Description copied from interface: JDBCDataSourceRuntimeMBean

Sets the JDBCDriverRuntimeMBean associated with this data source.

Specified by:

setJDBCDriverRuntime in interface JDBCDataSourceRuntimeMBean

getJDBCDriverRuntime

public JDBCDriverRuntimeMBean getJDBCDriverRuntime()

Description copied from interface: JDBCDataSourceRuntimeMBean

Gets the JDBCDriverRuntimeMBean associated with this data source.

Specified by:

getJDBCDriverRuntime in interface JDBCDataSourceRuntimeMBean

getLastTask

public JDBCDataSourceTaskRuntimeMBean getLastTask()

Description copied from interface: JDBCDataSourceRuntimeMBean

Get the last datasource Task

Specified by:

getLastTask in interface JDBCDataSourceRuntimeMBean

Returns:

the last completed or pending datasource task.

getTasks

public JDBCDataSourceTaskRuntimeMBean[] getTasks()

Get preexisting DataSource Tasks

Specified by:

getTasks in interface JDBCDataSourceRuntimeMBean

Returns:

a list of all completed or pending datasource tasks.

start

public void start()
           throws java.lang.Exception

Description copied from interface: JDBCDataSourceRuntimeMBean

Starts a data source that has a health state of Shutdown.

If successful, the health state is set to Running.

This is a privileged operation that can only be invoked by an authorized user.

Specified by:

start in interface JDBCDataSourceRuntimeMBean

Throws:

java.lang.Exception - if there is an error

isOperationAllowed

public boolean isOperationAllowed(java.lang.String operation)
                           throws java.lang.IllegalArgumentException

Description copied from interface: JDBCDataSourceRuntimeMBean

Indicates whether the specified operation is valid based on the state of the underlying DataSource.

Specified by:

isOperationAllowed in interface JDBCDataSourceRuntimeMBean

Parameters:

operation - The name of the operation to be performed. Valid values include: Start, Shutdown, Suspend, Resume, Reset, Shrink, Clear

Returns:

True if the state of the Data Source permits the specified operation, false otherwise.

Throws:

java.lang.IllegalArgumentException - Thrown when operation parameter is not recognized as a supported operation.

clearCachedValues

private void clearCachedValues()

lookupMetaData

protected void lookupMetaData()
                       throws ResourceException,
                              java.sql.SQLException

Throws:

ResourceException

java.sql.SQLException

getMetaData

private void getMetaData()
                  throws ResourceException,
                         java.sql.SQLException

Throws:

ResourceException

java.sql.SQLException

getDatabaseProductName

public java.lang.String getDatabaseProductName()
                                        throws java.rmi.RemoteException

Description copied from interface: JDBCDataSourceRuntimeMBean

The product name of the database that this data source is connected to.

Specified by:

getDatabaseProductName in interface JDBCDataSourceRuntimeMBean

Returns:

The product name of the connected database

Throws:

java.rmi.RemoteException - Thrown when the operation is unable to obtain the attribute from the JDBC meta data.

getDatabaseProductVersion

public java.lang.String getDatabaseProductVersion()
                                           throws java.rmi.RemoteException

Description copied from interface: JDBCDataSourceRuntimeMBean

The product version of the database that this data source is connected to.

Specified by:

getDatabaseProductVersion in interface JDBCDataSourceRuntimeMBean

Returns:

The product version of the connected database

Throws:

java.rmi.RemoteException - Thrown when the operation is unable to obtain the attribute from the JDBC meta data.

getDriverName

public java.lang.String getDriverName()
                               throws java.rmi.RemoteException

Description copied from interface: JDBCDataSourceRuntimeMBean

The product name of the JDBC driver that this data source is configured to use.

Specified by:

getDriverName in interface JDBCDataSourceRuntimeMBean

Returns:

The product name of the JDBC driver

Throws:

java.rmi.RemoteException - Thrown when the operation is unable to obtain the attribute from the JDBC meta data.

getDriverVersion

public java.lang.String getDriverVersion()
                                  throws java.rmi.RemoteException

Description copied from interface: JDBCDataSourceRuntimeMBean

The version of the JDBC driver that this data source is configured to use.

Specified by:

getDriverVersion in interface JDBCDataSourceRuntimeMBean

Returns:

The version of the JDBC driver

Throws:

java.rmi.RemoteException - Thrown when the operation is unable to obtain the attribute from the JDBC meta data.

getJDBCReplayStatisticsRuntimeMBean

public JDBCReplayStatisticsRuntimeMBean getJDBCReplayStatisticsRuntimeMBean()
                                                                     throws java.lang.Exception

Description copied from interface: JDBCDataSourceRuntimeMBean

Get the statistics for replay only if the datasource is using an Oracle replay driver for 12.1.0.2 and later. Otherwise, null is returned. The statistics are a snapshort. To update the snapshot, call refreshStatistics() on the mbean.

Specified by:

getJDBCReplayStatisticsRuntimeMBean in interface JDBCDataSourceRuntimeMBean

Returns:

The associated replay statistics mbean or null if not available.

Throws:

java.lang.Exception - Thown when an error occurs getting the statistics.

clearOldTaskRuntimes

public void clearOldTaskRuntimes()

throwGroupOperationUnsupported

private void throwGroupOperationUnsupported()

resetStatistics

public void resetStatistics()

Description copied from interface: JDBCDataSourceRuntimeMBean

Reset statistics counters to zero.

Specified by:

resetStatistics in interface JDBCDataSourceRuntimeMBean