Package edu.vt.middleware.ldap.pool

Class LdapPoolConfig

  • All Implemented Interfaces:
    PropertyConfig
    public class LdapPoolConfig
extends AbstractPropertyConfig
    LdapPoolConfig contains all the configuration data that the pooling implementations need to control the pool.
    Version:
    $Revision: 1330 $ $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $
    Author:
    Middleware Services

    • Field Detail

      • PROPERTIES_DOMAIN

        public static final java.lang.String PROPERTIES_DOMAIN
        Domain to look for ldap properties in, value is "edu.vt.middleware.ldap.pool.".
        See Also:
        Constant Field Values

      • DEFAULT_MIN_POOL_SIZE

        public static final int DEFAULT_MIN_POOL_SIZE
        Default min pool size, value is 3.
        See Also:
        Constant Field Values

      • DEFAULT_MAX_POOL_SIZE

        public static final int DEFAULT_MAX_POOL_SIZE
        Default max pool size, value is 10.
        See Also:
        Constant Field Values

      • DEFAULT_VALIDATE_ON_CHECKIN

        public static final boolean DEFAULT_VALIDATE_ON_CHECKIN
        Default validate on check in, value is false.
        See Also:
        Constant Field Values

      • DEFAULT_VALIDATE_ON_CHECKOUT

        public static final boolean DEFAULT_VALIDATE_ON_CHECKOUT
        Default validate on check out, value is false.
        See Also:
        Constant Field Values

      • DEFAULT_VALIDATE_PERIODICALLY

        public static final boolean DEFAULT_VALIDATE_PERIODICALLY
        Default validate periodically, value is false.
        See Also:
        Constant Field Values

      • DEFAULT_VALIDATE_TIMER_PERIOD

        public static final long DEFAULT_VALIDATE_TIMER_PERIOD
        Default validate timer period, value is 1800000L.
        See Also:
        Constant Field Values

      • DEFAULT_PRUNE_TIMER_PERIOD

        public static final long DEFAULT_PRUNE_TIMER_PERIOD
        Default prune timer period, value is 300000L.
        See Also:
        Constant Field Values

      • DEFAULT_EXPIRATION_TIME

        public static final long DEFAULT_EXPIRATION_TIME
        Default expiration time, value is 600000L.
        See Also:
        Constant Field Values

    • Constructor Detail

      • LdapPoolConfig

        public LdapPoolConfig()
        Default constructor.

    • Method Detail

      • getMinPoolSize

        public int getMinPoolSize()
        This returns the min pool size for the LdapPoolConfig. Default value is DEFAULT_MIN_POOL_SIZE. This value represents the size of the pool after the prune timer has run.
        Returns:
        int - min pool size

      • getMaxPoolSize

        public int getMaxPoolSize()
        This returns the max pool size for the LdapPoolConfig. Default value is DEFAULT_MAX_POOL_SIZE. This value may or may not be strictly enforced depending on the pooling implementation.
        Returns:
        int - max pool size

      • isValidateOnCheckIn

        public boolean isValidateOnCheckIn()
        This returns the validate on check in flag for the LdapPoolConfig. Default value is DEFAULT_VALIDATE_ON_CHECKIN.
        Returns:
        boolean - validate on check in

      • isValidateOnCheckOut

        public boolean isValidateOnCheckOut()
        This returns the validate on check out flag for the LdapPoolConfig. Default value is DEFAULT_VALIDATE_ON_CHECKOUT.
        Returns:
        boolean - validate on check in

      • isValidatePeriodically

        public boolean isValidatePeriodically()
        This returns the validate periodically flag for the LdapPoolConfig. Default value is DEFAULT_VALIDATE_PERIODICALLY.
        Returns:
        boolean - validate periodically

      • getPruneTimerPeriod

        public long getPruneTimerPeriod()
        This returns the prune timer period for the LdapPoolConfig. Default value is DEFAULT_PRUNE_TIMER_PERIOD. The prune timer attempts to execute LdapPool.prune().
        Returns:
        long - prune timer period in milliseconds

      • getValidateTimerPeriod

        public long getValidateTimerPeriod()
        This returns the validate timer period for the LdapPoolConfig. Default value is DEFAULT_VALIDATE_TIMER_PERIOD. The validate timer attempts to execute LdapPool.validate().
        Returns:
        long - validate timer period in milliseconds

      • getExpirationTime

        public long getExpirationTime()
        This returns the expiration time for the LdapPoolConfig. Default value is DEFAULT_EXPIRATION_TIME. The expiration time represents the max time an ldap object should be available before it is considered stale. This value does not apply to objects in the pool if the pool has only a minimum number of objects available.
        Returns:
        long - expiration time in milliseconds

      • setMinPoolSize

        public void setMinPoolSize​(int size)
        This sets the min pool size for the LdapPoolConfig.
        Parameters:
        size - int

      • setMaxPoolSize

        public void setMaxPoolSize​(int size)
        This sets the max pool size for the LdapPoolConfig.
        Parameters:
        size - int

      • setValidateOnCheckIn

        public void setValidateOnCheckIn​(boolean b)
        This sets the validate on check in flag for the LdapPoolConfig.
        Parameters:
        b - boolean

      • setValidateOnCheckOut

        public void setValidateOnCheckOut​(boolean b)
        This sets the validate on check out flag for the LdapPoolConfig.
        Parameters:
        b - boolean

      • setValidatePeriodically

        public void setValidatePeriodically​(boolean b)
        This sets the validate periodically flag for the LdapPoolConfig.
        Parameters:
        b - boolean

      • setPruneTimerPeriod

        public void setPruneTimerPeriod​(long time)
        Sets the period for which the prune pool timer will run.
        Parameters:
        time - in milliseconds

      • setValidateTimerPeriod

        public void setValidateTimerPeriod​(long time)
        Sets the period for which the validate pool timer will run.
        Parameters:
        time - in milliseconds

      • setExpirationTime

        public void setExpirationTime​(long time)
        Sets the time that an ldap object should be considered stale and ready for removal from the pool.
        Parameters:
        time - in milliseconds

      • setEnvironmentProperties

        public void setEnvironmentProperties​(java.lang.String name,
                                     java.lang.String value)
        This adds environment properties to this object. If name or value is null, then this method does nothing.
        Specified by:
        setEnvironmentProperties in interface PropertyConfig
        Specified by:
        setEnvironmentProperties in class AbstractPropertyConfig
        Parameters:
        name - String property name
        value - String property value

      • createFromProperties

        public static LdapPoolConfig createFromProperties​(java.io.InputStream is)
        Create an instance of this class initialized with properties from the input stream. If the input stream is null, load properties from the default properties file.
        Parameters:
        is - to load properties from
        Returns:
        LdapPoolConfig initialized ldap pool config