org.acegisecurity.providers.ldap.authenticator
Class AbstractLdapAuthenticator

java.lang.Object
  extended by org.acegisecurity.providers.ldap.authenticator.AbstractLdapAuthenticator
All Implemented Interfaces:
LdapAuthenticator, org.springframework.beans.factory.InitializingBean, org.springframework.context.MessageSourceAware
Direct Known Subclasses:
BindAuthenticator, PasswordComparisonAuthenticator

public abstract class AbstractLdapAuthenticator
extends java.lang.Object
implements LdapAuthenticator, org.springframework.beans.factory.InitializingBean, org.springframework.context.MessageSourceAware

Base class for the authenticator implementations.

Version:
$Id: AbstractLdapAuthenticator.java 1585 2006-07-20 13:15:55Z carlossg $
Author:
Luke Taylor

Field Summary
protected  org.springframework.context.support.MessageSourceAccessor messages
           
 
Constructor Summary
AbstractLdapAuthenticator(InitialDirContextFactory initialDirContextFactory)
          Create an initialized instance to the InitialDirContextFactory provided.
 
Method Summary
 void afterPropertiesSet()
           
protected  InitialDirContextFactory getInitialDirContextFactory()
           
 java.lang.String[] getUserAttributes()
           
protected  LdapEntryMapper getUserDetailsMapper()
           
protected  java.util.List getUserDns(java.lang.String username)
          Builds list of possible DNs for the user, worked out from the userDnPatterns property.
protected  LdapUserSearch getUserSearch()
           
 void setMessageSource(org.springframework.context.MessageSource messageSource)
           
 void setUserAttributes(java.lang.String[] userAttributes)
          Sets the user attributes which will be retrieved from the directory.
 void setUserDetailsMapper(LdapUserDetailsMapper userDetailsMapper)
           
 void setUserDnPatterns(java.lang.String[] dnPattern)
          Sets the pattern which will be used to supply a DN for the user.
 void setUserSearch(LdapUserSearch userSearch)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.acegisecurity.providers.ldap.LdapAuthenticator
authenticate
 

Field Detail

messages

protected org.springframework.context.support.MessageSourceAccessor messages
Constructor Detail

AbstractLdapAuthenticator

public AbstractLdapAuthenticator(InitialDirContextFactory initialDirContextFactory)
Create an initialized instance to the InitialDirContextFactory provided.

Parameters:
initialDirContextFactory -
Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception
Specified by:
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
Throws:
java.lang.Exception

getInitialDirContextFactory

protected InitialDirContextFactory getInitialDirContextFactory()

getUserAttributes

public java.lang.String[] getUserAttributes()

getUserDetailsMapper

protected LdapEntryMapper getUserDetailsMapper()

getUserDns

protected java.util.List getUserDns(java.lang.String username)
Builds list of possible DNs for the user, worked out from the userDnPatterns property. The returned value includes the root DN of the provider URL used to configure the InitialDirContextfactory.

Parameters:
username - the user's login name
Returns:
the list of possible DN matches, empty if userDnPatterns wasn't set.

getUserSearch

protected LdapUserSearch getUserSearch()

setMessageSource

public void setMessageSource(org.springframework.context.MessageSource messageSource)
Specified by:
setMessageSource in interface org.springframework.context.MessageSourceAware

setUserAttributes

public void setUserAttributes(java.lang.String[] userAttributes)
Sets the user attributes which will be retrieved from the directory.

Parameters:
userAttributes -

setUserDetailsMapper

public void setUserDetailsMapper(LdapUserDetailsMapper userDetailsMapper)

setUserDnPatterns

public void setUserDnPatterns(java.lang.String[] dnPattern)
Sets the pattern which will be used to supply a DN for the user. The pattern should be the name relative to the root DN. The pattern argument {0} will contain the username. An example would be "cn={0},ou=people".

Parameters:
dnPattern - the array of patterns which will be tried when obtaining a username to a DN.

setUserSearch

public void setUserSearch(LdapUserSearch userSearch)


Copyright © 2004-2011 Interface21, Inc. All Rights Reserved.