oracle.ucp.admin

Class UniversalConnectionPoolManagerMBeanImpl

java.lang.Object

oracle.ucp.admin.UniversalConnectionPoolManagerMBeanImpl

All Implemented Interfaces:

UniversalConnectionPoolManagerMBean

public class UniversalConnectionPoolManagerMBeanImpl
extends Object
implements UniversalConnectionPoolManagerMBean

Method Summary

Modifier and Type	Method and Description
UniversalConnectionPoolMBean	createConnectionPool(UniversalConnectionPoolAdapter ucpAdapter) Creates a connection pool instance based on specified UCP Adapter.
void	destroyConnectionPool(String poolName) Destroys the connection pool.
UniversalConnectionPoolLifeCycleState	getConnectionPoolLifeCycleState(String poolName) Gets the life cycle state of the UniversalConnectionPool.
String[]	getConnectionPoolNames() Gets all the pool names managed by the UniversalConnectionPoolManager.
Level	getLogLevel() Gets the log level for the logger.
String	getMBeanNameForConnectionPool(String connectionPoolName) Gets the MBean Name for the corresponding Universal Connection Pool MBean Object.
int	getMetricUpdateInterval() Gets the metric update interval value.
static UniversalConnectionPoolManagerMBean	getUniversalConnectionPoolManagerMBean() Returns the static UniversalConnectionPoolManagerMBean instance.
void	purgeConnectionPool(String poolName) Purges the connection pool.
void	reconfigureConnectionPool(String poolName, Properties configuration) Reconfigures the connection pool.
void	recycleConnectionPool(String poolName) Recycles the connection pool.
void	refreshConnectionPool(String poolName) Refreshes the connection pool.
void	registerUniversalConnectionPoolMBean(UniversalConnectionPoolMBean poolMBean) Registers the UniversalConnectionPoolMBean instance with the MBean server.
void	setLogLevel(Level newLogLevel) Sets the log level for the UCP logger.
void	setMetricUpdateInterval(int interval) Sets the metric update interval value.
void	startConnectionPool(String poolName) Starts the connection pool.
void	startMetricsCollection(String poolName) Starts metric collection for the provided pool.
void	stopConnectionPool(String poolName) Stops the connection pool.
void	stopMetricsCollection(String poolName) Stops metric collection for the provided pool.
void	unregisterUniversalConnectionPoolMBean(String poolName) Unregisters the UniversalConnectionPoolMBean from the MBean server.

Methods inherited from class java.lang.Object

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

Method Detail

getUniversalConnectionPoolManagerMBean

public static UniversalConnectionPoolManagerMBean getUniversalConnectionPoolManagerMBean()
                                                                                  throws UniversalConnectionPoolException

Returns the static UniversalConnectionPoolManagerMBean instance. This is a singleton class. Only one UniversalConnectionPoolManagerMBean exists in the JVM.

Returns:

UniversalConnectionPoolManagerMBean Returns UniversalConnectionPoolManagerMBean object.

Throws:

UniversalConnectionPoolException - If an error occurs while getting UniversalConnectionPoolManagerMBean.

startConnectionPool

public void startConnectionPool(String poolName)
                         throws UniversalConnectionPoolException

Starts the connection pool. Connection pool object is obtained from manager by providing pool name as key. Pool operation is called to start the connection pool.

Starting the pool does not start metric collection for the pool. Operation startMetricsCollection needs to be called to start the metric collection for the pool.

Specified by:

startConnectionPool in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection pool name to find the connection pool object from pool manager.

Throws:

UniversalConnectionPoolException - If an error occurs while starting the connection pool.

stopConnectionPool

public void stopConnectionPool(String poolName)
                        throws UniversalConnectionPoolException

Stops the connection pool. Connection pool object is obtained from manager by providing pool name as key. Pool operation is called to stop the connection pool. Stops the metric collection if it is already started.

Specified by:

stopConnectionPool in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection pool name to find the connection pool object from pool manager.

Throws:

UniversalConnectionPoolException - If an error occurs while stopping the connection pool.

refreshConnectionPool

public void refreshConnectionPool(String poolName)
                           throws UniversalConnectionPoolException

Refreshes the connection pool. Connection pool object is obtained from manager by providing pool name as key. Pool operation is called to refresh the connection pool.

