com.atlassian.crowd.embedded.api
Interface ConnectionPoolProperties

All Known Implementing Classes:

DefaultConnectionPoolProperties, SystemConnectionPoolProperties

public interface ConnectionPoolProperties

The system-wide settings for LDAP connection pooling, as provided by JNDI. http://java.sun.com/products/jndi/tutorial/ldap/connect/pool.html

Method Summary

java.lang.String	getInitialSize()
java.lang.String	getMaximumSize()
java.lang.String	getPreferredSize()
java.lang.String	getSupportedAuthentication()
java.lang.String	getSupportedProtocol()
java.lang.String	getTimeoutInSec()
java.util.Map<java.lang.String,java.lang.String>	toPropertiesMap()

Method Detail

getInitialSize

java.lang.String getInitialSize()

Returns:

Number of connections to create when initially connecting to the pool.

getMaximumSize

java.lang.String getMaximumSize()

Returns:

Maximum number of connections to the LDAP server. Value of 0 means no maximum.

getPreferredSize

java.lang.String getPreferredSize()

Returns:

The preferred number of connections to be maintained in the pool.

getTimeoutInSec

java.lang.String getTimeoutInSec()

Returns:

Idle time in seconds for a connection before it is removed from the pool. Value of 0 means there is no timeout.

getSupportedAuthentication

java.lang.String getSupportedAuthentication()

Returns:

The specified authentication types will be pooled. Valid types are: none, simple, DIGEST-MD5.

getSupportedProtocol

java.lang.String getSupportedProtocol()

Returns:

The specified protocol types will be pooled. Valid types are: plain, ssl.

toPropertiesMap

java.util.Map<java.lang.String,java.lang.String> toPropertiesMap()

Returns:

The LDAP connection pool properties as a map.