Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
12c Release 1 (12.1.1)

Part Number E24395-02

weblogic.management.runtime
Interface ConnectorConnectionPoolRuntimeMBean


public interface ConnectorConnectionPoolRuntimeMBean

This class is used for monitoring a WebLogic Connector Connection Pool

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/products/weblogic/index.html.

Since:
6.1.0.0

Method Summary
 void forceReset()
           Force immediately discard all used/unused connections and recreate connection pool (and using new configuration if user update the pool's configuration).
 int getActiveConnectionsCurrentCount()
          The current total active connections.
 int getActiveConnectionsHighCount()
          The high water mark of active connections in this Connector Pool since the pool was instantiated.
 int getAverageActiveUsage()
          The running average usage of created connections that are active in the Connector Pool since the pool was last shrunk.
 int getCapacityIncrement()
          The initial capacity configured for this Connector connection pool.
 long getCloseCount()
          The number of connections that were closed for the connection pool.
 String getConnectionFactoryClassName()
          The ConnectionFactoryName of this Connector connection pool.
 String getConnectionFactoryName()
          For 1.0 link-ref resource adapters only, the base resource adapter's connection factory name.
 int getConnectionIdleProfileCount()
          Deprecated.  
 ConnectionLeakProfile[] getConnectionIdleProfiles()
          Deprecated.  
 ConnectionLeakProfile[] getConnectionIdleProfiles(int index, int count)
          Deprecated.  
 int getConnectionLeakProfileCount()
          Deprecated.  
 ConnectionLeakProfile[] getConnectionLeakProfiles()
          Deprecated.  
 ConnectionLeakProfile[] getConnectionLeakProfiles(int index, int count)
          Deprecated.  
 boolean getConnectionProfilingEnabled()
          Deprecated.  
 ConnectorConnectionRuntimeMBean[] getConnections()
          An array of ConnectorConnectionRuntimeMBeans that each represents the statistics for a Connector Connection.
 int getConnectionsCreatedTotalCount()
          The total number of Connector connections created in this Connector Pool since the pool is instantiated.
 int getConnectionsDestroyedByErrorTotalCount()
          Return the number of connections that were destroyed because an error event was received.
 int getConnectionsDestroyedByShrinkingTotalCount()
          Return the number of connections that were destroyed as a result of shrinking.
 int getConnectionsDestroyedTotalCount()
          The total number of Connector connections destroyed in this Connector Pool since the pool is instantiated.
 int getConnectionsMatchedTotalCount()
          The total number of times a request for a Connector connections was satisfied via the use of an existing created connection since the pool is instantiated.
 int getConnectionsRejectedTotalCount()
          The total number of rejected requests for a Connector connections in this Connector Pool since the pool is instantiated.
 String getConnectorEisType()
          The EIS type of this Connector connection pool.
 long getCurrentCapacity()
          The PoolSize of this Connector connection pool.
 String getEISResourceId()
          The EISResourceId of this Connector connection pool.
 int getFreeConnectionsCurrentCount()
          The current total free connections.
 int getFreeConnectionsHighCount()
          The high water mark of free connections in this Connector Pool since the pool was instantiated.
 long getFreePoolSizeHighWaterMark()
          The FreePoolSizeHighWaterMark of this Connector connection pool.
 long getFreePoolSizeLowWaterMark()
          The FreePoolSizeLowWaterMark of this Connector connection pool.
 long getHighestNumWaiters()
          Gets the highest number of waiters.
 int getInitialCapacity()
          The initial capacity configured for this Connector connection pool.
 String getJNDIName()
          Deprecated.  
 String getKey()
          The configured Key for the Connection Factory using this Connector connection pool.
 long getLastShrinkTime()
          Return the last time that the pool was shrunk.
 String getLogFileName()
          The Log File used by the Resource Adapter for this Connector connection pool.
 LogRuntimeMBean getLogRuntime()
          Get the RuntimeMBean that allows monitoring and control of the log file.
 String getManagedConnectionFactoryClassName()
          The ManagedConnectionFactoryName of this Connector connection pool.
 int getMaxCapacity()
          The maximum capacity configured for this Connector connection pool.
 int getMaxIdleTime()
          The configured MaxIdle time for this pool
 String getMCFClassName()
          Get the MCF class name.
 int getNumberDetectedIdle()
          Deprecated.  
 int getNumberDetectedLeaks()
          Deprecated.  
 int getNumUnavailableCurrentCount()
          Return the number of unavailable connections.
 int getNumUnavailableHighCount()
          Return the highest unavailable number of connections at any given time.
 long getNumWaiters()
          Gets the current number of waiters.
 int getNumWaitersCurrentCount()
          Return the number of waiters.
 String getPoolName()
          The configured Logical Name for the Connection Factory using this Connector connection pool.
 long getPoolSizeHighWaterMark()
          The PoolSizeHighWaterMark of this Connector connection pool.
 long getPoolSizeLowWaterMark()
          The PoolSizeLowWaterMark of this Connector connection pool.
 int getRecycledTotal()
          The total number of Connector connections that have been recycled in this Connector Pool since the pool is instantiated.
 String getResourceAdapterLinkRefName()
          Deprecated.  
 String getRuntimeTransactionSupport()
          The real transaction support level in use at runtime.
 int getShrinkCountDownTime()
          The amount of time left (in minutes) until an attempt to shrink the pool will be made.
 int getShrinkPeriodMinutes()
          The Shrink Period (in minutes) of this Connector connection pool.
 String getState()
          Get the state of the pool.
 String getTransactionSupport()
          The static transaction support level, either configured in ra.xml or in @Conector annotation, for the Resource Adapter for this Connector connection pool.
 boolean isLoggingEnabled()
          Indicates whether logging is enabled for this Connector connection pool.
 boolean isProxyOn()
          Return a flag indicating if the proxy is on.
 boolean isShrinkingEnabled()
          Specifies whether shrinking of this Connector connection pool is enabled.
 boolean isTestable()
          This indicates whether the connection pool is testable or not.
 boolean reset()
           Reset connection pool Discard all unused connections and recreate connection pool (and using new configuration if user update the pool's configuration) if no connection from pool is reserved by client application.
 boolean testPool()
          Test all the available connections in the pool.
 

Method Detail

getPoolName

String getPoolName()

The configured Logical Name for the Connection Factory using this Connector connection pool.

Returns:
The poolName value

getJNDIName

String getJNDIName()
Deprecated. 

The configured JNDI Name for the Connection Factory using this Connector connection pool.

Returns:
The jNDIName value

getConnectionFactoryName

String getConnectionFactoryName()

For 1.0 link-ref resource adapters only, the base resource adapter's connection factory name.

Returns:
The connectionFactoryName value

getResourceAdapterLinkRefName

String getResourceAdapterLinkRefName()
Deprecated. 

The Resource Adapter Link Reference for cases where this Connection Factory refers to an existing Resource Adapter deployment.

Returns:
The resourceAdapterLinkRefName value

isLoggingEnabled

boolean isLoggingEnabled()

Indicates whether logging is enabled for this Connector connection pool.

Returns:
The loggingEnabled value.

getLogFileName

String getLogFileName()

The Log File used by the Resource Adapter for this Connector connection pool.

Returns:
The logFileName value.

getLogRuntime

LogRuntimeMBean getLogRuntime()

Get the RuntimeMBean that allows monitoring and control of the log file.

Returns:
the runtime mbean for the log file.

getTransactionSupport

String getTransactionSupport()

The static transaction support level, either configured in ra.xml or in @Conector annotation, for the Resource Adapter for this Connector connection pool.

Returns:
The transactionSupport value.

getRuntimeTransactionSupport

String getRuntimeTransactionSupport()

The real transaction support level in use at runtime.

Returns:
The RuntimeTransactionSupport value.

getMaxCapacity

int getMaxCapacity()

The maximum capacity configured for this Connector connection pool.

Returns:
The maxCapacity value.

getInitialCapacity

int getInitialCapacity()

The initial capacity configured for this Connector connection pool.

Returns:
The initialCapacity value.

getCapacityIncrement

int getCapacityIncrement()

The initial capacity configured for this Connector connection pool.

Returns:
The capacityIncrement value.

isShrinkingEnabled

boolean isShrinkingEnabled()

Specifies whether shrinking of this Connector connection pool is enabled.

Returns:
The shrinkingEnabled value.

getShrinkPeriodMinutes

int getShrinkPeriodMinutes()

The Shrink Period (in minutes) of this Connector connection pool.

Returns:
The shrinkPeriodMinutes value.

getActiveConnectionsCurrentCount

int getActiveConnectionsCurrentCount()

The current total active connections.

Returns:
The activeConnectionsCurrentCount value

getActiveConnectionsHighCount

int getActiveConnectionsHighCount()

The high water mark of active connections in this Connector Pool since the pool was instantiated.

Returns:
The activeConnectionsHighCount value

getFreeConnectionsCurrentCount

int getFreeConnectionsCurrentCount()

The current total free connections.

Returns:
The freeConnectionsCurrentCount value

getFreeConnectionsHighCount

int getFreeConnectionsHighCount()

The high water mark of free connections in this Connector Pool since the pool was instantiated.

Returns:
The freeConnectionsHighCount value

getAverageActiveUsage

int getAverageActiveUsage()

The running average usage of created connections that are active in the Connector Pool since the pool was last shrunk.

Returns:
The averageActiveUsage value

getShrinkCountDownTime

int getShrinkCountDownTime()

The amount of time left (in minutes) until an attempt to shrink the pool will be made.

Returns:
The shrinkCountDownTime value

getRecycledTotal

int getRecycledTotal()

The total number of Connector connections that have been recycled in this Connector Pool since the pool is instantiated.

Returns:
The recycledTotal value

getConnectionsCreatedTotalCount

int getConnectionsCreatedTotalCount()

The total number of Connector connections created in this Connector Pool since the pool is instantiated.

Returns:
The connectionsCreatedTotalCount value

getConnectionsMatchedTotalCount

int getConnectionsMatchedTotalCount()

The total number of times a request for a Connector connections was satisfied via the use of an existing created connection since the pool is instantiated.

Returns:
The connectionsMatchedTotalCount value

getConnectionsDestroyedTotalCount

int getConnectionsDestroyedTotalCount()

The total number of Connector connections destroyed in this Connector Pool since the pool is instantiated.

Returns:
The connectionsDestroyedTotalCount value

getConnectionsRejectedTotalCount

int getConnectionsRejectedTotalCount()

The total number of rejected requests for a Connector connections in this Connector Pool since the pool is instantiated.

Returns:
The connectionsRejectedTotalCount value

getConnections

ConnectorConnectionRuntimeMBean[] getConnections()

An array of ConnectorConnectionRuntimeMBeans that each represents the statistics for a Connector Connection.

Returns:
An array of ConnectorConnectionRuntimeMBeans
See Also:
ConnectorConnectionRuntimeMBean

getConnectionIdleProfileCount

int getConnectionIdleProfileCount()
Deprecated. 

The number of Idle connection profiles stored for this pool.

Returns:
The connectionIdleProfileCount value.

getConnectionIdleProfiles

ConnectionLeakProfile[] getConnectionIdleProfiles(int index,
                                                  int count)
Deprecated. 

An array of count LeakProfiles starting at the passed index, in the entire array of Idle profiles.

Parameters:
index - The starting index of the of the idle profiles.
count - The number of idle profiles needed from the index.
Returns:
The connectionIdleProfiles value.

getConnectionLeakProfiles

ConnectionLeakProfile[] getConnectionLeakProfiles()
Deprecated. 

An array of count LeakProfiles

Returns:
The connectionLeakProfiles value.

getConnectionIdleProfiles

ConnectionLeakProfile[] getConnectionIdleProfiles()
Deprecated. 

An array of count LeakProfiles starting at the passed index, in the entire array of Idle profiles.

Returns:
The connectionIdleProfiles value

getConnectionLeakProfileCount

int getConnectionLeakProfileCount()
Deprecated. 

The number of Leak connection profiles stored for this pool.

Returns:
The connectionLeakProfileCount value

getConnectionLeakProfiles

ConnectionLeakProfile[] getConnectionLeakProfiles(int index,
                                                  int count)
Deprecated. 

An array of count LeakProfiles starting at the passed index, in the entire array of Leak profiles.

Parameters:
index - The starting index of the of the leak profiles.
count - The number of leak profiles needed from the index.
Returns:
The connectionLeakProfiles value

getConnectionProfilingEnabled

boolean getConnectionProfilingEnabled()
Deprecated. 

Indicates whether connection profiling is enabled for this pool.

Returns:
The connectionProfilingEnabled value

getMaxIdleTime

int getMaxIdleTime()

The configured MaxIdle time for this pool

Returns:
The maxIdleTime value

getNumberDetectedIdle

int getNumberDetectedIdle()
Deprecated. 

The total number of idle connections detected in the life time of this pool.

Returns:
The numberDetectedIdle value

getNumberDetectedLeaks

int getNumberDetectedLeaks()
Deprecated. 

The total number of leaked connections detected in the life time of this pool.

Returns:
The numberDetectedLeaks value

getConnectorEisType

String getConnectorEisType()

The EIS type of this Connector connection pool.

Returns:
The eis type

getEISResourceId

String getEISResourceId()

The EISResourceId of this Connector connection pool.

Returns:
The EISResourceId

getCloseCount

long getCloseCount()

The number of connections that were closed for the connection pool.

Returns:
long

getFreePoolSizeHighWaterMark

long getFreePoolSizeHighWaterMark()

The FreePoolSizeHighWaterMark of this Connector connection pool.

Returns:
long

getFreePoolSizeLowWaterMark

long getFreePoolSizeLowWaterMark()

The FreePoolSizeLowWaterMark of this Connector connection pool.

Returns:
long

getCurrentCapacity

long getCurrentCapacity()

The PoolSize of this Connector connection pool.

Returns:
long

getPoolSizeHighWaterMark

long getPoolSizeHighWaterMark()

The PoolSizeHighWaterMark of this Connector connection pool.

Returns:
long

getPoolSizeLowWaterMark

long getPoolSizeLowWaterMark()

The PoolSizeLowWaterMark of this Connector connection pool.

Returns:
long

getManagedConnectionFactoryClassName

String getManagedConnectionFactoryClassName()

The ManagedConnectionFactoryName of this Connector connection pool.

Returns:
String

getConnectionFactoryClassName

String getConnectionFactoryClassName()

The ConnectionFactoryName of this Connector connection pool.

Returns:
String

getNumWaiters

long getNumWaiters()

Gets the current number of waiters.

Returns:
long

getHighestNumWaiters

long getHighestNumWaiters()

Gets the highest number of waiters.

Returns:
long

isTestable

boolean isTestable()

This indicates whether the connection pool is testable or not.

Returns:
boolean

getLastShrinkTime

long getLastShrinkTime()

Return the last time that the pool was shrunk.

Returns:
long

getConnectionsDestroyedByErrorTotalCount

int getConnectionsDestroyedByErrorTotalCount()

Return the number of connections that were destroyed because an error event was received.

Returns:
int

getConnectionsDestroyedByShrinkingTotalCount

int getConnectionsDestroyedByShrinkingTotalCount()

Return the number of connections that were destroyed as a result of shrinking.

Returns:
int

getNumWaitersCurrentCount

int getNumWaitersCurrentCount()

Return the number of waiters.

Returns:
int

getNumUnavailableCurrentCount

int getNumUnavailableCurrentCount()

Return the number of unavailable connections.

Returns:
int

getNumUnavailableHighCount

int getNumUnavailableHighCount()

Return the highest unavailable number of connections at any given time.

Returns:
int

isProxyOn

boolean isProxyOn()

Return a flag indicating if the proxy is on. Returns true if it is.

Returns:
boolean

testPool

boolean testPool()

Test all the available connections in the pool. Returns true if all the connections passed the test and false it at least one failed the test.

Returns:
boolean

getState

String getState()

Get the state of the pool.

Returns:
String

getMCFClassName

String getMCFClassName()
Get the MCF class name.

Returns:
String

getKey

String getKey()

The configured Key for the Connection Factory using this Connector connection pool.

Returns:
The Key Name value

forceReset

void forceReset()
                throws ManagementException

Force immediately discard all used/unused connections and recreate connection pool (and using new configuration if user update the pool's configuration).

Throws:
ManagementException - If any error occurs during resetting the pool.

reset

boolean reset()
              throws ManagementException

Reset connection pool Discard all unused connections and recreate connection pool (and using new configuration if user update the pool's configuration) if no connection from pool is reserved by client application. If any connection from the connection pool is currently in use, the operation fails and false will be returned, otherwise all connections will be reset and true will be returned.

Throws:
ManagementException - If any error occurs during resetting the pool.

Copyright 1996, 2011, 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
Oracle WebLogic Server MBean Javadoc
12c Release 1 (12.1.1)

Part Number E24395-02