oracle.ucp.admin

Class UniversalConnectionPoolManagerBase

java.lang.Object

oracle.ucp.admin.UniversalConnectionPoolManagerBase

All Implemented Interfaces:

UniversalConnectionPoolManager

Direct Known Subclasses:

UniversalConnectionPoolManagerImpl

public abstract class UniversalConnectionPoolManagerBase
extends Object
implements UniversalConnectionPoolManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UniversalConnectionPoolManagerBase.UCPMetric

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,UniversalConnectionPool>	m_connPool
protected Map<String,String>	m_mappedPoolNames

Constructor Summary

Constructors

Constructor and Description
UniversalConnectionPoolManagerBase()

Method Summary

Modifier and Type	Method and Description
void	createConnectionPool(UniversalConnectionPoolAdapter ucpAdapter) Creates a connection pool instance based on specified UCP Adapter.
void	destroyConnectionPool(String poolName) Destroys the connection pool.
UniversalConnectionPool	getConnectionPool(String poolName) Gets the UniversalConnectionPool from UniversalConnectionPoolManager Object.
String[]	getConnectionPoolNames() Gets all the pool names managed by the UniversalConnectionPoolManager.
Level	getLogLevel() Gets the log level for UCP logger.
protected String	getManagerPoolID(String poolName) Gets the uniquePoolID for a provided poolName from the UniversalConnectionPoolManager.
int	getMetricUpdateInterval() Gets the metric update interval value.
protected oracle.dms.instrument.StateIntf	getStateMetric(String poolName, UniversalConnectionPoolManagerBase.UCPMetric ucpMetric) Gets the StateMetric for the requested pool.
static TaskManager	getTaskManager() Gets the Task Manager.
static TimerManager	getTimerManager() Gets the Timer Manager.
boolean	isJmxEnabled() Determines the JMX availability.
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	setConnectionPool(UniversalConnectionPool connectionPool) Sets the UniversalConnectionPool with UniversalConnectionPoolManager Object.
void	setJmxEnabled(boolean jmxFlag) Sets the jmxFlag to true/false.
void	setLogLevel(Level newLogLevel) Sets the log level for the UCP logger.
protected void	setManagerPoolID(String poolName, String newPoolName) Changes the pool mapping for the provided pool in UniversalConnectionPoolManager Object.
protected void	setMetricConsole(oracle.dms.console.DMSConsole metricConsole) Sets the MetricConsole for UCP metrics collection.
protected void	setMetricParentNoun(String poolName, oracle.dms.instrument.NounIntf metricParentNoun) Sets the Parent Noun for the provided pool to gather UCP metrics.
void	setMetricUpdateInterval(int metricInterval) Sets the metric update interval value.
static boolean	setTaskManager(TaskManager taskManager) Sets a new Task Manager.
static boolean	setTimerManager(TimerManager timerManager) Sets new Timer Manager All running timers must be stopped prior to replacing a timer manager.
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.

Methods inherited from class java.lang.Object

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

Field Detail

m_connPool

protected final Map<String,UniversalConnectionPool> m_connPool

m_mappedPoolNames

protected final Map<String,String> m_mappedPoolNames

Constructor Detail

UniversalConnectionPoolManagerBase

public UniversalConnectionPoolManagerBase()

Method Detail

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 UniversalConnectionPoolManager

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 UniversalConnectionPoolManager

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 UniversalConnectionPoolManager

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 UniversalConnectionPoolManager

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 UniversalConnectionPoolManager

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.

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 UniversalConnectionPoolManager

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 UniversalConnectionPoolManager

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.

createConnectionPool

public void 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 UniversalConnectionPoolManager

Parameters:

UniversalConnectionPoolAdapter - The UCP Adapter for pool creation.

Throws:

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

setConnectionPool

public void setConnectionPool(UniversalConnectionPool connectionPool)
                       throws UniversalConnectionPoolException

Sets the UniversalConnectionPool with UniversalConnectionPoolManager Object. Once the pool is stored with UniversalConnectionPoolManager, it can be maintained with the operations provided on pool manager.

Specified by:

setConnectionPool in interface UniversalConnectionPoolManager

Parameters:

UniversalConnectionPool - UniversalConnectionPool object to be maintained by UniversalConnectionPoolManager.

Throws:

UniversalConnectionPoolException - If an error occurs while storing UniversalConnectionPool with UniversalConnectionPoolManager.

getConnectionPool

public UniversalConnectionPool getConnectionPool(String poolName)
                                          throws UniversalConnectionPoolException

Gets the UniversalConnectionPool from UniversalConnectionPoolManager Object.

Specified by:

getConnectionPool in interface UniversalConnectionPoolManager

Parameters:

String - Connection pool name to get UniversalConnectionPool from UniversalConnectionPoolManager.

Throws:

