org.aselect.authspserver.authsp.ldap
Interface ILDAPProtocolHandler

All Known Implementing Classes:
AbstractLDAPProtocolHandler, LDAPSimpleProtocolHandler, LDAPSSLProtocolHandler

public interface ILDAPProtocolHandler

Interface for a LDAP protocol handler.

Description:
Specifies methods which LDAP protocol handlers should implement.

Concurrency issues:
-

Author:
Alfa & Ariss

Method Summary
 java.lang.String authenticate(java.lang.String sPassword)
          Authenticate a user with LDAP.
 boolean init(java.lang.String sLDAPSUrl, java.lang.String sDriver, java.lang.String sBaseDn, java.lang.String sUserDn, boolean bFullUid, java.lang.String sUid, java.lang.String sPrincipalDn, java.lang.String sPrincipalPwd, AuthSPSystemLogger systemLogger)
          Initialize the ILDAPProtocolHandler.
 

Method Detail

init

boolean init(java.lang.String sLDAPSUrl,
             java.lang.String sDriver,
             java.lang.String sBaseDn,
             java.lang.String sUserDn,
             boolean bFullUid,
             java.lang.String sUid,
             java.lang.String sPrincipalDn,
             java.lang.String sPrincipalPwd,
             AuthSPSystemLogger systemLogger)
Initialize the ILDAPProtocolHandler.

Description:
The implementation of this method should perform all one-time functionality of the ILDAPProtocolHandler. e.g. Retrieving handles to important managers and reading basic configuration.

Concurrency issues:
-

Preconditions:
-

Postconditions:
The ILDAPProtocolHandler is ready to authenticate.

Parameters:
sLDAPSUrl - The URl to the LDAP back-end.
sDriver - The JNDI driver.
sBaseDn - The Base DN.
sUserDn - The user DN.
bFullUid - True if the full uid must be sent to the backend
sUid - The LDAP user name.
sPrincipalDn - the principal DN.
sPrincipalPwd - The principal password.
systemLogger - The logger for system entries.
Returns:
true if initialisation is successfull, otherwise false.

authenticate

java.lang.String authenticate(java.lang.String sPassword)
Authenticate a user with LDAP.

Description:
Authenticate an user with a LDAP back-end.

Concurrency issues:
-

Preconditions:
The ILDAPProtocolHandler must be initialised.

Postconditions:
-

Parameters:
sPassword - the password to validate.
Returns:
The authentication result code (as specified in Errors).


Copyright © 2008 SURFnet BV. All Rights Reserved.