Skip navigation links

Oracle® Universal Connection Pool for JDBC Java API Reference
12c Release 1 (12.1)

E17662-07


oracle.ucp.admin
Interface UniversalConnectionPoolMBean


public interface UniversalConnectionPoolMBean

The Universal Connection Pool MBean defines operations and attributes for managing the Universal Connection Pool. The MBean is always associated with a pool instance. Remote users can get access to these operations and attributes using JMX operations.


Method Summary
 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 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.
 int getConnectionWaitTimeout()
          Gets the connection wait timeout of the Universal Connection Pool instance.
 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.
 UniversalConnectionPoolLifeCycleState 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.
 UniversalConnectionPoolStatistics getStatistics()
          Gets statistics for the Universal Connection Pool instance.
 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.
 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 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.

 

Method Detail

refresh

void refresh()
             throws UniversalConnectionPoolException
Refreshes the Universal Connection Pool instance.
Throws:
UniversalConnectionPoolException - If an error occurs while refreshing the Universal Connection Pool instance.

recycle

void recycle()
             throws UniversalConnectionPoolException
Recycles the Universal Connection Pool instance.
Throws:
UniversalConnectionPoolException - If an error occurs while recycling the Universal Connection Pool instance.

purge

void purge()
           throws UniversalConnectionPoolException
Purges the Universal Connection Pool instance.
Throws:
UniversalConnectionPoolException - If an error occurs while purging the Universal Connection Pool instance.

start

void start()
           throws UniversalConnectionPoolException
Starts the Universal Connection Pool instance.
Throws:
UniversalConnectionPoolException - If an error occurs while starting the Universal Connection Pool instance.

stop

void stop()
          throws UniversalConnectionPoolException
Stops the Universal Connection Pool instance.
Throws:
UniversalConnectionPoolException - If an error occurs while stopping the Universal Connection Pool instance.

getName

java.lang.String getName()
Gets the name of the Universal Connection Pool instance.
Returns:
String Returns the name.

setName

void setName(java.lang.String name)
             throws UniversalConnectionPoolException
Sets the name of the Universal Connection Pool instance.
Parameters:
String - A new name for the Universal Connection Pool instance.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the name.

getInitialPoolSize

int getInitialPoolSize()
Gets the initial pool size of the Universal Connection Pool instance.
Returns:
The initial pool size.

setInitialPoolSize

void setInitialPoolSize(int initialPoolSize)
                        throws UniversalConnectionPoolException
Sets the initial pool size of the Universal Connection Pool instance.
Parameters:
int - New initial pool size.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the initial pool size.

getMinPoolSize

int getMinPoolSize()
Gets the minimum pool size of the Universal Connection Pool instance.
Returns:
The minimum pool size.

setMinPoolSize

void setMinPoolSize(int minPoolSize)
                    throws UniversalConnectionPoolException
Sets the minimum pool size of the Universal Connection Pool instance.
Parameters:
int - New minimum pool size.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the minimum pool.

getMaxPoolSize

int getMaxPoolSize()
Gets the maximum pool size of the Universal Connection Pool instance.
Returns:
The maximum pool size.

setMaxPoolSize

void setMaxPoolSize(int maxPoolSize)
                    throws UniversalConnectionPoolException
Sets the maximum pool size of the Universal Connection Pool instance.
Parameters:
int - New maximum pool size.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the maximum pool size.

getInactiveConnectionTimeout

int getInactiveConnectionTimeout()
Gets the inactive connection timeout of the Universal Connection Pool instance.
Returns:
The inactive connection timeout.

setInactiveConnectionTimeout

void setInactiveConnectionTimeout(int inactiveConnectionTimeout)
                                  throws UniversalConnectionPoolException
Sets the inactive connection timeout.
Parameters:
int - New inactive connection timeout.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the inactive connection timeout.

getAbandonedConnectionTimeout

int getAbandonedConnectionTimeout()
Gets the abandoned connection timeout of the Universal Connection Pool instance.
Returns:
The abandoned connection timeout.

setAbandonedConnectionTimeout

void setAbandonedConnectionTimeout(int abandonedConnectionTimeout)
                                   throws UniversalConnectionPoolException
Sets the abandoned connection timeout of the Universal Connection Pool instance.
Parameters:
int - New abandoned connection timeout.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the abandoned connection timeout.

getConnectionWaitTimeout

int getConnectionWaitTimeout()
Gets the connection wait timeout of the Universal Connection Pool instance.
Returns:
The connection wait timeout.

setConnectionWaitTimeout

void setConnectionWaitTimeout(int connectionWaitTimeout)
                              throws UniversalConnectionPoolException
Sets the connection wait timeout of the Universal Connection Pool instance.
Parameters:
int - New connection wait timeout.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the connection wait timeout.

getTimeToLiveConnectionTimeout

int getTimeToLiveConnectionTimeout()
Gets the time to live connection timeout of the Universal Connection Pool instance.
Returns:
The time to live connection timeout.

setTimeToLiveConnectionTimeout

void setTimeToLiveConnectionTimeout(int timeToLiveConnectionTimeout)
                                    throws UniversalConnectionPoolException
Sets the time to live connection timeout of the Universal Connection Pool instance.
Parameters:
int - New time to live connection timeout.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the time to live connection timeout.

getTimeoutCheckInterval

