PoolConfig (Ldaptive 1.2.4 API)

java.lang.Object
- org.ldaptive.AbstractConfig
- - org.ldaptive.pool.PoolConfig

```
public class PoolConfig
extends AbstractConfig
```
Contains all the configuration data that the pooling implementations need to control the pool.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_POOL_SIZE` Default max pool size, value is 10.
`static int`	`DEFAULT_MIN_POOL_SIZE` Default min pool size, value is 3.
`static boolean`	`DEFAULT_VALIDATE_ON_CHECKIN` Default validate on check in, value is false.
`static boolean`	`DEFAULT_VALIDATE_ON_CHECKOUT` Default validate on check out, value is false.
`static Duration`	`DEFAULT_VALIDATE_PERIOD` Default validate period, value is 30 minutes.
`static boolean`	`DEFAULT_VALIDATE_PERIODICALLY` Default validate periodically, value is false.
`static Duration`	`DEFAULT_VALIDATE_TIMEOUT` Default per connection validate timeout, value is 5 seconds.
`private int`	`maxPoolSize` Maximum pool size.
`private int`	`minPoolSize` Minimum pool size.
`private boolean`	`validateOnCheckIn` Whether the ldap object should be validated when returned to the pool.
`private boolean`	`validateOnCheckOut` Whether the ldap object should be validated when given from the pool.
`private Duration`	`validatePeriod` Time that the pool validation should repeat.
`private boolean`	`validatePeriodically` Whether the pool should be validated periodically.
`private Duration`	`validateTimeout` Maximum length of time a connection validation should block.

Fields inherited from class org.ldaptive.AbstractConfig
logger

Constructor Summary

Constructors
Constructor and Description

PoolConfig()

Constructors
Constructor and Description
`PoolConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getMaxPoolSize()` Returns the max pool size.
`int`	`getMinPoolSize()` Returns the min pool size.
`Duration`	`getValidatePeriod()` Returns the validate period.
`Duration`	`getValidateTimeout()` Returns the timeout imposed when validating a single connection.
`boolean`	`isValidateOnCheckIn()` Returns the validate on check in flag.
`boolean`	`isValidateOnCheckOut()` Returns the validate on check out flag.
`boolean`	`isValidatePeriodically()` Returns the validate periodically flag.
`void`	`setMaxPoolSize(int size)` Sets the max pool size.
`void`	`setMinPoolSize(int size)` Sets the min pool size.
`void`	`setValidateOnCheckIn(boolean b)` Sets the validate on check in flag.
`void`	`setValidateOnCheckOut(boolean b)` Sets the validate on check out flag.
`void`	`setValidatePeriod(Duration time)` Sets the period for which the pool will be validated.
`void`	`setValidatePeriodically(boolean b)` Sets the validate periodically flag.
`void`	`setValidateTimeout(Duration time)` Sets the timeout imposed when validating a single connection.
`String`	`toString()`

Methods inherited from class org.ldaptive.AbstractConfig
checkImmutable, checkStringInput, makeImmutable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - 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_PERIOD
```
public static final Duration DEFAULT_VALIDATE_PERIOD
```
    Default validate period, value is 30 minutes.
  - DEFAULT_VALIDATE_TIMEOUT
```
public static final Duration DEFAULT_VALIDATE_TIMEOUT
```
    Default per connection validate timeout, value is 5 seconds.
  - minPoolSize
```
private int minPoolSize
```
    Minimum pool size.
  - maxPoolSize
```
private int maxPoolSize
```
    Maximum pool size.
  - validateOnCheckIn
```
private boolean validateOnCheckIn
```
    Whether the ldap object should be validated when returned to the pool.
  - validateOnCheckOut
```
private boolean validateOnCheckOut
```
    Whether the ldap object should be validated when given from the pool.
  - validatePeriodically
```
private boolean validatePeriodically
```
    Whether the pool should be validated periodically.
  - validatePeriod
```
private Duration validatePeriod
```
    Time that the pool validation should repeat.
  - validateTimeout
```
private Duration validateTimeout
```
    Maximum length of time a connection validation should block.
- Constructor Detail
  - PoolConfig
```
public PoolConfig()
```
- Method Detail
  - getMinPoolSize
```
public int getMinPoolSize()
```
    Returns the min pool size. Default value is DEFAULT_MIN_POOL_SIZE. This value represents the size of the pool after a prune has occurred.
    
    Returns:
    
    min pool size
  - setMinPoolSize
```
public void setMinPoolSize(int size)
```
    Sets the min pool size.
    
    Parameters:
    
    size - min pool size
  - getMaxPoolSize
```
public int getMaxPoolSize()
```
    Returns the max pool size. Default value is DEFAULT_MAX_POOL_SIZE. This value may or may not be strictly enforced depending on the pooling implementation.
    
    Returns:
    
    max pool size
  - setMaxPoolSize
```
public void setMaxPoolSize(int size)
```
    Sets the max pool size.
    
    Parameters:
    
    size - max pool size
  - isValidateOnCheckIn
```
public boolean isValidateOnCheckIn()
```
    Returns the validate on check in flag. Default value is DEFAULT_VALIDATE_ON_CHECKIN.
    
    Returns:
    
    validate on check in
  - setValidateOnCheckIn
```
public void setValidateOnCheckIn(boolean b)
```
    Sets the validate on check in flag.
    
    Parameters:
    
    b - validate on check in
  - isValidateOnCheckOut
```
public boolean isValidateOnCheckOut()
```
    Returns the validate on check out flag. Default value is DEFAULT_VALIDATE_ON_CHECKOUT.
    
    Returns:
    
    validate on check in
  - setValidateOnCheckOut
```
public void setValidateOnCheckOut(boolean b)
```
    Sets the validate on check out flag.
    
    Parameters:
    
    b - validate on check out
  - isValidatePeriodically
```
public boolean isValidatePeriodically()
```
    Returns the validate periodically flag. Default value is DEFAULT_VALIDATE_PERIODICALLY.
    
    Returns:
    
    validate periodically
  - setValidatePeriodically
```
public void setValidatePeriodically(boolean b)
```
    Sets the validate periodically flag.
    
    Parameters:
    
    b - validate periodically
  - getValidatePeriod
```
public Duration getValidatePeriod()
```
    Returns the validate period. Default value is DEFAULT_VALIDATE_PERIOD.
    
    Returns:
    
    validate period
  - setValidatePeriod
```
public void setValidatePeriod(Duration time)
```
    Sets the period for which the pool will be validated.
    
    Parameters:
    
    time - in seconds
  - getValidateTimeout
```
public Duration getValidateTimeout()
```
    Returns the timeout imposed when validating a single connection.
    
    Returns:
    
    validate timeout
  - setValidateTimeout
```
public void setValidateTimeout(Duration time)
```
    Sets the timeout imposed when validating a single connection.
    
    Parameters:
    
    time - for a connection validation
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PoolConfig

Field Summary

Fields inherited from class org.ldaptive.AbstractConfig

Constructor Summary

Method Summary

Methods inherited from class org.ldaptive.AbstractConfig

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MIN_POOL_SIZE

DEFAULT_MAX_POOL_SIZE

DEFAULT_VALIDATE_ON_CHECKIN

DEFAULT_VALIDATE_ON_CHECKOUT

DEFAULT_VALIDATE_PERIODICALLY

DEFAULT_VALIDATE_PERIOD

DEFAULT_VALIDATE_TIMEOUT

minPoolSize

maxPoolSize

validateOnCheckIn

validateOnCheckOut

validatePeriodically

validatePeriod

validateTimeout

Constructor Detail

PoolConfig

Method Detail

getMinPoolSize

setMinPoolSize

getMaxPoolSize

setMaxPoolSize

isValidateOnCheckIn

setValidateOnCheckIn

isValidateOnCheckOut

setValidateOnCheckOut

isValidatePeriodically

setValidatePeriodically

getValidatePeriod

setValidatePeriod

getValidateTimeout

setValidateTimeout

toString