Specified by:

refreshConnectionPool in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection pool name to find the connection pool object from pool manager.

Throws:

UniversalConnectionPoolException - If an error occurs while refreshing the connection pool.

recycleConnectionPool

public void recycleConnectionPool(String poolName)
                           throws UniversalConnectionPoolException

Recycles the connection pool. Connection pool object is obtained from manager by providing pool name as key. Pool operation is called to recycle the connection pool.This is similar to refresh(), but allows only invalid available connections in the pool to be replaced with new/fresh connections.

Specified by:

recycleConnectionPool in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection pool name to find the connection pool object from pool manager.

Throws:

UniversalConnectionPoolException - If an error occurs while recycling the connection pool.

purgeConnectionPool

public void purgeConnectionPool(String poolName)
                         throws UniversalConnectionPoolException

Purges the connection pool. Connection pool object is obtained from manager by providing pool name as key. Pool operation is called to purge the connection pool.

Removes all connections from the connection pool. The primary difference in behavior between this and refresh() is that the connection pool is left empty with no connections available after calling purge(). Some of the connection pool properties such as minPoolSize or initialPoolSize may not be honored when purging connections from the pool.

Specified by:

purgeConnectionPool in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection pool name to find the connection pool object from pool manager.

Throws:

UniversalConnectionPoolException - If an error occurs while purging the connection pool.

createConnectionPool

public UniversalConnectionPoolMBean createConnectionPool(UniversalConnectionPoolAdapter ucpAdapter)
                                                  throws UniversalConnectionPoolException

Creates a connection pool instance based on specified UCP Adapter. Pool and connection factory configuration properties should be set on the Adapter prior to invoking this method. The created pool instance will be added to this UCP manager.

Specified by:

createConnectionPool in interface UniversalConnectionPoolManagerMBean

Parameters:

UniversalConnectionPoolAdapter - The UCP Adapter for pool creation.

Throws:

UniversalConnectionPoolException - If an error occurs while creating the connection pool.

destroyConnectionPool

public void destroyConnectionPool(String poolName)
                           throws UniversalConnectionPoolException

Destroys the connection pool. Connection pool object is obtained from manager by providing pool name as key. Pool operation is called to stop the connection pool. Pool will be stopped and removed from the manager.

Specified by:

destroyConnectionPool in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection pool name to find the connection pool object from pool manager.

Throws:

UniversalConnectionPoolException - If an error occurs while destroying the connection pool.

reconfigureConnectionPool

public void reconfigureConnectionPool(String poolName,
                                      Properties configuration)
                               throws UniversalConnectionPoolException

Reconfigures the connection pool. The connection pool is obtained from the manager by providing poolName as key. The following properties are supported in the "configuration" parameter: initialPoolSize, minPoolSize, maxPoolSize, fastConnectionFailoverEnabled, maxIdleTime, maxConnectionReuseCount, maxConnectionReuseTime, maxStatements, abandonedConnectionTimeout, connectionHarvestMaxCount, timeoutCheckInterval, connectionHarvestTriggerCount, inactiveConnectionTimeout, propertyCycle, connectionWaitTimeout, validateConnectionOnBorrow, onsConfiguration, sqlForValidateConnection, timeToLiveConnectionTimeout, loginTimeout, highCostConnectionReuseThreshold, connectionLabelingHighCost, connectionAffinityCallback, connectionInitializationCallback, connectionLabelingCallback, secondsToTrustIdleConnection, connectionRepurposeThreshold.

Specified by:

reconfigureConnectionPool in interface UniversalConnectionPoolManagerMBean

Parameters:

poolName - Connection pool name registered with the universal connection pool manager.

configuration - the configuration input as Properties

Throws:

UniversalConnectionPoolException - If an error occurs while reconfiguring the connection pool.

getConnectionPoolNames

public String[] getConnectionPoolNames()
                                throws UniversalConnectionPoolException

Gets all the pool names managed by the UniversalConnectionPoolManager.

Specified by:

getConnectionPoolNames in interface UniversalConnectionPoolManagerMBean

Returns:

String[] List of connection pool Names, returned as a String Array.

Throws:

UniversalConnectionPoolException - If an error occurs while getting the pool names from UniversalConnectionPoolManager.

