oracle.ucp.admin

Class JDBCUniversalConnectionPoolMBeanImpl

java.lang.Object

oracle.ucp.admin.UniversalConnectionPoolMBeanBase

oracle.ucp.admin.JDBCUniversalConnectionPoolMBeanImpl

All Implemented Interfaces:

UniversalConnectionPoolMBean

public class JDBCUniversalConnectionPoolMBeanImpl
extends UniversalConnectionPoolMBeanBase

Field Summary

Fields inherited from class oracle.ucp.admin.UniversalConnectionPoolMBeanBase

connectionPool

Constructor Summary

Constructors

Constructor and Description
JDBCUniversalConnectionPoolMBeanImpl(UniversalConnectionPool connectionPool) Constructor for JDBCUniversalConnectionPoolMBeanImpl.

Method Summary

Modifier and Type	Method and Description
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.
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.
boolean	getFastConnectionFailoverEnabled() Gets the FastConnectionFailoverEnabled flag for the pool instance.
String	getFcfProcessingInfo() Gets the information of recent Fast Connection Failover (FCF) attempts, in the form of a String.
String	getFcfProcessingInfoProcessedOnly()
int	getMaxConnectionsPerService() Gets the maximum number of connections that can be obtained to a particular service, in a shared pool.
int	getMaxIdleTime() Gets the maximum idle time.
int	getMaxStatements() Gets the maximum number of statements that may be pooled or cached on a Connection.
ModelMBeanInfo	getMBeanInfo(ObjectName mbeanObjName, String mbeanDisplayName) Builds the MBeanInfo to define attributes, constructors, operations and notifications to expose to the remote users.
String	getONSConfiguration() Returns the ONS configuration string that is used for remote ONS subscription, in the form specified in setONSConfiguration(String).
int	getPropertyCycle() Gets the property cycle in seconds.
String	getSQLForValidateConnection() Gets the value of the SQLForValidateConnection property.
long	getSuccessfulAffinityBasedBorrowCount() Gets successful affinity borrow count
long	getSuccessfulRCLBBasedBorrowCount() Gets the number of borrow requests succeeded using Runtime Connection Load-Balancing (RCLB) algorithms.
void	setFastConnectionFailoverEnabled(boolean failoverEnabled) Sets the flag to enable/disable failover on this conneciton pool instance.
void	setMaxConnectionsPerService(int maxConnectionsPerService) Sets the maximum number of connections that can be obtained to a particular service, in a shared pool.
void	setMaxIdleTime(int idleTime) Sets the maximum idle time for available connections in the pool.
void	setMaxStatements(int maxStatements) Sets the maximum number of statements that may be pooled or cached on a connection.
void	setONSConfiguration(String onsConfigStr) This method sets the configuration string used for remote ONS subscription.
void	setPropertyCycle(int propertyCycle) Sets the property cycle in seconds.
void	setSQLForValidateConnection(String SQLString) Sets the value of the SQLForValidateConnection property.
void	useStrictWebSessionAffinity(boolean strict) The knob for switching strict web session affinity
void	useStrictXAAffinity(boolean strict)

Methods inherited from class oracle.ucp.admin.UniversalConnectionPoolMBeanBase

getAbandonedConnectionsCount, getAbandonedConnectionTimeout, getAvailableConnectionsCount, getAverageBorrowedConnectionsCount, getAverageConnectionWaitTime, getBorrowedConnectionsCount, getConnectionHarvestMaxCount, getConnectionHarvestTriggerCount, getConnectionsClosedCount, getConnectionsCreatedCount, getConnectionWaitTimeout, getCumulativeConnectionBorrowedCount, getCumulativeConnectionReturnedCount, getCumulativeConnectionUseTime, getCumulativeConnectionWaitTime, getCumulativeFailedConnectionWaitCount, getCumulativeFailedConnectionWaitTime, getCumulativeSuccessfulConnectionWaitCount, getCumulativeSuccessfulConnectionWaitTime, getInactiveConnectionTimeout, getInitialPoolSize, getLabeledConnectionsCount, getLifeCycleState, getMaxConnectionReuseCount, getMaxConnectionReuseTime, getMaxPoolSize, getMinPoolSize, getName, getPeakConnectionsCount, getPeakConnectionWaitTime, getPendingRequestsCount, getRemainingPoolCapacityCount, getSecondsToTrustIdleConnection, getStatistics, getTimeoutCheckInterval, getTimeToLiveConnectionTimeout, getTotalConnectionsCount, getUCPMBeanAttributes, getUCPMBeanOperations, getValidateConnectionOnBorrow, purge, recycle, refresh, setAbandonedConnectionTimeout, setConnectionHarvestMaxCount, setConnectionHarvestTriggerCount, setConnectionWaitTimeout, setInactiveConnectionTimeout, setInitialPoolSize, setMaxConnectionReuseCount, setMaxConnectionReuseTime, setMaxPoolSize, setMinPoolSize, setName, setSecondsToTrustIdleConnection, setTimeoutCheckInterval, setTimeToLiveConnectionTimeout, setValidateConnectionOnBorrow, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JDBCUniversalConnectionPoolMBeanImpl

