org.apache.directory.server.ldap.handlers.sasl

Interface MechanismHandler

All Known Implementing Classes:

AbstractMechanismHandler, CramMd5MechanismHandler, DigestMd5MechanismHandler, GssapiMechanismHandler, NtlmMechanismHandler, PlainMechanismHandler, SimpleMechanismHandler

public interface MechanismHandler

An interface for retrieving a SaslServer for a session.

Author:

Apache Directory Project

See Also:

SaslServer

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup(LdapSession ldapSession) Clean the Sasl properties when the use has been authenticated
SaslServer	handleMechanism(LdapSession session, org.apache.directory.api.ldap.model.message.BindRequest bindRequest) Implementors will use the session and message to determine what kind of SaslServer to create and what initialization parameters it will require.
void	init(LdapSession ldapSession) Initialize the saslProperties with some mechanism's specific data

Method Detail

handleMechanism

SaslServer handleMechanism(LdapSession session,
                         org.apache.directory.api.ldap.model.message.BindRequest bindRequest)
                           throws Exception

Implementors will use the session and message to determine what kind of SaslServer to create and what initialization parameters it will require.

Parameters:

session -

bindRequest -

Returns:

The SaslServer to use for the duration of the bound session.

Throws:

Exception

init

void init(LdapSession ldapSession)

Initialize the saslProperties with some mechanism's specific data

Parameters:

ldapSession - the Ldapsession instance

cleanup

void cleanup(LdapSession ldapSession)

Clean the Sasl properties when the use has been authenticated

Parameters:

ldapSession - the Ldapsession instance