The Shibboleth IdP V3 software has reached its End of Life and is no longer supported. This documentation is available for historical purposes only. See the IDP4 wiki space for current documentation on the supported version.

ConnectionPool

The <ConnectionPool> element describes how the LDAP connection is to be pooled.

Schema Name and Location

This element is defined by the urn:mace:shibboleth:2.0:resolver schema, which is located at http://shibboleth.net/schema/idp/shibboleth-attribute-resolver.xsd.

Example

<ConnectionPool 
            minPoolSize="5"
            maxPoolSize="10"
            blockWaitTime="PT5S"
            expirationTime="PT10M"
            validatePeriodically="true"
            validateTimerPeriod="PT15M"
            validateDN="dc=example,dc=org"
            validateFilter="(ou=people)"
            failFastInitialize="false" />

Attributes

The following attributes may be specified:

NameTypeDefaultDescription
minPoolSize
Integer0Minimum number of connections to maintain
maxPoolSize
Integer3Maximum number of connections to maintain
blockWhenEmpty
BooleantrueControls whether the pool implementation blocks when the pool is maxed out, or temporarily exceeds its limits
blockWaitTime
Duration0Time to wait for a connection before giving up, 0 means indefinitely
validatePeriodically
BooleanfalseWhether to validate pool connections in the background
validateTimerPeriod
DurationPT30MTime between pool validation checks
validateDN
String Base DN of pool validation search
validateFilter
String(objectClass=*)The search filter to run during pool validation
expirationTime
DurationPT10MIdle time before connections are destroyed. This must be more than 2 seconds.
failFastInitialize
BooleantrueWhether failure to initialize the pool should be reported at startup time

Child Elements

No child elements are defined.