Interface LdapPool<T extends BaseLdap>

  • Type Parameters:
    T - type of ldap object
    All Known Implementing Classes:
    AbstractLdapPool, BlockingLdapPool, SharedLdapPool, SoftLimitLdapPool

    public interface LdapPool<T extends BaseLdap>
    LdapPool provides an interface for pooling ldap objects.
    Version:
    $Revision: 1330 $ $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $
    Author:
    Middleware Services
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int activeCount()
      Returns the number of ldap objects in use.
      int availableCount()
      Returns the number of ldap objects available for use.
      void checkIn​(T t)
      Returns an ldap object to the pool.
      T checkOut()
      Returns an ldap object from the pool.
      void close()
      Empty this pool, closing all connections, and freeing any resources.
      LdapPoolConfig getLdapPoolConfig()
      Returns the configuration for this pool.
      void initialize()
      Initialize this pool for use.
      void prune()
      Attempts to reduce the size of the pool back to it's configured minimum.
      void setPoolTimer​(java.util.Timer t)
      Sets the pool to use an existing timer.
      void validate()
      Attempts to validate all objects in the pool.
    • Method Detail

      • getLdapPoolConfig

        LdapPoolConfig getLdapPoolConfig()
        Returns the configuration for this pool.
        Returns:
        ldap pool config
      • setPoolTimer

        void setPoolTimer​(java.util.Timer t)
        Sets the pool to use an existing timer. Pool will use an internal timer if none is provided. Must be called before initialize().
        Parameters:
        t - timer used to schedule pool tasks
      • initialize

        void initialize()
        Initialize this pool for use.
      • close

        void close()
        Empty this pool, closing all connections, and freeing any resources.
      • checkIn

        void checkIn​(T t)
        Returns an ldap object to the pool.
        Parameters:
        t - ldap object
      • availableCount

        int availableCount()
        Returns the number of ldap objects available for use.
        Returns:
        count
      • activeCount

        int activeCount()
        Returns the number of ldap objects in use.
        Returns:
        count