Package org.apache.commons.pool.impl

Class GenericKeyedObjectPoolFactory<K,​V>

    • Field Detail

      • _maxIdle

        @Deprecated
protected int _maxIdle
        Deprecated.
        to be removed in pool 2.0. Use getMaxIdle().
        The maxIdle setting for pools created by this factory.

      • _maxActive

        @Deprecated
protected int _maxActive
        Deprecated.
        to be removed in pool 2.0. Use getMaxActive().
        The maxActive setting for pools created by this factory.

      • _maxTotal

        @Deprecated
protected int _maxTotal
        Deprecated.
        to be removed in pool 2.0. Use getMaxTotal().
        The maxTotal setting for pools created by this factory.

      • _minIdle

        @Deprecated
protected int _minIdle
        Deprecated.
        to be removed in pool 2.0. Use getMinIdle().
        The minIdle setting for pools created by this factory.

      • _maxWait

        @Deprecated
protected long _maxWait
        Deprecated.
        to be removed in pool 2.0. Use getMaxWait().
        The maxWait setting for pools created by this factory.

      • _testOnBorrow

        @Deprecated
protected boolean _testOnBorrow
        Deprecated.
        to be removed in pool 2.0. Use getTestOnBorrow().
        The testOnBorrow setting for pools created by this factory.

      • _testOnReturn

        @Deprecated
protected boolean _testOnReturn
        Deprecated.
        to be removed in pool 2.0. Use getTestOnReturn().
        The testOnReturn setting for pools created by this factory.

      • _testWhileIdle

        @Deprecated
protected boolean _testWhileIdle
        Deprecated.
        to be removed in pool 2.0. Use getTestWhileIdle().
        The testWhileIdle setting for pools created by this factory.

      • _lifo

        @Deprecated
