# JDBCConnectionPoolRuntimeMBean

Overview | Related MBeans | Attributes | Operations

## Overview

This class is used for monitoring a WebLogic JDBC component

Deprecated. 9.0.0.0 Replaced by JDBCDataSourceRuntimeMBean

Fully Qualified Interface Name | If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.management.runtime.JDBCConnectionPoolRuntimeMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points Inherited from ComponentRuntimeMBean | Because this MBean extends or implements ComponentRuntimeMBean, you can also access this MBean by retrieving ComponentRuntimeMBeans. The following attributes contain ComponentRuntimeMBeans and its subtypes:
ApplicationRuntimeMBean.ComponentRuntimes |

## Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

WorkManagerRuntimes |

### WorkManagerRuntimes

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

Privileges | Read only
Type | WorkManagerRuntimeMBean[]
Relationship type: | Reference.

## Attributes

This section describes the following attributes:

ActiveConnectionsAverageCount ActiveConnectionsCurrentCount ActiveConnectionsHighCount ConnectionDelayTime ConnectionLeakProfileCount ConnectionsTotalCount CurrCapacity DeploymentState Enabled FailuresToReconnectCount HighestNumAvailable HighestNumUnavailable LeakedConnectionCount MaxCapacity ModuleId | Name NumAvailable NumUnavailable Parent PoolState Properties State StatementProfileCount Type VersionJDBCDriver WaitingForConnectionCurrentCount WaitingForConnectionHighCount WaitSecondsHighCount

### ActiveConnectionsAverageCount

Privileges | Read only
Type | int

### ActiveConnectionsCurrentCount

Privileges | Read only
Type | int

### ActiveConnectionsHighCount

Privileges | Read only
Type | int

### ConnectionDelayTime

Privileges | Read only
Type | int

### ConnectionLeakProfileCount

Connection leak is a situation when connection from the pool was not closed explicitly by calling close() and was garbage collected.

This method should be used first before requesting connection leak profiles from the profile storage.

Privileges | Read only
Type | int

### ConnectionsTotalCount

The total number of JDBC connections in this `JDBCConnectionPoolRuntimeMBean` since the pool has been instantiated.

Privileges | Read only
Type | int

### CurrCapacity

The current capacity of this connection pool.

Privileges | Read only
Type | int

### DeploymentState

The current deployment state of the module.

Privileges | Read only
Type | int

### Enabled

Privileges | Read only
Type | boolean

### FailuresToReconnectCount

Privileges | Read only
Type | int

### HighestNumAvailable

The highest number of available connections in this pool.

Privileges | Read only
Type | int

### HighestNumUnavailable

The highest number of unavailable connections in this pool.

Privileges | Read only
Type | int

### LeakedConnectionCount

Privileges | Read only
Type | int

### MaxCapacity

The maximum capacity of this connection pool.

Privileges | Read only
Type | int

### ModuleId

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.

Privileges | Read only
Type | java.lang.String

### Name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Privileges | Read only
Type | java.lang.String

### NumAvailable

The number of available connections in this pool.

Privileges | Read only
Type | int

### NumUnavailable

The number of unavailable connections in this pool.

Privileges | Read only
Type | int

### Parent

Return the immediate parent for this MBean

Privileges | Read/Write
Type |

### PoolState

Privileges | Read only
Type | boolean

### Properties

Returns the properties for a pool.

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

Privileges | Read only
Type | java.util.Properties

### State

The current state of the connection pool.

Possible values are:

- `Running`

  if the pool is enabled (deployed and not SUSPENDED). This is the normal state of the connection pool.

- `Suspended`

  if the pool disabled.

- `Shutdown`

  if the pool is shutdown and all database connections have been closed.

- `Unknown`

  if the pool state is unknown.

- `Unhealthy`

  if all connections are unavailable (not because they are in use). This state occurs if the database server is unavailable when the connection pool is created (creation retry must be enabled) or if all connections have failed connection tests (on creation, on reserve, on release, or periodic testing).

Privileges | Read only
Type | java.lang.String

### StatementProfileCount

SQL roundtrip profiling stores SQL statement text, execution time and other metrics.

This method should be used first before requesting SQL statement profiles from the profile storage.

Privileges | Read only
Type | int

### Type

Returns the type of the MBean.

Privileges | Read only
Type | java.lang.String

### VersionJDBCDriver

Privileges | Read only
Type | java.lang.String

### WaitingForConnectionCurrentCount

Privileges | Read only
Type | int

### WaitingForConnectionHighCount

