File	Doc	Category	Size	Date	Package
JBossManagedConnectionPoolMBean.java	API Doc	JBoss 4.2.1	8097	Fri Jul 13 21:01:18 BST 2007	org.jboss.resource.connectionmanager

JBossManagedConnectionPoolMBean

Fields Summary
public static final ObjectName	OBJECT_NAME

Constructors Summary

Methods Summary
public void	flush() The flush method puts all currently checked out connections on a list to be destroyed when returned and disposes of all current pooled connections.
public long	getAvailableConnectionCount() Get number of available free connections return number of available connections
public boolean	getBackGroundValidation() Get background validation return true of false if background validation is enabled.
public long	getBackGroundValidationMinutes() Get the background validation in minutes return the background validation in minutes
public int	getBlockingTimeoutMillis() The BlockingTimeoutMillis attribute indicates the maximum time to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. return the BlockingTimeout value.
public int	getConnectionCount() Retrieve the connection count. return the connection count
public int	getConnectionCreatedCount() Retrieve the connection created count. return the connection created count
public int	getConnectionDestroyedCount() Retrieve the destrooyed count. return the destroyed count
public java.lang.String	getCriteria() The Criteria attribute indicates if Subject (from security domain) or app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool. Choices are ByContainerAndApplication (use both), ByContainer (use Subject), ByApplication (use app supplied params only), ByNothing (all connections are equivalent, usually if adapter supports reauthentication) return the Criteria value.
public long	getIdleTimeoutMinutes() The IdleTimeoutMinutes attribute indicates the maximum time a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is 1/2 the smallest IdleTimeout of any pool. return the IdleTimeoutMinutes value.
public long	getInUseConnectionCount() Get number of connections currently in use return number of connections currently in use
public javax.management.ObjectName	getManagedConnectionFactoryName() ManagedConnectionFactoryName holds the ObjectName of the mbean that represents the ManagedConnectionFactory. Normally this can be an embedded mbean in a depends element rather than a separate mbean reference. return the ManagedConnectionFactoryName value.
public org.jboss.resource.connectionmanager.ManagedConnectionPool	getManagedConnectionPool() ManagedConnectionPool is a read only attribute returning the pool set up by this mbean. return the ManagedConnectionPool implementing the pool configured by this mbean.
public long	getMaxConnectionsInUseCount()
public int	getMaxSize() The MaxSize attribute indicates the maximum number of connections for a pool. No more than MaxSize connections will be created in each sub-pool. return the MaxSize value.
public int	getMinSize() The MinSize attribute indicates the minimum number of connections this pool should hold. These are not created until a Subject is known from a request for a connection. MinSize connections will be created for each sub-pool. return the MinSize value.
public boolean	getNoTxSeparatePools() Separate pools for transactional use return true when connections should have different pools for transactional and non-transaction use.
public java.lang.String	getPoolJndiName() Get the jndi name of the pool return the jndi name of the pool.
public boolean	getPreFill() Get prefill return true or false depending upon prefill being set
public boolean	getUseFastFail() Whether or not we want to immeadiately create a new connection when an attempt to acquire a connection from the pool fails. return true of false depending upon whether fast fail is being used.
public void	setBackGroundValidation(boolean backgroundValidation) Set the background validation param backgroundValidation true or false if background validation is to be enabled
public void	setBackGroundValidationMinutes(long backgroundValidationInterval) Set the background validation in minutes param backgroundValidationInterval the background interval in minutes
public void	setBlockingTimeoutMillis(int newBlockingTimeout) Set the BlockingTimeout value. param newBlockingTimeout The new BlockingTimeout value.
public void	setCriteria(java.lang.String newCriteria) Set the Criteria value. param newCriteria The new Criteria value.
public void	setIdleTimeoutMinutes(long newIdleTimeoutMinutes) Set the IdleTimeoutMinutes value. param newIdleTimeoutMinutes The new IdleTimeoutMinutes value.
public void	setManagedConnectionFactoryName(javax.management.ObjectName newManagedConnectionFactoryName) Set the ManagedConnectionFactoryName value. param newManagedConnectionFactoryName The new ManagedConnectionFactoryName value.
public void	setMaxSize(int newMaxSize) Set the MaxSize value. param newMaxSize The new MaxSize value.
public void	setMinSize(int newMinSize) Set the MinSize value. param newMinSize The new MinSize value.
public void	setNoTxSeparatePools(boolean value)
public void	setPoolJndiName(java.lang.String poolName) Set the jndi name of the pool. param poolName the jndi name of the pool.
public void	setPreFill(boolean prefill) Set the prefill param prefill true or false depending upon if prefill is being used
public void	setUseFastFail(boolean useFastFail) Indicate whether or not we want to immeadiately create a new connection when an attempt to acquire a connection from the pool fails. param useFastFail whether or not we want to use fast fail semantics in a connection attempt.