JDBCUCPDataSourceRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Runtime MBean that represents a UCP JDBC data source.

       
Since12.2.1.0.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.JDBCUCPDataSourceRuntimeMBean
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:
    Access Points Inherited from JDBCDataSourceRuntimeMBean Because this MBean extends or implements JDBCDataSourceRuntimeMBean, you can also access this MBean by retrieving JDBCDataSourceRuntimeMBeans. The following attributes contain JDBCDataSourceRuntimeMBeans and its subtypes:
      Access Points Inherited from RuntimeMBean Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:


      Related MBeans

      This section describes attributes that provide access to other MBeans.


      JDBCDriverRuntime

      Gets the JDBCDriverRuntimeMBean associated with this data source.

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeJDBCDriverRuntimeMBean
      Relationship type: Containment.

      JDBCReplayStatisticsRuntimeMBean

      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.

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeJDBCReplayStatisticsRuntimeMBean
      Relationship type: Containment.

      LastTask

      Get the last datasource Task

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeJDBCDataSourceTaskRuntimeMBean
      Relationship type: Containment.

      Tasks

      Get preexisting datasource Tasks

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeJDBCDataSourceTaskRuntimeMBean[]
      Relationship type: Containment.

      WorkManagerRuntimes

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

             
      Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
      Privileges Read only
      TypeWorkManagerRuntimeMBean[]
      Relationship type: Containment.


      Attributes

      This section describes the following attributes:


      ActiveConnectionsAverageCount

      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.

             
      Privileges Read only
      Typeint

      ActiveConnectionsCurrentCount

      The number of connections currently in use by applications.

             
      Privileges Read only
      Typeint

      ActiveConnectionsHighCount

      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.

             
      Privileges Read only
      Typeint

      CachingDisabled

      Private property that disables caching in proxies.

             
      Privileges Read only
      Typeboolean

      ConnectionDelayTime

      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.

             
      Privileges Read only
      Typeint

      ConnectionsTotalCount

      The cumulative total number of database connections created in this data source since the data source was deployed.

             
      Privileges Read only
      Typeint

      CurrCapacity

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

             
      Privileges Read only
      Typeint

      CurrCapacityHighCount

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

             
      Privileges Read only
      Typeint

      DatabaseProductName

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

             
      Privileges Read only
      Typejava.lang.String

      DatabaseProductVersion

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

             
      Privileges Read only
      Typejava.lang.String

      DeploymentState

      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.

      For more information, see:

             
      Privileges Read only
      Typeint

      DriverName

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

             
      Privileges Read only
      Typejava.lang.String

      DriverVersion

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

             
      Privileges Read only
      Typejava.lang.String

      Enabled

      Indicates whether the data source is enabled or disabled:

             
      Privileges Read only
      Typeboolean

      FailedReserveRequestCount

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

             
      Privileges Read only
      Typelong

      FailuresToReconnectCount

      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.

             
      Privileges Read only
      Typeint

      HighestNumAvailable

      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.

             
      Privileges Read only
      Typeint

      HighestNumUnavailable

      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.

             
      Privileges Read only
      Typeint

      LeakedConnectionCount

      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().

             
      Privileges Read only
      Typeint

      MBeanInfo

      Returns the MBean info for this MBean.

      Deprecated.

             
      Privileges Read only
      Typejavax.management.MBeanInfo

      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
      Typejava.lang.String

      Name

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

             
      Privileges Read only
      Typejava.lang.String

      NumAvailable

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

             
      Privileges Read only
      Typeint

      NumUnavailable

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

             
      Privileges Read only
      Typeint

      ObjectName

      Returns the ObjectName under which this MBean is registered in the MBean server.

      Deprecated.

             
      Privileges Read only
      Typeweblogic.management.WebLogicObjectName

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      PrepStmtCacheAccessCount

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

             
      Privileges Read only
      Typelong

      PrepStmtCacheAddCount

      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.

             
      Privileges Read only
      Typelong

      PrepStmtCacheCurrentSize

      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.

             
      Privileges Read only
      Typeint

      PrepStmtCacheDeleteCount

      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.

             
      Privileges Read only
      Typelong

      PrepStmtCacheHitCount

      The cumulative, running count of the number of times that statements from the cache were used.

             
      Privileges Read only
      Typeint

      PrepStmtCacheMissCount

      The number of times that a statement request could not be satisfied with a statement from the cache.

             
      Privileges Read only
      Typeint

      Properties

      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.

             
      Privileges Read only
      Typejava.util.Properties

      Registered

      Returns false if the MBean represented by this object has been unregistered.

      Deprecated.

             
      Privileges Read only
      Typeboolean

      ReserveRequestCount

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

             
      Privileges Read only
      Typelong

      State

      The current state of the data source.

      Possible states are:

             
      Privileges Read only
      Typejava.lang.String

      Type

      Returns the type of the MBean.

             
      Privileges Read only
      Typejava.lang.String

      VersionJDBCDriver

      The driver class name of the JDBC driver used to create database connections.

             
      Privileges Read only
      Typejava.lang.String

      WaitingForConnectionCurrentCount

      The number of connection requests waiting for a database connection.

             
      Privileges Read only
      Typeint

      WaitingForConnectionFailureTotal

      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.

             
      Privileges Read only
      Typelong

      WaitingForConnectionHighCount

      Highest number of application requests concurrently waiting for a connection from this instance of the data source.

             
      Privileges Read only
      Typeint

      WaitingForConnectionSuccessTotal

      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.

             
      Privileges Read only
      Typelong

      WaitingForConnectionTotal

      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.

             
      Privileges Read only
      Typelong

      WaitSecondsHighCount

      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.

             
      Privileges Read only
      Typeint


      Operations

      This section describes the following operations:


      clearStatementCache

      For each connection in the connection pool, clears the statement cache of Prepared and Callable Statements.

         
      Operation Name"clearStatementCache"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      dumpPool

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

         
      Operation Name"dumpPool"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      dumpPoolProfile

      Prints out profile information about the data source.

         
      Operation Name"dumpPoolProfile"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      forceShutdown

      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.

         
      Operation Name"forceShutdown"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      forceSuspend

      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.

         
      Operation Name"forceSuspend"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      poolExists

      Specifies whether a data source with the given name exists.

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

         
      Operation Name"poolExists"
      ParametersObject [] {  poolName }

      where:

      • poolName is an object of type java.lang.String that specifies:

        Name of the pool being looked for

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • java.lang.Exception

      reset

      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.

         
      Operation Name"reset"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      resume

      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.

         
      Operation Name"resume"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      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.

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

         
      Operation Name"shrink"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      shutdown

      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.

         
      Operation Name"shutdown"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      shutdown

      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.

         
      Operation Name"shutdown"
      ParametersObject [] {  operationSecs }

      where:

      • operationSecs is an object of type java.lang.Integer that specifies:

        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).

      SignatureString [] { "java.lang.Integer" }
      ReturnsJDBCDataSourceTaskRuntimeMBean
      Exceptions
      • java.lang.Exception

      start

      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.

         
      Operation Name"start"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      suspend

      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.

         
      Operation Name"suspend"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • java.lang.Exception

      suspend

      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.

         
      Operation Name"suspend"
      ParametersObject [] {  operationSecs }

      where:

      • operationSecs is an object of type java.lang.Integer that specifies:

        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).

      SignatureString [] { "java.lang.Integer" }
      ReturnsJDBCDataSourceTaskRuntimeMBean
      Exceptions
      • java.lang.Exception

      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.

      For more information, see:

         
      Operation Name"testPool"
      Parametersnull
      Signaturenull
      ReturnsString