Package org.apache.commons.pool

Interface KeyedPoolableObjectFactory<K,​V>

  • Type Parameters:
    K - the type of keys in this pool
    V - the type of objects held in this pool
    All Known Implementing Classes:
    BaseKeyedPoolableObjectFactory
    public interface KeyedPoolableObjectFactory<K,​V>
    An interface defining life-cycle methods for instances to be served by a KeyedObjectPool.

    By contract, when an KeyedObjectPool delegates to a KeyedPoolableObjectFactory,

    1. makeObject is called whenever a new instance is needed.
    2. activateObject is invoked on every instance that has been passivated before it is borrowed from the pool.
    3. validateObject is invoked on activated instances to make sure they can be borrowed from the pool. validateObject may also be used to test an instance being returned to the pool before it is passivated. It will only be invoked on an activated instance.
    4. passivateObject is invoked on every instance when it is returned to the pool.
    5. destroyObject is invoked on every instance when it is being "dropped" from the pool (whether due to the response from validateObject, or for reasons specific to the pool implementation.) There is no guarantee that the instance being destroyed will be considered active, passive or in a generally consistent state.

    KeyedPoolableObjectFactory must be thread-safe. The only promise an KeyedObjectPool makes is that the same instance of an object will not be passed to more than one method of a KeyedPoolableObjectFactory at a time.

    Since:
    Pool 1.0
    Version:
    $Revision: 1222388 $ $Date: 2011-12-22 13:28:27 -0500 (Thu, 22 Dec 2011) $
    Author:
    Rodney Waldhoff, Sandy McArthur
    See Also:
    KeyedObjectPool

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void activateObject​(K key, V obj)
      Reinitialize an instance to be returned by the pool.
      void destroyObject​(K key, V obj)
      Destroy an instance no longer needed by the pool.
      V makeObject​(K key)
      Create an instance that can be served by the pool.
      void passivateObject​(K key, V obj)
      Uninitialize an instance to be returned to the idle object pool.
      boolean validateObject​(K key, V obj)
      Ensures that the instance is safe to be returned by the pool.

    • Method Detail

      • makeObject

        V makeObject​(K key)
      throws Exception
        Create an instance that can be served by the pool.
        Parameters:
        key - the key used when constructing the object
        Returns:
        an instance that can be served by the pool.
        Throws:
        Exception - if there is a problem creating a new instance, this will be propagated to the code requesting an object.

      • destroyObject

        void destroyObject​(K key,
                   V obj)
            throws Exception
        Destroy 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.

        Parameters:
        key - the key used when selecting the instance
        obj - the instance to be destroyed
        Throws:
        Exception - should be avoided as it may be swallowed by the pool implementation.
        See Also:
        validateObject(K, V), KeyedObjectPool.invalidateObject(K, V)

      • validateObject

        boolean validateObject​(K key,
                       V obj)
        Ensures that the instance is safe to be returned by the pool. Returns false if obj should be destroyed.
        Parameters:
        key - the key used when selecting the object
        obj - the instance to be validated
        Returns:
        false if obj is not valid and should be dropped from the pool, true otherwise.

      • activateObject

        void activateObject​(K key,
                    V obj)
             throws Exception
        Reinitialize an instance to be returned by the pool.
        Parameters:
        key - the key used when selecting the object
        obj - the instance to be activated
        Throws:
        Exception - if there is a problem activating obj, this exception may be swallowed by the pool.
        See Also:
        destroyObject(K, V)

      • passivateObject

        void passivateObject​(K key,
                     V obj)
              throws Exception
        Uninitialize an instance to be returned to the idle object pool.
        Parameters:
        key - the key used when selecting the object
        obj - the instance to be passivated
        Throws:
        Exception - if there is a problem passivating obj, this exception may be swallowed by the pool.
        See Also:
        destroyObject(K, V)