org.jboss.as.domain.management.connections.ldap

Interface LdapConnectionManager

All Known Implementing Classes:

LdapConnectionManagerService

public interface LdapConnectionManager

Interface to be implemented by connection managers responsible for returning connections to a LDAP server.

Author:

Darran Lofthouse

Method Summary

Modifier and Type	Method and Description
LdapConnectionManager	findForReferral(URI referralUri) Identify which LdapConnectionManager can establish connections needed for a referral.
DirContext	getConnection() Obtain a connection to LDAP using the configuration defined.
void	verifyIdentity(String bindDn, String bindCredential) Verify that the specified bindDn and bindCredential can be used to establish a connection to LDAP.

Method Detail

getConnection

DirContext getConnection()
                  throws NamingException

Obtain a connection to LDAP using the configuration defined.

Returns:

A DirContext for access to the LDAP server.

Throws:

NamingException - If an error occurs connecting to LDAP.

verifyIdentity

void verifyIdentity(String bindDn,
                    String bindCredential)
             throws NamingException

Verify that the specified bindDn and bindCredential can be used to establish a connection to LDAP. If no NamingException is thrown then the establishment of the connection was successful.

Parameters:

bindDn - - The bind distinguished name for the connection.

bindCredential - - The bind credential for the connection.

Throws:

NamingException - - If there is any error establishing the connection.

findForReferral

LdapConnectionManager findForReferral(URI referralUri)

Identify which LdapConnectionManager can establish connections needed for a referral.

Parameters:

referralUri - - The URI of the referral.

Returns:

The LdapConnectionManager that can handle the referral or null if none is found.