public interface UniversalConnectionPoolMBean
Modifier and Type | Method and Description |
---|---|
int |
getAbandonedConnectionsCount()
Gets the number of abandoned connections that have been reclaimed.
|
int |
getAbandonedConnectionTimeout()
Gets the abandoned connection timeout of the Universal Connection Pool
instance.
|
int |
getAvailableConnectionsCount()
Gets the available connections count of the Universal Connection Pool
instance.
|
int |
getAverageBorrowedConnectionsCount()
Gets the average number of connections that are borrowed and
actively in use by clients.
|
long |
getAverageConnectionWaitTime()
Gets the average time (in milliseconds) a user thread has to wait before it could obtain
a connection from the connection pool.
|
int |
getBorrowedConnectionsCount()
Gets the borrowed connections count of the Universal Connection Pool
instance.
|
int |
getConnectionHarvestMaxCount()
Gets the connection harvest maximum count of the Universal Connection
Pool instance.
|
int |
getConnectionHarvestTriggerCount()
Gets the connection harvest trigger count of the Universal Connection
Pool instance.
|
long |
getConnectionRepurposeCount()
Returns the number of connection repurposed in a shared pool
for a mutitenant database, where connections can be reused
across PDB's by switching their container and PDB service.
|
int |
getConnectionsClosedCount()
Gets the number of connections closed by this connection pool.
|
int |
getConnectionsCreatedCount()
Gets the number of connections created for this connection pool.
|
int |
getConnectionWaitTimeout()
Gets the connection wait timeout of the Universal Connection Pool
instance.
|
long |
getCumulativeConnectionBorrowedCount()
Gets the number of connections borrowed from the connection pool over the
life of the pool.
|
long |
getCumulativeConnectionReturnedCount()
Gets the number of connections returned to the connection pool
over the life of the pool.
|
long |
getCumulativeConnectionUseTime()
Gets the cumulative time (in milliseconds) of connections that were
borrowed from the pool and remained in use.
|
long |
getCumulativeConnectionWaitTime()
Gets the cumulative time (in milliseconds) that connection requests
have waited for connections over the life of the connection pool.
|
long |
getCumulativeFailedConnectionWaitCount()
Gets the number of connection requests that waited unsuccessfully
to borrow a connection from the pool.
|
long |
getCumulativeFailedConnectionWaitTime()
Gets the cumulative time (in milliseconds) that connection requests
waited but failed to borrow a connection from the pool.
|
long |
getCumulativeSuccessfulConnectionWaitCount()
Gets the number of connection requests that waited successfully
and borrowed a connection from the pool.
|
long |
getCumulativeSuccessfulConnectionWaitTime()
Gets the cumulative time (in milliseconds) that connection requests
waited successfully and borrowed a connection from the pool.
|
long |
getFailedAffinityBasedBorrowCount()
Gets the number of borrow requests that returned connections not
matching the affinity contexts.
|
long |
getFailedRCLBBasedBorrowCount()
Gets the number of borrow requests failed using Runtime Connection
Load-Balancing (RCLB) algorithms.
|
java.lang.String |
getFcfProcessingInfo()
Gets the information of recent Fast Connection Failover (FCF)
attempts, in the form of a String.
|
java.lang.String |
getFcfProcessingInfoProcessedOnly() |
int |
getInactiveConnectionTimeout()
Gets the inactive connection timeout of the Universal Connection Pool
instance.
|
int |
getInitialPoolSize()
Gets the initial pool size of the Universal Connection Pool instance.
|
int |
getLabeledConnectionsCount()
Gets the number of labeled connections in the connection pool.
|
java.lang.String |
getLifeCycleState()
Gets the lifecycle state of Universal Connection Pool instance.
|
int |
getMaxConnectionReuseCount()
Gets the maximum connection reuse count of the Universal Connection Pool
instance.
|
long |
getMaxConnectionReuseTime()
Gets the maximum connection reuse time of the Universal Connection Pool
instance.
|
int |
getMaxPoolSize()
Gets the maximum pool size of the Universal Connection Pool instance.
|
javax.management.modelmbean.ModelMBeanInfo |
getMBeanInfo(javax.management.ObjectName mbeanObjName,
java.lang.String mbeanDisplayName)
Builds
MBeanInfo to define attributes, constructors,
operations and notifications to expose to the remote users. |
int |
getMinPoolSize()
Gets the minimum pool size of the Universal Connection Pool instance.
|
java.lang.String |
getName()
Gets the name of the Universal Connection Pool instance.
|
int |
getPeakConnectionsCount()
Gets the maximum number of connections that the connection pool has
reached during the life of the pool.
|
long |
getPeakConnectionWaitTime()
Gets the longest wait (in milliseconds) a user request has to incur
before obtaining a connection from the connection pool.
|
int |
getPendingRequestsCount()
Gets the number of clients that are currently waiting to obtain a
connection from the pool.
|
int |
getRemainingPoolCapacityCount()
Gets the number of connections that may be added to the pool before
it reaches
maxPoolSize . |
int |
getSecondsToTrustIdleConnection()
Gets the seconds To Trust Idle Connection value.
|
java.lang.String |
getStatistics()
Gets statistics for the Universal Connection Pool instance.
|
long |
getSuccessfulAffinityBasedBorrowCount()
Gets the number of borrow requests succeeded with matching affinity
contexts.
|
long |
getSuccessfulRCLBBasedBorrowCount()
Gets the number of borrow requests succeeded using Runtime
Connection Load-Balancing (RCLB) algorithms.
|
int |
getTimeoutCheckInterval()
Gets the timeout check interval of the Universal Connection Pool instance.
|
int |
getTimeToLiveConnectionTimeout()
Gets the time to live connection timeout of the Universal Connection
Pool instance.
|
int |
getTotalConnectionsCount()
Gets the total number of connections (both available and borrowed)
in the connection pool.
|
javax.management.modelmbean.ModelMBeanAttributeInfo[] |
getUCPMBeanAttributes()
Builds the attribute information for the Universal Connection Pool MBean.
|
javax.management.modelmbean.ModelMBeanOperationInfo[] |
getUCPMBeanOperations()
Builds the operation information for the Universal Connection Pool MBean.
|
boolean |
getValidateConnectionOnBorrow()
Gets the validate connection on borrow value of the Universal Connection
Pool instance.
|
void |
purge()
Purges the Universal Connection Pool instance.
|
void |
recycle()
Recycles the Universal Connection Pool instance.
|
void |
refresh()
Refreshes the Universal Connection Pool instance.
|
void |
setAbandonedConnectionTimeout(int abandonedConnectionTimeout)
Sets the abandoned connection timeout of the Universal Connection Pool
instance.
|
void |
setConnectionHarvestMaxCount(int connectionHarvestMaxCount)
Sets the connection harvest maximum count for the Universal Connection
Pool instance.
|
void |
setConnectionHarvestTriggerCount(int connectionHarvestTriggerCount)
Sets the connection harvest trigger count for the Universal Connection
Pool instance.
|
void |
setConnectionWaitTimeout(int connectionWaitTimeout)
Sets the connection wait timeout of the Universal Connection Pool
instance.
|
void |
setInactiveConnectionTimeout(int inactiveConnectionTimeout)
Sets the inactive connection timeout.
|
void |
setInitialPoolSize(int initialPoolSize)
Sets the initial pool size of the Universal Connection Pool instance.
|
void |
setMaxConnectionReuseCount(int maxConnectionReuseCount)
Sets the maximum connection reuse count for the Universal Connection Pool
instance.
|
void |
setMaxConnectionReuseTime(long maxConnectionReuseTime)
Sets the maximum connection reuse time for the Universal Connection Pool
instance.
|
void |
setMaxPoolSize(int maxPoolSize)
Sets the maximum pool size of the Universal Connection Pool instance.
|
void |
setMinPoolSize(int minPoolSize)
Sets the minimum pool size of the Universal Connection Pool instance.
|
void |
setName(java.lang.String name)
Sets the name of the Universal Connection Pool instance.
|
void |
setSecondsToTrustIdleConnection(int secondsToTrustIdleConnection)
Sets the time in seconds to trust an idle connection to skip a validation
test.
|
void |
setTimeoutCheckInterval(int timeoutCheckInterval)
Sets the timeout check interval of the Universal Connection Pool instance.
|
void |
setTimeToLiveConnectionTimeout(int timeToLiveConnectionTimeout)
Sets the time to live connection timeout of the Universal Connection Pool
instance.
|
void |
setValidateConnectionOnBorrow(boolean validateConnectionOnBorrow)
Sets the validate connection on borrow value for the Universal Connection
Pool instance.
|
void |
start()
Starts the Universal Connection Pool instance.
|
void |
stop()
Stops the Universal Connection Pool instance.
|
void |
useStrictWebSessionAffinity(boolean strict)
The knob for switching strict web session affinity
|
void |
useStrictXAAffinity(boolean strict) |
void refresh() throws UniversalConnectionPoolException
UniversalConnectionPoolException
- If an error occurs while refreshing the Universal Connection
Pool instance.void recycle() throws UniversalConnectionPoolException
UniversalConnectionPoolException
- If an error occurs while recycling the Universal Connection
Pool instance.void purge() throws UniversalConnectionPoolException
UniversalConnectionPoolException
- If an error occurs while purging the Universal Connection Pool
instance.void start() throws UniversalConnectionPoolException
UniversalConnectionPoolException
- If an error occurs while starting the Universal Connection Pool
instance.void stop() throws UniversalConnectionPoolException
UniversalConnectionPoolException
- If an error occurs while stopping the Universal Connection Pool
instance.java.lang.String getName()
void setName(java.lang.String name) throws UniversalConnectionPoolException
name
- A new name for the Universal Connection Pool instance.UniversalConnectionPoolException
- If an error occurs while changing the name.int getInitialPoolSize()
void setInitialPoolSize(int initialPoolSize) throws UniversalConnectionPoolException
initialPoolSize
- New initial pool size.UniversalConnectionPoolException
- If an error occurs while changing the initial pool size.int getMinPoolSize()
void setMinPoolSize(int minPoolSize) throws UniversalConnectionPoolException
minPoolSize
- New minimum pool size.UniversalConnectionPoolException
- If an error occurs while changing the minimum pool.int getMaxPoolSize()
void setMaxPoolSize(int maxPoolSize) throws UniversalConnectionPoolException
maxPoolSize
- New maximum pool size.UniversalConnectionPoolException
- If an error occurs while changing the maximum pool size.int getInactiveConnectionTimeout()
void setInactiveConnectionTimeout(int inactiveConnectionTimeout) throws UniversalConnectionPoolException
inactiveConnectionTimeout
- New inactive connection timeout.UniversalConnectionPoolException
- If an error occurs while changing the inactive connection
timeout.int getAbandonedConnectionTimeout()
void setAbandonedConnectionTimeout(int abandonedConnectionTimeout) throws UniversalConnectionPoolException
abandonedConnectionTimeout
- New abandoned connection timeout.UniversalConnectionPoolException
- If an error occurs while changing the abandoned connection
timeout.int getConnectionWaitTimeout()
void setConnectionWaitTimeout(int connectionWaitTimeout) throws UniversalConnectionPoolException
connectionWaitTimeout
- New connection wait timeout.UniversalConnectionPoolException
- If an error occurs while changing the connection wait timeout.int getTimeToLiveConnectionTimeout()
void setTimeToLiveConnectionTimeout(int timeToLiveConnectionTimeout) throws UniversalConnectionPoolException
timeToLiveConnectionTimeout
- New time to live connection timeout.UniversalConnectionPoolException
- If an error occurs while changing the time to live connection
timeout.int getTimeoutCheckInterval()
void setTimeoutCheckInterval(int timeoutCheckInterval) throws UniversalConnectionPoolException
timeoutCheckInterval
- New timeout check interval.UniversalConnectionPoolException
- If an error occurs while changing the timeout check interval.boolean getValidateConnectionOnBorrow()
void setValidateConnectionOnBorrow(boolean validateConnectionOnBorrow)
validateConnectionOnBorrow
- New validate connection on borrow value.UniversalConnectionPoolException
- If an error occurs while changing the validate connection on
borrow value.int getConnectionHarvestTriggerCount()
void setConnectionHarvestTriggerCount(int connectionHarvestTriggerCount) throws UniversalConnectionPoolException
connectionHarvestTriggerCount
- New connection harvest trigger count.UniversalConnectionPoolException
- If an error occurs while changing the connection harvest
trigger count.int getConnectionHarvestMaxCount()
void setConnectionHarvestMaxCount(int connectionHarvestMaxCount) throws UniversalConnectionPoolException
connectionHarvestMaxCount
- New connection harvest maximum count.UniversalConnectionPoolException
- If an error occurs while changing the connection harvest
maximum count.long getMaxConnectionReuseTime()
void setMaxConnectionReuseTime(long maxConnectionReuseTime) throws UniversalConnectionPoolException
maxConnectionReuseTime
- New maximum connection reuse time (in seconds).UniversalConnectionPoolException
- If an error occurs while changing the maximum connection reuse
time.int getMaxConnectionReuseCount()
void setMaxConnectionReuseCount(int maxConnectionReuseCount) throws UniversalConnectionPoolException
maxConnectionReuseCount
- New maximum connection reuse count.UniversalConnectionPoolException
- If an error occurs while changing the maximum connection reuse
count.int getAvailableConnectionsCount()
int getBorrowedConnectionsCount()
java.lang.String getStatistics()
java.lang.String getLifeCycleState()
javax.management.modelmbean.ModelMBeanAttributeInfo[] getUCPMBeanAttributes() throws UniversalConnectionPoolException
ModelMBeanAttributeInfo[]
.UniversalConnectionPoolException
- If an error occurs while getting
ModelMBeanAttributeInfo[]
.javax.management.modelmbean.ModelMBeanOperationInfo[] getUCPMBeanOperations() throws UniversalConnectionPoolException
ModelMBeanOperationInfo[]
.UniversalConnectionPoolException
- If an error occurs while getting
ModelMBeanOperationInfo[]
.javax.management.modelmbean.ModelMBeanInfo getMBeanInfo(javax.management.ObjectName mbeanObjName, java.lang.String mbeanDisplayName) throws UniversalConnectionPoolException
MBeanInfo
to define attributes, constructors,
operations and notifications to expose to the remote users.mbeanObjName
- Unique name for the Universal Connection Pool MBean.mbeanDisplayName
- Display name for the Universal Connection Pool MBean.ModelMBeanInfo
for Universal Connection Pool MBean.UniversalConnectionPoolException
- If an error occurs while getting
ModelMBeanInfo
for the Universal Connection Pool
MBean.void useStrictWebSessionAffinity(boolean strict)
strict
- if strict, otherwise nonstrictvoid useStrictXAAffinity(boolean strict)
int getSecondsToTrustIdleConnection()
setSecondsToTrustIdleConnection()
.void setSecondsToTrustIdleConnection(int secondsToTrustIdleConnection) throws UniversalConnectionPoolException
setValidateConnectionOnBorrow(boolean)
. When set to any
positive value, a connection validation during the checkout is skipped if
the connection was successfully used and returned to the pool within the
time specified for secondsToTrustIdleConnection. Default value is set to 0
seconds which means that the feature is disabled.secondsToTrustIdleConnection
- The value of how long a connection can be trusted to skip
connectionValidationOnBorrowUniversalConnectionPoolException
int getTotalConnectionsCount()
int getAverageBorrowedConnectionsCount()
int getPeakConnectionsCount()
int getRemainingPoolCapacityCount()
maxPoolSize
.maxPoolSize
.int getLabeledConnectionsCount()
int getConnectionsCreatedCount()
int getConnectionsClosedCount()
long getAverageConnectionWaitTime()
long getPeakConnectionWaitTime()
int getAbandonedConnectionsCount()
int getPendingRequestsCount()
long getCumulativeConnectionWaitTime()
long getCumulativeConnectionBorrowedCount()
long getCumulativeConnectionUseTime()
long getCumulativeConnectionReturnedCount()
long getCumulativeSuccessfulConnectionWaitTime()
long getCumulativeSuccessfulConnectionWaitCount()
long getCumulativeFailedConnectionWaitTime()
long getCumulativeFailedConnectionWaitCount()
long getSuccessfulAffinityBasedBorrowCount()
long getFailedAffinityBasedBorrowCount()
long getSuccessfulRCLBBasedBorrowCount()
long getFailedRCLBBasedBorrowCount()
java.lang.String getFcfProcessingInfo()
java.lang.String getFcfProcessingInfoProcessedOnly()
long getConnectionRepurposeCount()