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

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
                  org.esupportail.cas.server.handlers.ldap.BindLdapHandler

public final class BindLdapHandler
extends LdapHandler

This class implements a bind LDAP handler class. It is used by GenericHandler.

Author:

Pascal Aubry

Field Summary

private java.lang.String	bindDn the DN to bind to the LDAP directory.
private java.lang.String	bindPassword the password to bind to the LDAP directory.
private boolean	multipleAccountsEnabled A flag set to true if multiple accounts in the LDAP directory are allowed.
private java.lang.String	scope the scope for LDAP searches.
private java.lang.String	searchBase the base for LDAP searches.

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

FAILED_CONTINUE, FAILED_STOP, SUCCEEDED

Constructor Summary

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

Method Summary

protected boolean	areMultipleAccountsEnabled() Tell if multiple accounts in the LDAP directory are allowed.
(package private) java.lang.String	getBindDn() Retrieve the DN to bind to the LDAP directory.
(package private) java.lang.String	getBindPassword() Retrieve the password to bind to the LDAP directory.
(package private) java.lang.String	getScope() Retrieve the scope for LDAP searches.
(package private) java.lang.String	getSearchBase() Retrieve the base for LDAP searches.

Methods inherited from class org.esupportail.cas.server.handlers.ldap.LdapHandler

getFilter

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

bindDn

private java.lang.String bindDn

the DN to bind to the LDAP directory.

bindPassword

private java.lang.String bindPassword

the password to bind to the LDAP directory.

multipleAccountsEnabled

private boolean multipleAccountsEnabled

A flag set to true if multiple accounts in the LDAP directory are allowed.

scope

private java.lang.String scope

the scope for LDAP searches.

searchBase

private java.lang.String searchBase

the base for LDAP searches.

Constructor Detail

BindLdapHandler

public BindLdapHandler(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

areMultipleAccountsEnabled

protected boolean areMultipleAccountsEnabled()

Tell if multiple accounts in the LDAP directory are allowed.

Returns:

a boolean.

getBindDn

java.lang.String getBindDn()

Retrieve the DN to bind to the LDAP directory.

Returns:

a string.

getBindPassword

java.lang.String getBindPassword()

Retrieve the password to bind to the LDAP directory.

Returns:

a string.

getScope

java.lang.String getScope()

Retrieve the scope for LDAP searches.

Returns:

a string.

getSearchBase

java.lang.String getSearchBase()

Retrieve the base for LDAP searches.

Returns:

a string.