int getTimeoutCheckInterval()
Gets the timeout check interval of the Universal Connection Pool instance.
Returns:
The timeout check interval.

setTimeoutCheckInterval

void setTimeoutCheckInterval(int timeoutCheckInterval)
                             throws UniversalConnectionPoolException
Sets the timeout check interval of the Universal Connection Pool instance.
Parameters:
int - New timeout check interval.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the timeout check interval.

getValidateConnectionOnBorrow

boolean getValidateConnectionOnBorrow()
Gets the validate connection on borrow value of the Universal Connection Pool instance.
Returns:
The validate connection on borrow value.

setValidateConnectionOnBorrow

void setValidateConnectionOnBorrow(boolean validateConnectionOnBorrow)
Sets the validate connection on borrow value for the Universal Connection Pool instance.
Parameters:
boolean - New validate connection on borrow value.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the validate connection on borrow value.

getConnectionHarvestTriggerCount

int getConnectionHarvestTriggerCount()
Gets the connection harvest trigger count of the Universal Connection Pool instance.
Returns:
The connection harvest trigger count.

setConnectionHarvestTriggerCount

void setConnectionHarvestTriggerCount(int connectionHarvestTriggerCount)
                                      throws UniversalConnectionPoolException
Sets the connection harvest trigger count for the Universal Connection Pool instance.
Parameters:
int - New connection harvest trigger count.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the connection harvest trigger count.

getConnectionHarvestMaxCount

int getConnectionHarvestMaxCount()
Gets the connection harvest maximum count of the Universal Connection Pool instance.
Returns:
The connection harvest maximum count.

setConnectionHarvestMaxCount

void setConnectionHarvestMaxCount(int connectionHarvestMaxCount)
                                  throws UniversalConnectionPoolException
Sets the connection harvest maximum count for the Universal Connection Pool instance.
Parameters:
int - New connection harvest maximum count.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the connection harvest maximum count.

getMaxConnectionReuseTime

long getMaxConnectionReuseTime()
Gets the maximum connection reuse time of the Universal Connection Pool instance.
Returns:
The maximum connection reuse time.

setMaxConnectionReuseTime

void setMaxConnectionReuseTime(long maxConnectionReuseTime)
                               throws UniversalConnectionPoolException
Sets the maximum connection reuse time for the Universal Connection Pool instance.
Parameters:
long - New maximum connection reuse time (in seconds).
Throws:
UniversalConnectionPoolException - If an error occurs while changing the maximum connection reuse time.

getMaxConnectionReuseCount

int getMaxConnectionReuseCount()
Gets the maximum connection reuse count of the Universal Connection Pool instance.
Returns:
The maximum connection reuse count.

setMaxConnectionReuseCount

void setMaxConnectionReuseCount(int maxConnectionReuseCount)
                                throws UniversalConnectionPoolException
Sets the maximum connection reuse count for the Universal Connection Pool instance.
Parameters:
int - New maximum connection reuse count.
Throws:
UniversalConnectionPoolException - If an error occurs while changing the maximum connection reuse count.

getAvailableConnectionsCount

int getAvailableConnectionsCount()
Gets the available connections count of the Universal Connection Pool instance.
Returns:
The available connections count.

getBorrowedConnectionsCount

int getBorrowedConnectionsCount()
Gets the borrowed connections count of the Universal Connection Pool instance.
Returns:
The borrowed connections count.

getStatistics

UniversalConnectionPoolStatistics getStatistics()
Gets statistics for the Universal Connection Pool instance.
Returns:
The statistics.

getLifeCycleState

UniversalConnectionPoolLifeCycleState getLifeCycleState()
Gets the lifecycle state of Universal Connection Pool instance.
Returns:
The lifecycle state.

getUCPMBeanAttributes

javax.management.modelmbean.ModelMBeanAttributeInfo[] getUCPMBeanAttributes()
                                                                            throws UniversalConnectionPoolException
Builds the attribute information for the Universal Connection Pool MBean.
Returns:
ModelMBeanAttributeInfo[].
Throws:
UniversalConnectionPoolException - If an error occurs while getting ModelMBeanAttributeInfo[].

getUCPMBeanOperations

javax.management.modelmbean.ModelMBeanOperationInfo[] getUCPMBeanOperations()
                                                                            throws UniversalConnectionPoolException
Builds the operation information for the Universal Connection Pool MBean.
Returns:
ModelMBeanOperationInfo[].
Throws:
UniversalConnectionPoolException - If an error occurs while getting ModelMBeanOperationInfo[].

getMBeanInfo

javax.management.modelmbean.ModelMBeanInfo getMBeanInfo(javax.management.ObjectName mbeanObjName,
                                                        java.lang.String mbeanDisplayName)
                                                        throws UniversalConnectionPoolException
Builds MBeanInfo to define attributes, constructors, operations and notifications to expose to the remote users.
Parameters:
ObjectName - Unique name for the Universal Connection Pool MBean.
String - Display name for the Universal Connection Pool MBean.
Returns:
ModelMBeanInfo for Universal Connection Pool MBean.
Throws:
UniversalConnectionPoolException - If an error occurs while getting ModelMBeanInfo for the Universal Connection Pool MBean.

Skip navigation links

Oracle® Universal Connection Pool for JDBC Java API Reference
12c Release 1 (12.1)

E17662-07


Copyright © 2007, 2013, Oracle and/or its affiliates. All rights reserved.