public JDBCUniversalConnectionPoolMBeanImpl(UniversalConnectionPool connectionPool)
                                     throws UniversalConnectionPoolException

Constructor for JDBCUniversalConnectionPoolMBeanImpl.

Throws:

UniversalConnectionPoolException - If an error occurs constructing JDBCUniversalConnectionPoolMBeanImpl.

Method Detail

setSQLForValidateConnection

public void setSQLForValidateConnection(String SQLString)
                                 throws SQLException

Sets the value of the SQLForValidateConnection property. This is a SQL command used in conjunction with the ValidateConnectionOnBorrow property. The SQL specified should be applicable to back end database and the JDBC driver configured. Defaults to null.

Parameters:

SQLString - The SQL string used for connection validation.

Throws:

SQLException - If an error occurs while setting this property.

getSQLForValidateConnection

public String getSQLForValidateConnection()

Gets the value of the SQLForValidateConnection property.

Returns:

The SQLForValidateConnection property value.

setMaxStatements

public void setMaxStatements(int maxStatements)
                      throws SQLException

Sets the maximum number of statements that may be pooled or cached on a connection. This is used to enable the statement pooling.

The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0.

Parameters:

maxStatements - maximum number of statements to be pooled.

Throws:

SQLException - Exception occurred during the process of setting maximum statements that may be pooled on a connection.

getMaxStatements

public int getMaxStatements()

Gets the maximum number of statements that may be pooled or cached on a Connection.

Returns:

The maximum number of statements that may be pooled or cached on a Connection.

setMaxIdleTime

public void setMaxIdleTime(int idleTime)
                    throws UniversalConnectionPoolException

Sets the maximum idle time for available connections in the pool. This has the same effect as setting the inactive connection timeout.

The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0.

Parameters:

idleTime - Maximum idle time in seconds.

Throws:

UniversalConnectionPoolException - If an error occurs while setting this property.

getMaxIdleTime

public int getMaxIdleTime()

Gets the maximum idle time.

Returns:

The maximum idle time.

setPropertyCycle

public void setPropertyCycle(int propertyCycle)
                      throws UniversalConnectionPoolException

Sets the property cycle in seconds. This is the time interval between checks to enforce connection pool timeout properties. This has the same effect as setting the timeoutCheckInterval.

The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 30.

Parameters:

propertyCycle - Time interval in seconds to enforce connection pool timeout properties.

Throws:

UniversalConnectionPoolException - If an error occurs while setting this property.

getPropertyCycle

public int getPropertyCycle()

Gets the property cycle in seconds.

Returns:

The PropertyCycle value.

setFastConnectionFailoverEnabled

public void setFastConnectionFailoverEnabled(boolean failoverEnabled)
                                      throws UniversalConnectionPoolException

Sets the flag to enable/disable failover on this conneciton pool instance.

Parameters:

failoverEnabled - Flag to enable/disable failover on this conneciton pool.

Throws:

UniversalConnectionPoolException - If an error occurs while setting this property.

getFastConnectionFailoverEnabled

public boolean getFastConnectionFailoverEnabled()

Gets the FastConnectionFailoverEnabled flag for the pool instance.

Returns:

The FastConnectionFailoverEnabled flag for the pool.

setONSConfiguration

public void setONSConfiguration(String onsConfigStr)
                         throws UniversalConnectionPoolException

This method sets the configuration string used for remote ONS subscription. This will call OracleConnectionPool operation to set the configuration string.

This is used primarily by Fast Connection Failover and Runtime Load Balancing.

Parameters:

onsConfigStr - The configuration string for remote ONS subscription.

Throws:

UniversalConnectionPoolException - If an error occurs while setting this property.

getONSConfiguration

public String getONSConfiguration()
                           throws UniversalConnectionPoolException

Returns the ONS configuration string that is used for remote ONS subscription, in the form specified in setONSConfiguration(String). This is used by Fast Connection Failover and Runtime Load Balancing. This will call OracleConnectionPool operation to set the configuration string.

Returns:

The ONS configuration string used for remote ONS subscription.

Throws:

UniversalConnectionPoolException - If an error occurs while getting this property value.

getMaxConnectionsPerService

public int getMaxConnectionsPerService()
                                throws UniversalConnectionPoolException

Gets the maximum number of connections that can be obtained to a particular service, in a shared pool.

Returns:

The maximum number of connections that can be obtained to a particular service.

Throws:

UniversalConnectionPoolException

setMaxConnectionsPerService

public void setMaxConnectionsPerService(int maxConnectionsPerService)
                                 throws UniversalConnectionPoolException

Sets the maximum number of connections that can be obtained to a particular service, in a shared pool.

Parameters:

maxConnectionsPerService - The maximum number of connections that can be obtained to a particular service.

Throws:

UniversalConnectionPoolException

