ComponentRuntimeMBean
, javax.management.DynamicMBean
, javax.management.MBeanRegistration
, javax.management.NotificationBroadcaster
, RuntimeMBean
, WebLogicMBean
JDBCOracleDataSourceRuntimeMBean
, JDBCProxyDataSourceRuntimeMBean
, JDBCUCPDataSourceRuntimeMBean
public interface JDBCDataSourceRuntimeMBean extends ComponentRuntimeMBean
This class is used for monitoring a WebLogic JDBC Data Source and its associated connection pool.
ACTIVATED, NEW, PREPARED, UNPREPARED
Modifier and Type | Method | Description |
---|---|---|
void |
clearStatementCache() |
For each connection in the connection pool, clears the
statement cache of Prepared and Callable Statements.
|
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() |
The number of connections currently in use by applications.
|
int |
getActiveConnectionsHighCount() |
Highest number of active database connections in this instance of the data source
since the data source was instantiated.
|
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() |
The average amount of time, in milliseconds, that it takes to create a physical connection
to the database.
|
int |
getConnectionsTotalCount() |
The cumulative total number of database connections
created in this data source since the data source was deployed.
|
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.
|
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() |
The number of times that the data source
attempted to refresh a database connection
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() |
The number of leaked connections.
|
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() |
The cumulative, running count of the number of times that
statements from the cache were used.
|
int |
getPrepStmtCacheMissCount() |
The number of times that a statement request could not be satisfied with a
statement from the cache.
|
java.util.Properties |
getProperties() |
The list of properties for a data source that are passed to the JDBC driver
when creating database connections.
|
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() |
The current state of the data source.
|
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() |
The driver class name of the JDBC driver used
to create database connections.
|
int |
getWaitingForConnectionCurrentCount() |
The number of connection requests waiting for a database 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() |
Highest number of application requests concurrently waiting for a connection
from this instance of the data source.
|
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() |
The highest number of seconds that an application waited for a connection
(the longest connection reserve wait time) from this instance of the connection
pool since the connection pool was instantiated.
|
boolean |
isEnabled() |
Indicates whether the data source is enabled or disabled:
|
boolean |
poolExists(java.lang.String poolName) |
Specifies whether a data source with the given name exists.
|
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 |
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.
|
getDeploymentState, getModuleId, getWorkManagerRuntimes
getAttribute, getAttributes, invoke, setAttribute, setAttributes
postDeregister, postRegister, preRegister
addNotificationListener, getNotificationInfo, removeNotificationListener
addPropertyChangeListener, removePropertyChangeListener
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
java.lang.String testPool()
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.
weblogic.management.configuration.JDBCConnectionPoolMBean
int getLeakedConnectionCount()
The number of leaked connections. A leaked connection is
a connection that was reserved from the data source
but was not returned to the data source by calling close()
.
boolean isEnabled()
Indicates whether the data source is enabled or disabled:
true
if the data source is enabled.false
if the data source is disabled.java.lang.String getState()
The current state of the data source.
Possible states are:
Running
- the data source is enabled (deployed and not Suspended
). This is the normal
state of the data source. This state includes conditions when the database server is
not available and the data source is created (creation retry must be enabled) or when
all connections have failed connection tests (on creation, on
reserve, or periodic testing).Suspended
- the data source has been disabled.Shutdown
- the data source is shutdown and all database connections have been closed.Overloaded
- all resources in pool are in use.Unknown
- the data source state is unknown.int getFailuresToReconnectCount()
The number of times that the data source attempted to refresh a database connection and failed.
Failures may occur when the database is unavailable or when the network connection to the database is interrupted.
int getConnectionDelayTime()
The average amount of time, in milliseconds, that it takes to create a physical connection to the database.
The value is calculated as summary of all times to connect divided by the total number of connections.
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.
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.
long getPrepStmtCacheDeleteCount()
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.
int getPrepStmtCacheCurrentSize()
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.
int getPrepStmtCacheHitCount()
The cumulative, running count of the number of times that statements from the cache were used.
int getPrepStmtCacheMissCount()
The number of times that a statement request could not be satisfied with a statement from the cache.
int getActiveConnectionsCurrentCount()
The number of connections currently in use by applications.
int getWaitingForConnectionCurrentCount()
The number of connection requests waiting for a database connection.
java.lang.String getVersionJDBCDriver()
The driver class name of the JDBC driver used to create database connections.
int getActiveConnectionsHighCount()
Highest number of active database connections in this instance of the data source since the data source was instantiated.
Active connections are connections in use by an application.
int getActiveConnectionsAverageCount()
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.
long getReserveRequestCount()
The cumulative, running count of requests for a connection from this data source.
long getFailedReserveRequestCount()
The cumulative, running count of requests for a connection from this data source that could not be fulfilled.
int getWaitingForConnectionHighCount()
Highest number of application requests concurrently waiting for a connection from this instance of the data source.
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.
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 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.
Waiting connection requests can fail for a variety of reasons, including waiting for longer than the ConnectionReserveTimeoutSeconds.
int getWaitSecondsHighCount()
The highest number of seconds that an application waited for a connection (the longest connection reserve wait time) from this instance of the connection pool since the connection pool was instantiated.
This value is updated when a completed getConnection
request takes longer to return a connection than any previous request.
int getConnectionsTotalCount()
The cumulative total number of database connections created in this data source since the data source was deployed.
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.
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 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 getNumUnavailable()
The number of connections currently in use by applications or being tested in this instance of the data source.
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.
long getRepurposeCount()
The number of times connections have been repurposed since the datasource was deployed.
long getFailedRepurposeCount()
The number of repurpose errors that have occurred since the datasource was deployed.
long getResolvedAsCommittedTotalCount()
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.
long getResolvedAsNotCommittedTotalCount()
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.
long getUnresolvedTotalCount()
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.
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.
void shrink() throws java.lang.Exception
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.
java.lang.Exception
- if there is an errorvoid reset() throws java.lang.Exception
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.
java.lang.Exception
- if there is an errorvoid suspend() throws java.lang.Exception
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.
java.lang.Exception
- if there is an errorvoid forceSuspend() throws java.lang.Exception
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.
java.lang.Exception
- if there is an errorvoid shutdown() throws java.lang.Exception
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.
java.lang.Exception
- if there is an errorvoid forceShutdown() throws java.lang.Exception
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.
java.lang.Exception
- if there is an errorvoid resume() throws java.lang.Exception
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.
java.lang.Exception
- if there is an errorvoid start() throws java.lang.Exception
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.
java.lang.Exception
- if there is an errorjava.util.Properties getProperties() throws java.lang.Exception
The list of properties for a data source that are passed to the JDBC driver when creating database connections.
This is a privileged operation that can only be invoked by an authorized user.
java.lang.Exception
- if there is an errorboolean poolExists(java.lang.String poolName) throws java.lang.Exception
Specifies whether a data source with the given name exists.
This is a privileged operation that can only be invoked by an authorized user.
poolName
- Name of the pool being looked forjava.lang.Exception
- if there is an errorvoid clearStatementCache() throws java.lang.Exception
For each connection in the connection pool, clears the statement cache of Prepared and Callable Statements.
java.lang.Exception
- if there is an errorvoid dumpPool() throws java.lang.Exception
Prints out information about all the connections in the connection pool in the data source.
java.lang.Exception
void dumpPoolProfile() throws java.lang.Exception
Prints out profile information about the data source.
java.lang.Exception
JDBCDriverRuntimeMBean getJDBCDriverRuntime()
Gets the JDBCDriverRuntimeMBean associated with this data source.
JDBCDataSourceTaskRuntimeMBean getLastTask()
Get the last datasource Task
JDBCDataSourceTaskRuntimeMBean[] getTasks()
Get preexisting datasource Tasks
java.lang.String getDatabaseProductName() throws java.rmi.RemoteException
The product name of the database that this data source is connected to.
java.rmi.RemoteException
- Thrown when the operation is unable to obtain the attribute from
the JDBC meta data.java.lang.String getDatabaseProductVersion() throws java.rmi.RemoteException
The product version of the database that this data source is connected to.
java.rmi.RemoteException
- Thrown when the operation is unable to obtain the attribute from
the JDBC meta data.java.lang.String getDriverName() throws java.rmi.RemoteException
The product name of the JDBC driver that this data source is configured to use.
java.rmi.RemoteException
- Thrown when the operation is unable to obtain the attribute from
the JDBC meta data.java.lang.String getDriverVersion() throws java.rmi.RemoteException
The version of the JDBC driver that this data source is configured to use.
java.rmi.RemoteException
- Thrown when the operation is unable to obtain the attribute from
the JDBC meta data.JDBCReplayStatisticsRuntimeMBean getJDBCReplayStatisticsRuntimeMBean() throws java.lang.Exception
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.
java.lang.Exception
- Thown when an error occurs getting the statistics.JDBCDataSourceTaskRuntimeMBean suspend(int operationSecs) throws java.lang.Exception
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.
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).java.lang.Exception
- if there is an errorJDBCDataSourceTaskRuntimeMBean shutdown(int operationSecs) throws java.lang.Exception
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.
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).java.lang.Exception
- if there is an errorvoid resetStatistics()