Class PoolUtils.SynchronizedPooledObjectFactory<T>

  • All Implemented Interfaces:
    PooledObjectFactory<T>
    Enclosing class:
    PoolUtils

    private static class PoolUtils.SynchronizedPooledObjectFactory<T>
    extends java.lang.Object
    implements PooledObjectFactory<T>
    A fully synchronized PooledObjectFactory that wraps a PooledObjectFactory and synchronizes access to the wrapped factory methods.

    Note: This should not be used on pool implementations that already provide proper synchronization such as the pools provided in the Commons Pool library.

    • Field Detail

      • writeLock

        private final java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock writeLock
        Synchronization lock
    • Constructor Detail

      • SynchronizedPooledObjectFactory

        SynchronizedPooledObjectFactory​(PooledObjectFactory<T> factory)
                                 throws java.lang.IllegalArgumentException
        Create a SynchronizedPoolableObjectFactory wrapping the given factory.
        Parameters:
        factory - underlying factory to wrap
        Throws:
        java.lang.IllegalArgumentException - if the factory is null
    • Method Detail

      • makeObject

        public PooledObject<T> makeObject()
                                   throws java.lang.Exception
        Create an instance that can be served by the pool and wrap it in a PooledObject to be managed by the pool.
        Specified by:
        makeObject in interface PooledObjectFactory<T>
        Returns:
        a PooledObject wrapping an instance that can be served by the pool
        Throws:
        java.lang.Exception - if there is a problem creating a new instance, this will be propagated to the code requesting an object.
      • destroyObject

        public void destroyObject​(PooledObject<T> p)
                           throws java.lang.Exception
        Destroys an instance no longer needed by the pool.

        It is important for implementations of this method to be aware that there is no guarantee about what state obj will be in and the implementation should be prepared to handle unexpected errors.

        Also, an implementation must take in to consideration that instances lost to the garbage collector may never be destroyed.

        Specified by:
        destroyObject in interface PooledObjectFactory<T>
        Parameters:
        p - a PooledObject wrapping the instance to be destroyed
        Throws:
        java.lang.Exception - should be avoided as it may be swallowed by the pool implementation.
        See Also:
        PooledObjectFactory.validateObject(org.apache.commons.pool2.PooledObject<T>), ObjectPool.invalidateObject(T)
      • validateObject

        public boolean validateObject​(PooledObject<T> p)
        Ensures that the instance is safe to be returned by the pool.
        Specified by:
        validateObject in interface PooledObjectFactory<T>
        Parameters:
        p - a PooledObject wrapping the instance to be validated
        Returns:
        false if obj is not valid and should be dropped from the pool, true otherwise.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object