Class PoolingContextSource

java.lang.Object
org.springframework.ldap.core.support.DelegatingBaseLdapPathContextSourceSupport
org.springframework.ldap.pool.factory.PoolingContextSource
All Implemented Interfaces:
org.springframework.beans.factory.DisposableBean, ContextSource, BaseLdapPathSource
Direct Known Subclasses:
MutablePoolingContextSource
public class PoolingContextSource extends DelegatingBaseLdapPathContextSourceSupport implements ContextSource, org.springframework.beans.factory.DisposableBean
A ContextSource implementation that wraps an object pool and another ContextSource. DirContexts are retrieved from the pool which maintains them.

Configuration:
Property Description Required Default
contextSource The ContextSource to get DirContexts from for adding to the pool. Yes null
dirContextValidator The DirContextValidator to use for validating DirContexts. Required if any of the test/validate options are enabled. No null
minIdle GenericKeyedObjectPool.setMinIdle(int) No 0
maxIdle GenericKeyedObjectPool.setMaxIdle(int) No 8
maxActive GenericKeyedObjectPool.setMaxActive(int) No 8
maxTotal GenericKeyedObjectPool.setMaxTotal(int) No -1
maxWait GenericKeyedObjectPool.setMaxWait(long) No -1L
whenExhaustedAction GenericKeyedObjectPool.setWhenExhaustedAction(byte) No GenericKeyedObjectPool.WHEN_EXHAUSTED_BLOCK
testOnBorrow GenericKeyedObjectPool.setTestOnBorrow(boolean) No false
testOnReturn GenericKeyedObjectPool.setTestOnReturn(boolean) No false
testWhileIdle GenericKeyedObjectPool.setTestWhileIdle(boolean) No false
timeBetweenEvictionRunsMillis GenericKeyedObjectPool.setTimeBetweenEvictionRunsMillis(long) No -1L
minEvictableIdleTimeMillis GenericKeyedObjectPool.setMinEvictableIdleTimeMillis(long) No 1000L * 60L * 30L
numTestsPerEvictionRun GenericKeyedObjectPool.setNumTestsPerEvictionRun(int) No 3

  • Field Details

    • logger

      protected final org.slf4j.Logger logger
      The logger for this class and sub-classes.

    • keyedObjectPool

      protected final org.apache.commons.pool.impl.GenericKeyedObjectPool keyedObjectPool

  • Constructor Details

    • PoolingContextSource

      @Deprecated public PoolingContextSource()
      Deprecated.
      Please provide the ContextSource in the constructor
      Creates a new pooling context source, setting up the DirContext object factory and generic keyed object pool.

    • PoolingContextSource

      public PoolingContextSource(ContextSource contextSource)
      Creates a new pooling context source, setting up the DirContext object factory and generic keyed object pool.
      Since:
      4.1

  • Method Details

    • getMaxActive

      public int getMaxActive()
      Get the maximum number of active objects that can be allocated at one time.
      See Also:
      • GenericKeyedObjectPool.getMaxActive()

    • getMaxIdle

      public int getMaxIdle()
      Get the maximum number of idle objects to keep in the pool.
      See Also:
      • GenericKeyedObjectPool.getMaxIdle()

    • getMaxTotal

      public int getMaxTotal()
      Get the overall maximum number of objects that can exist in the pool.
      See Also:
      • GenericKeyedObjectPool.getMaxTotal()

    • getMaxWait

      public long getMaxWait()
      Get the maximum time to wait for an object from the pool when the pool is exhausted.
      See Also:
      • GenericKeyedObjectPool.getMaxWait()

    • getMinEvictableIdleTimeMillis

      public long getMinEvictableIdleTimeMillis()
      Get the minimum time an object may sit idle in the pool before being eligible for eviction.
      See Also:
      • GenericKeyedObjectPool.getMinEvictableIdleTimeMillis()

    • getMinIdle

      public int getMinIdle()
      Get the minimum number of idle objects to keep in the pool.
      See Also:
      • GenericKeyedObjectPool.getMinIdle()

    • getNumActive

      public int getNumActive()
      Get the number of active objects currently allocated from the pool.
      See Also:
      • GenericKeyedObjectPool.getNumActive()

    • getNumIdle

      public int getNumIdle()
      Get the number of idle objects currently in the pool.
      See Also:
      • GenericKeyedObjectPool.getNumIdle()

    • getNumTestsPerEvictionRun

      public int getNumTestsPerEvictionRun()
      Get the number of objects to examine during each eviction run.
      See Also:
      • GenericKeyedObjectPool.getNumTestsPerEvictionRun()

    • getTestOnBorrow

      public boolean getTestOnBorrow()
      Get whether objects are validated before being borrowed from the pool.
      See Also:
      • GenericKeyedObjectPool.getTestOnBorrow()

    • getTestOnReturn

      public boolean getTestOnReturn()
      Get whether objects are validated before being returned to the pool.
      See Also:
      • GenericKeyedObjectPool.getTestOnReturn()

    • getTestWhileIdle

      public boolean getTestWhileIdle()
      Get whether idle objects are validated by the idle object evictor.
      See Also:
      • GenericKeyedObjectPool.getTestWhileIdle()

    • getTimeBetweenEvictionRunsMillis

      public long getTimeBetweenEvictionRunsMillis()
      Get the time between runs of the idle object evictor.
      See Also:
      • GenericKeyedObjectPool.getTimeBetweenEvictionRunsMillis()

    • getWhenExhaustedAction

      public byte getWhenExhaustedAction()
      Get the action to take when the pool is exhausted.
      See Also:
      • GenericKeyedObjectPool.getWhenExhaustedAction()

    • setMaxActive

      public void setMaxActive(int maxActive)
      Set the maximum number of active objects that can be allocated at one time.
      See Also:
      • GenericKeyedObjectPool.setMaxActive(int)

    • setMaxIdle

      public void setMaxIdle(int maxIdle)
      Set the maximum number of idle objects to keep in the pool.
      See Also:
      • GenericKeyedObjectPool.setMaxIdle(int)

    • setMaxTotal

      public void setMaxTotal(int maxTotal)
      Set the overall maximum number of objects that can exist in the pool.
      See Also:
      • GenericKeyedObjectPool.setMaxTotal(int)

    • setMaxWait

      public void setMaxWait(long maxWait)
      Set the maximum time to wait for an object from the pool when the pool is exhausted.
      See Also:
      • GenericKeyedObjectPool.setMaxWait(long)

    • setMinEvictableIdleTimeMillis

      public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
      Set the minimum time an object may sit idle in the pool before being eligible for eviction.
      See Also:
      • GenericKeyedObjectPool.setMinEvictableIdleTimeMillis(long)

    • setMinIdle

      public void setMinIdle(int poolSize)
      Set the minimum number of idle objects to keep in the pool.
      See Also:
      • GenericKeyedObjectPool.setMinIdle(int)

    • setNumTestsPerEvictionRun

      public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
      Set the number of objects to examine during each eviction run.
      See Also:
      • GenericKeyedObjectPool.setNumTestsPerEvictionRun(int)

    • setTestOnBorrow

      public void setTestOnBorrow(boolean testOnBorrow)
      Set whether objects are validated before being borrowed from the pool.
      See Also:
      • GenericKeyedObjectPool.setTestOnBorrow(boolean)

    • setTestOnReturn

      public void setTestOnReturn(boolean testOnReturn)
      Set whether objects are validated before being returned to the pool.
      See Also:
      • GenericKeyedObjectPool.setTestOnReturn(boolean)

    • setTestWhileIdle

      public void setTestWhileIdle(boolean testWhileIdle)
      Set whether idle objects are validated by the idle object evictor.
      See Also:
      • GenericKeyedObjectPool.setTestWhileIdle(boolean)

    • setTimeBetweenEvictionRunsMillis

      public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
      Set the time between runs of the idle object evictor.
      See Also:
      • GenericKeyedObjectPool.setTimeBetweenEvictionRunsMillis(long)

    • setWhenExhaustedAction

      public void setWhenExhaustedAction(byte whenExhaustedAction)
      Set the action to take when the pool is exhausted.
      See Also:
      • GenericKeyedObjectPool.setWhenExhaustedAction(byte)

    • getContextSource

      public ContextSource getContextSource()
      Get the contextSource.
      Returns:
      the contextSource

    • getDirContextValidator

      public DirContextValidator getDirContextValidator()
      Get the dirContextValidator.
      Returns:
      the dirContextValidator

    • setContextSource

      @Deprecated public void setContextSource(ContextSource contextSource)
      Deprecated.
      Please provide the ContextSource in the constructor
      Set the contextSource. Required.
      Parameters:
      contextSource - the contextSource to set Required

    • setDirContextValidator

      public void setDirContextValidator(DirContextValidator dirContextValidator)
      Set the dirContextValidator. Required.
      Parameters:
      dirContextValidator - the dirContextValidator to set Required

    • setNonTransientExceptions

      public void setNonTransientExceptions(Collection<Class<? extends Throwable>> nonTransientExceptions)
      Configure the exception classes that are to be interpreted as no-transient with regards to eager context invalidation. If one of the configured exceptions (or subclasses of them) is thrown by any method on a pooled DirContext, that instance will immediately be marked as invalid without any additional testing (i.e. testOnReturn). This allows for more efficient management of dead connections. Default is CommunicationException.
      Parameters:
      nonTransientExceptions - the exception classes that should be interpreted as non-transient with regards to eager invalidation.
      Since:
      2.0

    • destroy

      public void destroy() throws Exception
      Specified by:
      destroy in interface org.springframework.beans.factory.DisposableBean
      Throws:
      Exception

    • getTarget

      protected ContextSource getTarget()
      Description copied from class: DelegatingBaseLdapPathContextSourceSupport
      Get the target ContextSource.
      Specified by:
      getTarget in class DelegatingBaseLdapPathContextSourceSupport
      Returns:
      the target ContextSource.

    • getReadOnlyContext

      public DirContext getReadOnlyContext()
      Description copied from interface: ContextSource
      Gets a read-only DirContext. The returned DirContext must be possible to perform read-only operations on.
      Specified by:
      getReadOnlyContext in interface ContextSource
      Returns:
      A DirContext instance, never null.

    • getReadWriteContext

      public DirContext getReadWriteContext()
      Description copied from interface: ContextSource
      Gets a read-write DirContext instance.
      Specified by:
      getReadWriteContext in interface ContextSource
      Returns:
      A DirContext instance, never null.

    • getContext

      protected DirContext getContext(DirContextType dirContextType)
      Gets a DirContext of the specified type from the keyed object pool.
      Parameters:
      dirContextType - The type of context to return.
      Returns:
      A wrapped DirContext of the specified type.
      Throws:
      org.springframework.dao.DataAccessResourceFailureException - If retrieving the object from the pool throws an exception

    • getContext

      public DirContext getContext(String principal, String credentials)
      Description copied from interface: ContextSource
      Gets a DirContext instance authenticated using the supplied principal and credentials. Typically to be used for plain authentication purposes. Note that this method will never make use of native Java LDAP pooling, even though this instance is configured to do so. This is to force password changes in the target directory to take effect as soon as possible.
      Specified by:
      getContext in interface ContextSource
      Parameters:
      principal - The principal (typically a distinguished name of a user in the LDAP tree) to use for authentication.
      credentials - The credentials to use for authentication.
      Returns:
      an authenticated DirContext instance, never null.