Package org.forgerock.openam.sm
Interface ConnectionConfig
-
- All Known Implementing Classes:
ExternalLdapConfig,ServerGroupConfiguration
public interface ConnectionConfigRepresents the details required to establish a Connection to an LDAP server. This configuration is expected to be used withLDAPUtils
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetBindDN()The Bind DN to use for the connection.char[]getBindPassword()The Bind password to use for the connection.intgetLdapHeartbeat()The timeout in seconds to use for the heartbeat detection in the connection.Set<LDAPURL>getLDAPURLs()The LDAPURLs that are to be used for the connection.intgetMaxConnections()The maximum number of connections that may be established to the server by the connection pool which corresponds to this configuration.booleanisAffinityEnabled()Tells whether affinity has been enabled for this connection.
-
-
-
Method Detail
-
getLDAPURLs
Set<LDAPURL> getLDAPURLs()
The LDAPURLs that are to be used for the connection. This may be more than one to allow for automatic fail-over connections.- Returns:
- Non null collection with at least one entry present.
-
getBindDN
String getBindDN()
The Bind DN to use for the connection.- Returns:
- Non null.
-
getBindPassword
char[] getBindPassword()
The Bind password to use for the connection.- Returns:
- Non null.
-
getMaxConnections
int getMaxConnections()
The maximum number of connections that may be established to the server by the connection pool which corresponds to this configuration.- Returns:
- A positive number.
-
getLdapHeartbeat
int getLdapHeartbeat()
The timeout in seconds to use for the heartbeat detection in the connection.- Returns:
- -1 if not used, or a positive number.
-
isAffinityEnabled
boolean isAffinityEnabled()
Tells whether affinity has been enabled for this connection.- Returns:
trueif affinity is enabled for this connection.
-
-