org.esupportail.cas.server.handlers.ldap
Class LdapHandler

java.lang.Object
  org.esupportail.cas.server.util.log.Debug
      org.esupportail.cas.server.util.BasicHandler
          org.esupportail.cas.server.util.RedundantHandler
              org.esupportail.cas.server.handlers.ldap.LdapHandler

Direct Known Subclasses:

BindLdapHandler, FastBindLdapHandler

abstract class LdapHandler
extends RedundantHandler

This abstract class implements an LDAP handler class, inherited by FastBindLdapHandler and BindLdapHandler.

Author:

Pascal Aubry

Field Summary

private java.lang.String

filter The filter for the usernames provided by the users.

Fields inherited from class org.esupportail.cas.server.util.BasicHandler

FAILED_CONTINUE, FAILED_STOP, SUCCEEDED

Constructor Summary

protected

LdapHandler(org.dom4j.Element handlerElement, java.lang.Boolean configDebug) Constructor.

Method Summary

(package private) java.lang.String

getFilter() Retrieve the filter of the usernames.

Methods inherited from class org.esupportail.cas.server.util.RedundantHandler

addServers, authenticate, getServers

Methods inherited from class org.esupportail.cas.server.util.BasicHandler

checkConfigElement, getConfigElement, getConfigSubElementContent, hasConfigSubElement

Methods inherited from class org.esupportail.cas.server.util.log.Debug

checkClass, elementDebugValue, isDebug, setDebug, trace, trace, traceBegin, traceEnd, traceEnd, traceEnd, traceThrow

Methods inherited from class java.lang.Object

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

Field Detail

filter

private java.lang.String filter

The filter for the usernames provided by the users.

Constructor Detail

LdapHandler

protected LdapHandler(org.dom4j.Element handlerElement,
                      java.lang.Boolean configDebug)
               throws java.lang.Exception

Constructor.

Parameters:

handlerElement - the XML element that declares the handler in the configuration file

configDebug - debugging mode of the global configuration

Throws:

java.lang.Exception - Exception

Method Detail

getFilter

final java.lang.String getFilter()

Retrieve the filter of the usernames.

Returns:

a String Object.