Class ProxiedObjectPool<T>
- Type Parameters:
T
- type of the pooled object
- All Implemented Interfaces:
Closeable
,AutoCloseable
,ObjectPool<T>
- Since:
- 2.0
-
Constructor Summary
ConstructorDescriptionProxiedObjectPool
(ObjectPool<T> pool, org.apache.commons.pool2.proxy.ProxySource<T> proxySource) Constructs a new proxied object pool. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Creates an object using thefactory
or other implementation dependent mechanism, passivate it, and then place it in the idle object pool.Borrows an instance from this pool.void
clear()
Clears any objects sitting idle in the pool, releasing any associated resources (optional operation).void
close()
Closes this pool, and free any resources associated with it.int
Gets the number of instances currently borrowed from this pool.int
Gets the number of instances currently idle in this pool.void
invalidateObject
(T proxy) Invalidates an object from the pool.void
returnObject
(T proxy) Returns an instance to the pool.toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.commons.pool2.ObjectPool
addObjects, invalidateObject
-
Constructor Details
-
ProxiedObjectPool
public ProxiedObjectPool(ObjectPool<T> pool, org.apache.commons.pool2.proxy.ProxySource<T> proxySource) Constructs a new proxied object pool.- Parameters:
pool
- The object pool to wrapproxySource
- The source of the proxy objects
-
-
Method Details
-
addObject
Description copied from interface:ObjectPool
Creates an object using thefactory
or other implementation dependent mechanism, passivate it, and then place it in the idle object pool.addObject
is useful for "pre-loading" a pool with idle objects. (Optional operation).- Specified by:
addObject
in interfaceObjectPool<T>
- Throws:
Exception
- whenPooledObjectFactory.makeObject()
fails.IllegalStateException
- afterObjectPool.close()
has been called on this pool.UnsupportedOperationException
- when this pool cannot add new idle objects.
-
borrowObject
Description copied from interface:ObjectPool
Borrows an instance from this pool.Instances returned from this method will have been either newly created with
PooledObjectFactory.makeObject()
or will be a previously idle object and have been activated withPooledObjectFactory.activateObject(org.apache.commons.pool2.PooledObject<T>)
and then validated withPooledObjectFactory.validateObject(org.apache.commons.pool2.PooledObject<T>)
.By contract, clients must return the borrowed instance using
ObjectPool.returnObject(T)
,ObjectPool.invalidateObject(T)
, or a related method as defined in an implementation or sub-interface.The behavior of this method when the pool has been exhausted is not strictly specified (although it may be specified by implementations).
- Specified by:
borrowObject
in interfaceObjectPool<T>
- Returns:
- an instance from this pool.
- Throws:
IllegalStateException
- afterclose
has been called on this pool.Exception
- whenPooledObjectFactory.makeObject()
throws an exception.NoSuchElementException
- when the pool is exhausted and cannot or will not return another instance.
-
clear
Description copied from interface:ObjectPool
Clears any objects sitting idle in the pool, releasing any associated resources (optional operation). Idle objects cleared must bePooledObjectFactory.destroyObject(PooledObject)
.- Specified by:
clear
in interfaceObjectPool<T>
- Throws:
UnsupportedOperationException
- if this implementation does not support the operationException
- if the pool cannot be cleared
-
close
Description copied from interface:ObjectPool
Closes this pool, and free any resources associated with it.Calling
ObjectPool.addObject()
orObjectPool.borrowObject()
after invoking this method on a pool will cause them to throw anIllegalStateException
.Implementations should silently fail if not all resources can be freed.
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceObjectPool<T>
-
getNumActive
Description copied from interface:ObjectPool
Gets the number of instances currently borrowed from this pool. Returns a negative value if this information is not available.- Specified by:
getNumActive
in interfaceObjectPool<T>
- Returns:
- the number of instances currently borrowed from this pool.
-
getNumIdle
Description copied from interface:ObjectPool
Gets the number of instances currently idle in this pool. This may be considered an approximation of the number of objects that can beborrowed
without creating any new instances. Returns a negative value if this information is not available.- Specified by:
getNumIdle
in interfaceObjectPool<T>
- Returns:
- the number of instances currently idle in this pool.
-
invalidateObject
Description copied from interface:ObjectPool
Invalidates an object from the pool.By contract,
obj
must have been obtained usingObjectPool.borrowObject()
or a related method as defined in an implementation or sub-interface.This method should be used when an object that has been borrowed is determined (due to an exception or other problem) to be invalid.
- Specified by:
invalidateObject
in interfaceObjectPool<T>
- Parameters:
proxy
- aborrowed
instance to be disposed.- Throws:
Exception
- if the instance cannot be invalidated
-
returnObject
Description copied from interface:ObjectPool
Returns an instance to the pool. By contract,obj
must have been obtained usingObjectPool.borrowObject()
or a related method as defined in an implementation or sub-interface.- Specified by:
returnObject
in interfaceObjectPool<T>
- Parameters:
proxy
- aborrowed
instance to be returned.- Throws:
IllegalStateException
- if an attempt is made to return an object to the pool that is in any state other than allocated (i.e. borrowed). Attempting to return an object more than once or attempting to return an object that was never borrowed from the pool will trigger this exception.Exception
- if an instance cannot be returned to the pool
-
toString
-