org.apache.directory.server.ldap.handlers

Class LdapRequestHandler<T extends org.apache.directory.api.ldap.model.message.Request>

java.lang.Object

org.apache.directory.server.ldap.handlers.LdapRequestHandler<T>

All Implemented Interfaces:

org.apache.mina.handler.demux.MessageHandler<T>

Direct Known Subclasses:

AbandonRequestHandler, AddRequestHandler, BindRequestHandler, CompareRequestHandler, DeleteRequestHandler, ExtendedRequestHandler, ModifyDnRequestHandler, ModifyRequestHandler, SearchRequestHandler, UnbindRequestHandler

public abstract class LdapRequestHandler<T extends org.apache.directory.api.ldap.model.message.Request>
extends Object
implements org.apache.mina.handler.demux.MessageHandler<T>

A base class for all LDAP request handlers.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected LdapServer	ldapServer The reference on the Ldap server instance
protected static org.slf4j.Logger	LOG The logger for this class

Fields inherited from interface org.apache.mina.handler.demux.MessageHandler

NOOP

Constructor Summary

Constructors

Constructor and Description
LdapRequestHandler()

Method Summary

Modifier and Type	Method and Description
protected org.apache.directory.api.ldap.codec.api.LdapApiService	getLdapApiService()
LdapServer	getLdapServer()
abstract void	handle(LdapSession session, T message) Handle a Ldap message associated with a session
void	handleException(LdapSession session, org.apache.directory.api.ldap.model.message.ResultResponseRequest request, org.apache.directory.api.ldap.model.message.ResultResponse response, Exception e) Handles processing with referrals without ManageDsaIT decorator.
void	handleMessage(org.apache.mina.core.session.IoSession session, T message)
boolean	isConfidentialityRequirementSatisfied(org.apache.mina.core.session.IoSession session) Checks to see if confidentiality requirements are met.
void	rejectWithoutConfidentiality(org.apache.mina.core.session.IoSession session, org.apache.directory.api.ldap.model.message.ResultResponse resp)
void	setLdapServer(LdapServer ldapServer) Associates a Ldap server instance to the message handler

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

The logger for this class

ldapServer

protected LdapServer ldapServer

The reference on the Ldap server instance

Constructor Detail

LdapRequestHandler

public LdapRequestHandler()

Method Detail

getLdapServer

public final LdapServer getLdapServer()

Returns:

The associated ldap server instance

setLdapServer

public final void setLdapServer(LdapServer ldapServer)

Associates a Ldap server instance to the message handler

Parameters:

ldapServer - the associated ldap server instance

isConfidentialityRequirementSatisfied

public final boolean isConfidentialityRequirementSatisfied(org.apache.mina.core.session.IoSession session)

Checks to see if confidentiality requirements are met. If the LdapServer requires confidentiality and the SSLFilter is engaged this will return true. If confidentiality is not required this will return true. If confidentially is required and the SSLFilter is not engaged in the IoFilterChain this will return false. This method is used by handlers to determine whether to send back ResultCodeEnum.CONFIDENTIALITY_REQUIRED error responses back to clients.

Parameters:

session - the MINA IoSession to check for TLS security

Returns:

true if confidentiality requirement is met, false otherwise

rejectWithoutConfidentiality

public void rejectWithoutConfidentiality(org.apache.mina.core.session.IoSession session,
                                         org.apache.directory.api.ldap.model.message.ResultResponse resp)

handleMessage

public final void handleMessage(org.apache.mina.core.session.IoSession session,
                                T message)
                         throws Exception

Specified by:

handleMessage in interface org.apache.mina.handler.demux.MessageHandler<T extends org.apache.directory.api.ldap.model.message.Request>

Throws:

Exception

handle

public abstract void handle(LdapSession session,
                            T message)
                     throws Exception

Handle a Ldap message associated with a session

Parameters:

session - The associated session

message - The message we have to handle

Throws:

Exception - If there is an error during the processing of this message

handleException

public void handleException(LdapSession session,
                            org.apache.directory.api.ldap.model.message.ResultResponseRequest request,
                            org.apache.directory.api.ldap.model.message.ResultResponse response,
                            Exception e)

Handles processing with referrals without ManageDsaIT decorator.

Parameters:

session - The associated session

req - The response

e - The associated exception

getLdapApiService

protected org.apache.directory.api.ldap.codec.api.LdapApiService getLdapApiService()

Returns:

The LDAP API Codec service