UniversalConnectionPoolException - If an error occurs while getting UniversalConnectionPool from UniversalConnectionPoolManager.

getConnectionPoolNames

public String[] getConnectionPoolNames()
                                throws UniversalConnectionPoolException

Gets all the pool names managed by the UniversalConnectionPoolManager.

Specified by:

getConnectionPoolNames in interface UniversalConnectionPoolManager

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.

setManagerPoolID

protected void setManagerPoolID(String poolName,
                                String newPoolName)
                         throws UniversalConnectionPoolException

Changes the pool mapping for the provided pool in UniversalConnectionPoolManager Object.

Parameters:

String - poolName that needs to be changed.

String - poolName that needs to be assigned.

Throws:

UniversalConnectionPoolException - If an error occurs while changing the mapped Pool ID in the UniversalConnectionPoolManager.

getManagerPoolID

protected String getManagerPoolID(String poolName)
                           throws UniversalConnectionPoolException

Gets the uniquePoolID for a provided poolName from the UniversalConnectionPoolManager.

Parameters:

String - Connection pool name to get uniquePoolID from UniversalConnectionPoolManager.

Returns:

String Returns the uniquePoolID for the provided pool name.

Throws:

UniversalConnectionPoolException - If an error occurs while getting mapped pool ID from UniversalConnectionPoolManager.

startMetricsCollection

public void startMetricsCollection(String poolName)
                            throws UniversalConnectionPoolException

Starts metric collection for the provided pool.

Specified by:

startMetricsCollection in interface UniversalConnectionPoolManager

Parameters:

String - Connection pool name to find the connection pool object from 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 UniversalConnectionPoolManager

Parameters:

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

Throws:

UniversalConnectionPoolException - If an error occurs while stopping metrics collection.

setMetricUpdateInterval

public void setMetricUpdateInterval(int metricInterval)
                             throws UniversalConnectionPoolException

Sets the metric update interval value.

Specified by:

setMetricUpdateInterval in interface UniversalConnectionPoolManager

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 UniversalConnectionPoolManager

Returns:

The metric update interval in seconds.

setJmxEnabled

public void setJmxEnabled(boolean jmxFlag)
                   throws UniversalConnectionPoolException

Sets the jmxFlag to true/false.

Specified by:

setJmxEnabled in interface UniversalConnectionPoolManager

Parameters:

boolean - Flag to know if JMX is enabled or not.

Throws:

UniversalConnectionPoolException - If an error occurs while setting jmxFlag.

isJmxEnabled

public boolean isJmxEnabled()

Determines the JMX availability.

Specified by:

isJmxEnabled in interface UniversalConnectionPoolManager

Returns:

boolean Returns true if JMX is enabled otherwise false.

setLogLevel

public void setLogLevel(Level newLogLevel)

Sets the log level for the UCP logger.

Specified by:

setLogLevel in interface UniversalConnectionPoolManager

Parameters:

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

getLogLevel

public Level getLogLevel()

Gets the log level for UCP logger.

Specified by:

getLogLevel in interface UniversalConnectionPoolManager

Returns:

Level Returns the Level object for UCP logger.

setMetricConsole

protected void setMetricConsole(oracle.dms.console.DMSConsole metricConsole)

Sets the MetricConsole for UCP metrics collection.

Parameters:

DMSConsole - Console to be set for UCP metrics collection.

setMetricParentNoun

protected void setMetricParentNoun(String poolName,
                                   oracle.dms.instrument.NounIntf metricParentNoun)

Sets the Parent Noun for the provided pool to gather UCP metrics.

Parameters:

String - poolName for the Metric parent noun.

NounIntf - Metric parent noun to assign to a connection pool.

getStateMetric

protected oracle.dms.instrument.StateIntf getStateMetric(String poolName,
                                                         UniversalConnectionPoolManagerBase.UCPMetric ucpMetric)

Gets the StateMetric for the requested pool.

Parameters:

String - poolName to get the UCPMetric.

Returns:

StateIntf Returns the UCP State metric for requested pool.

getTimerManager

public static TimerManager getTimerManager()

Gets the Timer Manager.

Returns:

Timer Manager.

setTimerManager

public static boolean setTimerManager(TimerManager timerManager)

Sets new Timer Manager All running timers must be stopped prior to replacing a timer manager.

Parameters:

timerManager - new timer manager object to set.

Returns:

true, if successful, otherwise some pools were not stopped, hence manager setting is not allowed.

getTaskManager

public static TaskManager getTaskManager()

Gets the Task Manager.

Returns:

Task Manager.

setTaskManager

public static boolean setTaskManager(TaskManager taskManager)

Sets a new Task Manager. All running tasks must be stopped prior to replacing a timer manager.

Parameters:

taskManager - new task manager object to set.

Returns:

true, if successful, otherwise some pools were not stopped, hence manager setting is not allowed.