registerUniversalConnectionPoolMBean

public void registerUniversalConnectionPoolMBean(UniversalConnectionPoolMBean poolMBean)
                                          throws UniversalConnectionPoolException

Registers the UniversalConnectionPoolMBean instance with the MBean server. One UniversalConnectionPoolMBean is registered for every UniversalConnectionPool instance. The UniversalConnectionPoolMBean is created using the standard RequiredModelMBean class during the registration of the Model MBean.

Specified by:

registerUniversalConnectionPoolMBean in interface UniversalConnectionPoolManagerMBean

Parameters:

UniversalConnectionPoolMBean - UniversalConnectionPoolMBean to register in the MBeanServer.

Throws:

UniversalConnectionPoolException - If an error occurs while registering UniversalConnectionPoolMBean.

unregisterUniversalConnectionPoolMBean

public void unregisterUniversalConnectionPoolMBean(String poolName)
                                            throws UniversalConnectionPoolException

Unregisters the UniversalConnectionPoolMBean from the MBean server. The UniversalConnectionPoolMBean is created using the standard RequiredModelMBean class during the registration of the Model MBean.

Specified by:

unregisterUniversalConnectionPoolMBean in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Pool name to identify the UniversalConnectionPoolMBean and to unregister it from the MBeanServer.

Throws:

UniversalConnectionPoolException - If an error occurs while unregistering UniversalConnectionPoolMBean.

startMetricsCollection

public void startMetricsCollection(String poolName)
                            throws UniversalConnectionPoolException

Starts metric collection for the provided pool.

Specified by:

startMetricsCollection in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection pool name to find the connection pool object from the pool manager.

Throws:

UniversalConnectionPoolException - If an error occurs while starting metrics collection.

stopMetricsCollection

public void stopMetricsCollection(String poolName)
                           throws UniversalConnectionPoolException

Stops metric collection for the provided pool.

Specified by:

stopMetricsCollection in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection pool name to find the connection pool object from the pool manager.

Throws:

UniversalConnectionPoolException - If an error occurs while stopping metrics collection.

setMetricUpdateInterval

public void setMetricUpdateInterval(int interval)
                             throws UniversalConnectionPoolException

Sets the metric update interval value.

Specified by:

setMetricUpdateInterval in interface UniversalConnectionPoolManagerMBean

Parameters:

int - Value for metric update interval in seconds.

Throws:

UniversalConnectionPoolException - If an error occurs while updating metric interval.

getMetricUpdateInterval

public int getMetricUpdateInterval()

Gets the metric update interval value.

Specified by:

getMetricUpdateInterval in interface UniversalConnectionPoolManagerMBean

Returns:

The metric update interval in seconds.

getConnectionPoolLifeCycleState

public UniversalConnectionPoolLifeCycleState getConnectionPoolLifeCycleState(String poolName)
                                                                      throws UniversalConnectionPoolException

Gets the life cycle state of the UniversalConnectionPool.

Specified by:

getConnectionPoolLifeCycleState in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection pool name to find the connection pool object from UniversalConnectionPoolManager.

Returns:

UniversalConnectionPoolLifeCycleState The life cycle state of the connection pool.

Throws:

UniversalConnectionPoolException - If an error occurs while getting the UniversalConnectionPoolLifeCycleState.

setLogLevel

public void setLogLevel(Level newLogLevel)

Sets the log level for the UCP logger.

Specified by:

setLogLevel in interface UniversalConnectionPoolManagerMBean

Parameters:

Level - The new log level to be set for UCP logger.

getLogLevel

public Level getLogLevel()

Gets the log level for the logger.

Specified by:

getLogLevel in interface UniversalConnectionPoolManagerMBean

Returns:

Level Returns the Level object for the Logger.

getMBeanNameForConnectionPool

public String getMBeanNameForConnectionPool(String connectionPoolName)
                                     throws UniversalConnectionPoolException

Gets the MBean Name for the corresponding Universal Connection Pool MBean Object.

Specified by:

getMBeanNameForConnectionPool in interface UniversalConnectionPoolManagerMBean

Parameters:

String - Connection Pool Name for which MBean Name is queried

Returns:

String Returns the MBean Name String

Throws:

UniversalConnectionPoolException