Privileges | Read only
Type | int

### WaitSecondsHighCount

Privileges | Read only
Type | int

## Operations

This section describes the following operations:

clearStatementCache disableDroppingUsers disableFreezingUsers dumpPool enable forceShutdown forceSuspend getConnectionLeakProfiles getStatementProfiles poolExists | reset resetConnectionLeakProfile resetStatementProfile resume shrink shutdown suspend testPool

### clearStatementCache

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

Operation Name | `"clearStatementCache"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### disableDroppingUsers

Disable the pool, immediately disconnecting all users.

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

For more information, see:

- JDBCConnectionPoolRuntimeMBean#forceSuspend

Operation Name | `"disableDroppingUsers"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### disableFreezingUsers

Disable the pool, suspending all operations on pool connections until the pool is re-enabled.

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

For more information, see:

- JDBCConnectionPoolRuntimeMBean#suspend

Operation Name | `"disableFreezingUsers"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### dumpPool

Prints out the data structure of the connection pool in the following lists:

- alvList - lists details about database connections in the connection pool that are not currently in use by a client.

- unavlList - lists details about database connections that WebLogic Server failed to create on server startup or failed to recreate after a failed database connection test.

- resvList - lists details about database connections in teh connection pool that are currently in use by a client.

Operation Name | `"dumpPool"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### enable

Restore all access to and operations on the pool.

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

For more information, see:

- JDBCConnectionPoolRuntimeMBean#resume

Operation Name | `"enable"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### forceShutdown

Forcibly shuts down the connection pool. All current users of the pool are forcibly disconnected.

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

Operation Name | `"forceShutdown"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### forceSuspend

Forcibly disables the pool, suspending all operations on pool connections until the pool is re-enabled. All current users of the pool are forcibly disconnected. All connections currently in use are closed and recreated.

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

Operation Name | `"forceSuspend"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### getConnectionLeakProfiles

Connection leak profiling stores stack trace at the time when connection was created in case of connection leak. This enables you to identify where the leak occurred.

Connection leak is a situation when connection from the pool was not closed explicitly by calling close() and was garbage collected.

For more information, see:

- JDBCConnectionLeakProfile

Operation Name | `"getConnectionLeakProfiles"`
Parameters | `Object [] { }` where:
Signature | `String [] { "java.lang.Integer", "java.lang.Integer" }`
Returns | `class`

### getStatementProfiles

SQL roundtrip profiling stores SQL statement text, execution time and other metrics.

For more information, see:

- JDBCStatementProfile

Operation Name | `"getStatementProfiles"`
Parameters | `Object [] { }` where:
Signature | `String [] { "java.lang.Integer", "java.lang.Integer" }`
Returns | `class`

### poolExists

Indicates whether the specified pool exists.

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

Operation Name | `"poolExists"`
Parameters | `Object [] { name }` where: `name` is an object of type `java.lang.String` that specifies: Name of the pool being looked for
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`
Exceptions | `java.lang.Exception`

### reset

Resets the connection pool by shutting down and reestablishing all the pool connections. This method should be used when the connection pool is in a bad state and needs to be reinitialized.

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

Operation Name | `"reset"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### resetConnectionLeakProfile

Resets connection leak profile.

Operation Name | `"resetConnectionLeakProfile"`
Parameters | `null`
Signature | `null`
Returns | `void`

### resetStatementProfile

Resets SQL statement profile.

Operation Name | `"resetStatementProfile"`
Parameters | `null`
Signature | `null`
Returns | `void`

### resume

Restores all access to and operations on a connection pool that has been suspended (marked as disabled).

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

Operation Name | `"resume"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### shrink

Shrinks the named database ConnectionPool to the max of the currently reserved connections or the initial size.

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

Operation Name | `"shrink"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### shutdown

Shuts down the pool. If any connections from the pool are currently in use, the operation will fail.

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

Operation Name | `"shutdown"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### suspend

Disables the connection pool, suspending all operations on pool connections until the pool is re-enabled.

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

Operation Name | `"suspend"`
Parameters | `null`
Signature | `null`
Returns | `void`
Exceptions | `java.lang.Exception`

### testPool

Test the pool by reserving and releasing a connection from it. If the pool configuration attribute TestConnectionsOnReserve or TestConnectionsOnRelease is enabled, the acquired connection is also tested as part of the reserve and release operation.

For more information, see:

- JDBCConnectionPoolMBean

Operation Name | `"testPool"`
Parameters | `null`
Signature | `null`
Returns | `String`