protected boolean _lifo
        Deprecated.
        to be removed in pool 2.0. Use getLifo().
        The lifo setting for pools created by this factory.

    • Constructor Detail

      • GenericKeyedObjectPoolFactory

        public GenericKeyedObjectPoolFactory​(KeyedPoolableObjectFactory<K,​V> factory,
                                     int maxActive,
                                     byte whenExhaustedAction,
                                     long maxWait)
        Create a new GenericKeyedObjectPoolFactory.
        Parameters:
        factory - the KeyedPoolableObjectFactory to used by created pools.
        maxActive - the maximum number of objects that can be borrowed from pools at one time.
        whenExhaustedAction - the action to take when the pool is exhausted.
        maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
        See Also:
        GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long)

      • GenericKeyedObjectPoolFactory

        public GenericKeyedObjectPoolFactory​(KeyedPoolableObjectFactory<K,​V> factory,
                                     int maxActive,
                                     byte whenExhaustedAction,
                                     long maxWait,
                                     boolean testOnBorrow,
                                     boolean testOnReturn)
        Create a new GenericKeyedObjectPoolFactory.
        Parameters:
        factory - the KeyedPoolableObjectFactory to used by created pools.
        maxActive - the maximum number of objects that can be borrowed from pools at one time.
        whenExhaustedAction - the action to take when the pool is exhausted.
        maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
        testOnBorrow - whether to validate objects before they are returned by borrowObject.
        testOnReturn - whether to validate objects after they are returned to returnObject.
        See Also:
        GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, boolean, boolean)

      • GenericKeyedObjectPoolFactory

        public GenericKeyedObjectPoolFactory​(KeyedPoolableObjectFactory<K,​V> factory,
                                     int maxActive,
                                     byte whenExhaustedAction,
                                     long maxWait,
                                     int maxIdle)
        Create a new GenericKeyedObjectPoolFactory.
        Parameters:
        factory - the KeyedPoolableObjectFactory to used by created pools.
        maxActive - the maximum number of objects that can be borrowed from pools at one time.
        whenExhaustedAction - the action to take when the pool is exhausted.
        maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
        maxIdle - the maximum number of idle objects in the pools.
        See Also:
        GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int)

      • GenericKeyedObjectPoolFactory

        public GenericKeyedObjectPoolFactory​(KeyedPoolableObjectFactory<K,​V> factory,
                                     int maxActive,
                                     byte whenExhaustedAction,
                                     long maxWait,
                                     int maxIdle,
                                     int maxTotal)
        Create a new GenericKeyedObjectPoolFactory.
        Parameters:
        factory - the KeyedPoolableObjectFactory to used by created pools.
        maxActive - the maximum number of objects that can be borrowed from pools at one time.
        whenExhaustedAction - the action to take when the pool is exhausted.
        maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
        maxIdle - the maximum number of idle objects in the pools.
        maxTotal - the maximum number of objects that can exists at one time.

      • GenericKeyedObjectPoolFactory

        public GenericKeyedObjectPoolFactory​(KeyedPoolableObjectFactory<K,​V> factory,
                                     int maxActive,
                                     byte whenExhaustedAction,
                                     long maxWait,
                                     int maxIdle,
                                     boolean testOnBorrow,
                                     boolean testOnReturn)
        Create a new GenericKeyedObjectPoolFactory.
        Parameters:
        factory - the KeyedPoolableObjectFactory to used by created pools.
        maxActive - the maximum number of objects that can be borrowed from pools at one time.
        whenExhaustedAction - the action to take when the pool is exhausted.
        maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
        maxIdle - the maximum number of idle objects in the pools.
        testOnBorrow - whether to validate objects before they are returned by borrowObject.
        testOnReturn - whether to validate objects after they are returned to returnObject.
        See Also:
        GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, boolean, boolean)

      • GenericKeyedObjectPoolFactory

        public GenericKeyedObjectPoolFactory​(KeyedPoolableObjectFactory<K,​V> factory,
                                     int maxActive,
                                     byte whenExhaustedAction,
                                     long maxWait,
                                     int maxIdle,
                                     boolean testOnBorrow,
                                     boolean testOnReturn,
                                     long timeBetweenEvictionRunsMillis,
                                     int numTestsPerEvictionRun,
                                     long minEvictableIdleTimeMillis,
                                     boolean testWhileIdle)
        Create a new GenericKeyedObjectPoolFactory.
        Parameters:
        factory - the KeyedPoolableObjectFactory to used by created pools.
        maxActive - the maximum number of objects that can be borrowed from pools at one time.
        whenExhaustedAction - the action to take when the pool is exhausted.
        maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
        maxIdle - the maximum number of idle objects in the pools.
        testOnBorrow - whether to validate objects before they are returned by borrowObject.
        testOnReturn - whether to validate objects after they are returned to returnObject.
        timeBetweenEvictionRunsMillis - the number of milliseconds to sleep between examining idle objects for eviction.
        numTestsPerEvictionRun - the number of idle objects to examine per run of the evictor.
        minEvictableIdleTimeMillis - the minimum number of milliseconds an object can sit idle in the pool before it is eligible for eviction.
        testWhileIdle - whether to validate objects in the idle object eviction thread.
        See Also:
        GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, boolean, boolean, long, int, long, boolean)

      • GenericKeyedObjectPoolFactory

        public GenericKeyedObjectPoolFactory​(KeyedPoolableObjectFactory<K,​V> factory,
                                     int maxActive,
                                     byte whenExhaustedAction,
                                     long maxWait,
                                     int maxIdle,
                                     int maxTotal,
                                     boolean testOnBorrow,
                                     boolean testOnReturn,
                                     long timeBetweenEvictionRunsMillis,
                                     int numTestsPerEvictionRun,
                                     long minEvictableIdleTimeMillis,
                                     boolean testWhileIdle)
        Create a new GenericKeyedObjectPoolFactory.
        Parameters:
        factory - the KeyedPoolableObjectFactory to used by created pools.
        maxActive - the maximum number of objects that can be borrowed from pools at one time.
        whenExhaustedAction - the action to take when the pool is exhausted.
        maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
        maxIdle - the maximum number of idle objects in the pools.
        maxTotal - the maximum number of objects that can exists at one time.
        testOnBorrow - whether to validate objects before they are returned by borrowObject.
        testOnReturn - whether to validate objects after they are returned to returnObject.
        timeBetweenEvictionRunsMillis - the number of milliseconds to sleep between examining idle objects for eviction.
        numTestsPerEvictionRun - the number of idle objects to examine per run of the evictor.
        minEvictableIdleTimeMillis - the minimum number of milliseconds an object can sit idle in the pool before it is eligible for eviction.
        testWhileIdle - whether to validate objects in the idle object eviction thread.
        See Also:
        GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, int, boolean, boolean, long, int, long, boolean)

      • GenericKeyedObjectPoolFactory

        public GenericKeyedObjectPoolFactory​(KeyedPoolableObjectFactory<K,​V> factory,
                                     int maxActive,
                                     byte whenExhaustedAction,
                                     long maxWait,
                                     int maxIdle,
                                     int maxTotal,
                                     int minIdle,
                                     boolean testOnBorrow,
                                     boolean testOnReturn,
                                     long timeBetweenEvictionRunsMillis,
                                     int numTestsPerEvictionRun,
                                     long minEvictableIdleTimeMillis,
                                     boolean testWhileIdle)
        Create a new GenericKeyedObjectPoolFactory.
        Parameters:
        factory - the KeyedPoolableObjectFactory to used by created pools.
        maxActive - the maximum number of objects that can be borrowed from pools at one time.
        whenExhaustedAction - the action to take when the pool is exhausted.
        maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
        maxIdle - the maximum number of idle objects in the pools.
        maxTotal - the maximum number of objects that can exists at one time.
        minIdle - the minimum number of idle objects to have in the pool at any one time.
        testOnBorrow - whether to validate objects before they are returned by borrowObject.
        testOnReturn - whether to validate objects after they are returned to returnObject.
        timeBetweenEvictionRunsMillis - the number of milliseconds to sleep between examining idle objects for eviction.
        numTestsPerEvictionRun - the number of idle objects to examine per run of the evictor.
        minEvictableIdleTimeMillis - the minimum number of milliseconds an object can sit idle in the pool before it is eligible for eviction.
        testWhileIdle - whether to validate objects in the idle object eviction thread.
        Since:
        Pool 1.3
        See Also:
        GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, int, int, boolean, boolean, long, int, long, boolean)

      • GenericKeyedObjectPoolFactory

        public GenericKeyedObjectPoolFactory​(KeyedPoolableObjectFactory<K,​V> factory,
                                     int maxActive,
                                     byte whenExhaustedAction,
                                     long maxWait,
                                     int maxIdle,
                                     int maxTotal,
                                     int minIdle,
                                     boolean testOnBorrow,
                                     boolean testOnReturn,
                                     long timeBetweenEvictionRunsMillis,
                                     int numTestsPerEvictionRun,
                                     long minEvictableIdleTimeMillis,
                                     boolean testWhileIdle,
                                     boolean lifo)
        Create a new GenericKeyedObjectPoolFactory.
        Parameters:
        factory - the KeyedPoolableObjectFactory to used by created pools.
        maxActive - the maximum number of objects that can be borrowed from pools at one time.
        whenExhaustedAction - the action to take when the pool is exhausted.
        maxWait - the maximum amount of time to wait for an idle object when the pool is exhausted.
        maxIdle - the maximum number of idle objects in the pools.
        maxTotal - the maximum number of objects that can exists at one time.
        minIdle - the minimum number of idle objects to have in the pool at any one time.
        testOnBorrow - whether to validate objects before they are returned by borrowObject.
        testOnReturn - whether to validate objects after they are returned to returnObject.
        timeBetweenEvictionRunsMillis - the number of milliseconds to sleep between examining idle objects for eviction.
        numTestsPerEvictionRun - the number of idle objects to examine per run of the evictor.
        minEvictableIdleTimeMillis - the minimum number of milliseconds an object can sit idle in the pool before it is eligible for eviction.
        testWhileIdle - whether to validate objects in the idle object eviction thread.
        lifo - whether or not objects are returned in last-in-first-out order from the idle object pool.
        Since:
        Pool 1.4
        See Also:
        GenericKeyedObjectPool(KeyedPoolableObjectFactory, int, byte, long, int, int, int, boolean, boolean, long, int, long, boolean, boolean)

    • Method Detail

      • getMaxIdle

        public int getMaxIdle()
        Returns:
        the maxIdle setting for pools created by this factory.
        Since:
        1.5.5

      • getMaxActive

        public int getMaxActive()
        Returns:
        the maxActive setting for pools created by this factory.
        Since:
        1.5.5

      • getMaxTotal

        public int getMaxTotal()
        Returns:
        the maxTotal setting for pools created by this factory.
        Since:
        1.5.5

      • getMinIdle

        public int getMinIdle()
        Returns:
        the minIdle setting for pools created by this factory.
        Since:
        1.5.5

      • getMaxWait

        public long getMaxWait()
        Returns:
        the maxWait setting for pools created by this factory.
        Since:
        1.5.5

      • getWhenExhaustedAction

        public byte getWhenExhaustedAction()
        Returns:
        the whenExhaustedAction setting for pools created by this factory.
        Since:
        1.5.5

      • getTestOnBorrow

        public boolean getTestOnBorrow()
        Returns:
        the testOnBorrow setting for pools created by this factory.
        Since:
        1.5.5

      • getTestOnReturn

        public boolean getTestOnReturn()
        Returns:
        the testOnReturn setting for pools created by this factory.
        Since:
        1.5.5

      • getTestWhileIdle

        public boolean getTestWhileIdle()
        Returns:
        the testWhileIdle setting for pools created by this factory.
        Since:
        1.5.5

      • getTimeBetweenEvictionRunsMillis

        public long getTimeBetweenEvictionRunsMillis()
        Returns:
        the timeBetweenEvictionRunsMillis setting for pools created by this factory.
        Since:
        1.5.5

      • getNumTestsPerEvictionRun

        public int getNumTestsPerEvictionRun()
        Returns:
        the numTestsPerEvictionRun setting for pools created by this factory.
        Since:
        1.5.5

      • getMinEvictableIdleTimeMillis

        public long getMinEvictableIdleTimeMillis()
        Returns:
        the minEvictableIdleTimeMillis setting for pools created by this factory.
        Since:
        1.5.5

      • getLifo

        public boolean getLifo()
        Returns:
        the lifo setting for pools created by this factory.
        Since:
        1.5.5