getMBeanInfo

public ModelMBeanInfo getMBeanInfo(ObjectName mbeanObjName,
                                   String mbeanDisplayName)
                            throws UniversalConnectionPoolException

Builds the MBeanInfo to define attributes, constructors, operations and notifications to expose to the remote users.

Specified by:

getMBeanInfo in interface UniversalConnectionPoolMBean

Overrides:

getMBeanInfo in class UniversalConnectionPoolMBeanBase

Parameters:

mbeanObjName - Unique name for the JDBCUniversalConnectionPoolMBeanImpl.

mbeanDisplayName - Display name for the JDBCUniversalConnectionPoolMBeanImpl.

Returns:

ModelMBeanInfo Return ModelMBeanInfo for JDBCConnectionPoolMBean.

Throws:

UniversalConnectionPoolException - If an error occurs while getting the MBeanInfo for JDBCUniversalConnectionPoolMBeanImpl.

useStrictWebSessionAffinity

public void useStrictWebSessionAffinity(boolean strict)

Description copied from interface: UniversalConnectionPoolMBean

The knob for switching strict web session affinity

Specified by:

useStrictWebSessionAffinity in interface UniversalConnectionPoolMBean

Overrides:

useStrictWebSessionAffinity in class UniversalConnectionPoolMBeanBase

Parameters:

strict - if strict, otherwise nonstrict

useStrictXAAffinity

public void useStrictXAAffinity(boolean strict)

Specified by:

useStrictXAAffinity in interface UniversalConnectionPoolMBean

Overrides:

useStrictXAAffinity in class UniversalConnectionPoolMBeanBase

getSuccessfulAffinityBasedBorrowCount

public long getSuccessfulAffinityBasedBorrowCount()

Description copied from class: UniversalConnectionPoolMBeanBase

Gets successful affinity borrow count

Specified by:

getSuccessfulAffinityBasedBorrowCount in interface UniversalConnectionPoolMBean

Overrides:

getSuccessfulAffinityBasedBorrowCount in class UniversalConnectionPoolMBeanBase

Returns:

successful affinity count

getFailedAffinityBasedBorrowCount

public long getFailedAffinityBasedBorrowCount()

Description copied from class: UniversalConnectionPoolMBeanBase

Gets the number of borrow requests that returned connections not matching the affinity contexts.

Specified by:

getFailedAffinityBasedBorrowCount in interface UniversalConnectionPoolMBean

Overrides:

getFailedAffinityBasedBorrowCount in class UniversalConnectionPoolMBeanBase

Returns:

The number of borrow requests that returned connections not matching the affinity contexts.

getSuccessfulRCLBBasedBorrowCount

public long getSuccessfulRCLBBasedBorrowCount()

Description copied from class: UniversalConnectionPoolMBeanBase

Gets the number of borrow requests succeeded using Runtime Connection Load-Balancing (RCLB) algorithms.

Specified by:

getSuccessfulRCLBBasedBorrowCount in interface UniversalConnectionPoolMBean

Overrides:

getSuccessfulRCLBBasedBorrowCount in class UniversalConnectionPoolMBeanBase

Returns:

The number of borrow requests succeeded using Runtime Connection Load-Balancing (RCLB) algorithms.

getFailedRCLBBasedBorrowCount

public long getFailedRCLBBasedBorrowCount()

Description copied from class: UniversalConnectionPoolMBeanBase

Gets the number of borrow requests failed using Runtime Connection Load-Balancing (RCLB) algorithms.

Specified by:

getFailedRCLBBasedBorrowCount in interface UniversalConnectionPoolMBean

Overrides:

getFailedRCLBBasedBorrowCount in class UniversalConnectionPoolMBeanBase

Returns:

The number of borrow requests failed using Runtime Connection Load-Balancing (RCLB) algorithms.

getFcfProcessingInfo

public String getFcfProcessingInfo()

Description copied from class: UniversalConnectionPoolMBeanBase

Gets the information of recent Fast Connection Failover (FCF) attempts, in the form of a String. The information returned is to help diagnosing FCF problems, and includes the outcome of each FCF attempt (successful or failed), the relevant RAC instances, the number of connections cleaned up, the exception that triggered the FCF attempt failure, etc.

Specified by:

getFcfProcessingInfo in interface UniversalConnectionPoolMBean

Overrides:

getFcfProcessingInfo in class UniversalConnectionPoolMBeanBase

Returns:

The information string for recent FCF attempts.

getFcfProcessingInfoProcessedOnly

public String getFcfProcessingInfoProcessedOnly()

Specified by:

getFcfProcessingInfoProcessedOnly in interface UniversalConnectionPoolMBean

Overrides:

getFcfProcessingInfoProcessedOnly in class UniversalConnectionPoolMBeanBase

getConnectionRepurposeCount

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

Specified by:

getConnectionRepurposeCount in interface UniversalConnectionPoolMBean

Overrides:

getConnectionRepurposeCount in class UniversalConnectionPoolMBeanBase