|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-01 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JDBCDataSourceRuntimeMBean
This class is used for monitoring a WebLogic JDBC Data Source and its associated connection pool.
Field Summary |
---|
Fields inherited from interface weblogic.management.runtime.ComponentRuntimeMBean |
---|
ACTIVATED, NEW, PREPARED, UNPREPARED |
Method Summary | |
---|---|
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()
Shuts down a data source that has a health state of Running ,
including forcing the disconnection of all current connection users. |
void |
forceSuspend()
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. |
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. |
String |
getDatabaseProductName()
The product name of the database that this data source is connected to. |
String |
getDatabaseProductVersion()
The product version of the database that this data source is connected to. |
String |
getDriverName()
The product name of the JDBC driver that this data source is configured to use. |
String |
getDriverVersion()
The version of the JDBC driver that this data source is configured to use. |
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. |
JDBCDataSourceTaskRuntimeMBean |
getLastTask()
|
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. |
Properties |
getProperties()
The list of properties for a data source that are passed to the JDBC driver when creating database connections. |
long |
getReserveRequestCount()
The cumulative, running count of requests for a connection from this data source. |
String |
getState()
The current state of the data source. |
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: true if the data source is enabled.
false if the data source is disabled.
|
boolean |
poolExists(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 |
resume()
Restores all access to and operations on a data source that has a health state of Suspended . |
void |
setJDBCDriverRuntime(JDBCDriverRuntimeMBean mbean)
Sets the JDBCDriverRuntimeMBean associated with this data source. |
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()
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()
Suspends a data source has the health state of Running and
disables existing connections. |
String |
testPool()
Tests the connection pool in the data source by reserving and releasing a connection from it. |
Methods inherited from interface weblogic.management.runtime.ComponentRuntimeMBean |
---|
getDeploymentState, getModuleId, getWorkManagerRuntimes |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Method Detail |
---|
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.
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()
true
if the data source is enabled.false
if the data source is disabled.
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.
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.
void shrink() throws 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.
Exception
- if there is an errorvoid reset() throws 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.
Exception
- if there is an errorvoid suspend() throws Exception
Suspends a data source has the health state of Running
and
disables existing connections. If any connections from the data source are
currently in use, the operation fails and the health state remains Running
.
If successful, the health state is set to Suspended
.
This is a privileged operation that can only be invoked by an authorized user.
Exception
- if there is an errorvoid forceSuspend() throws Exception
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.
Exception
- if there is an errorvoid shutdown() throws Exception
Shuts down a data source that has a health state of Running
. If any connections from the data source are
currently in use, the operation fails and the health state remains Running
.
If successful, the health state is set to Shutdown
.
This is a privileged operation that can only be invoked by an authorized user.
Exception
- if there is an errorvoid forceShutdown() throws Exception
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.
Exception
- if there is an errorvoid resume() throws 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.
Exception
- if there is an errorvoid start() throws 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.
Exception
- if there is an errorProperties getProperties() throws 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.
Exception
- if there is an errorboolean poolExists(String poolName) throws 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 for
Exception
- if there is an errorvoid clearStatementCache() throws Exception
For each connection in the connection pool, clears the statement cache of Prepared and Callable Statements.
Exception
- if there is an errorvoid dumpPool() throws Exception
Prints out information about all the connections in the connection pool in the data source.
Exception
void dumpPoolProfile() throws Exception
Prints out profile information about the data source.
Exception
void setJDBCDriverRuntime(JDBCDriverRuntimeMBean mbean)
Sets the JDBCDriverRuntimeMBean associated with this data source.
JDBCDriverRuntimeMBean getJDBCDriverRuntime()
Gets the JDBCDriverRuntimeMBean associated with this data source.
JDBCDataSourceTaskRuntimeMBean getLastTask()
String getDatabaseProductName() throws RemoteException
The product name of the database that this data source is connected to.
RemoteException
- Thrown when the operation is unable to obtain the attribute from
the JDBC meta data.String getDatabaseProductVersion() throws RemoteException
The product version of the database that this data source is connected to.
RemoteException
- Thrown when the operation is unable to obtain the attribute from
the JDBC meta data.String getDriverName() throws RemoteException
The product name of the JDBC driver that this data source is configured to use.
RemoteException
- Thrown when the operation is unable to obtain the attribute from
the JDBC meta data.String getDriverVersion() throws RemoteException
The version of the JDBC driver that this data source is configured to use.
RemoteException
- Thrown when the operation is unable to obtain the attribute from
the JDBC meta data.
|
Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |