org.apache.geronimo.security.realm.providers
Class GenericHttpHeaderLdapLoginModule

java.lang.Object
  org.apache.geronimo.security.realm.providers.GenericHttpHeaderLoginmodule
      org.apache.geronimo.security.realm.providers.GenericHttpHeaderLdapLoginModule

All Implemented Interfaces:

LoginModule

public class GenericHttpHeaderLdapLoginModule
extends GenericHttpHeaderLoginmodule
implements LoginModule

Field Summary

protected DirContext	context
static List<String>	supportedOptions

Fields inherited from class org.apache.geronimo.security.realm.providers.GenericHttpHeaderLoginmodule

authenticationAuthority, callbackHandler, headerNames, httpRequest, subject, username

Constructor Summary

GenericHttpHeaderLdapLoginModule()

Method Summary

boolean	abort()
protected boolean	authenticate(String username)
protected void	bindUser(DirContext context, String dn)
protected void	close(DirContext context)
boolean	commit()
protected String	doRFC2254Encoding(String inputString)
protected ArrayList<String>	getRoles(DirContext context, String dn, String username, ArrayList<String> list)
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
boolean	login() This LoginModule is not to be ignored.
boolean	logout()
protected DirContext	open()

Methods inherited from class org.apache.geronimo.security.realm.providers.GenericHttpHeaderLoginmodule

abortHelper, commitHelper, logoutHelper, matchHeaders

Methods inherited from class java.lang.Object

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

Field Detail

supportedOptions

public static final List<String> supportedOptions

context

protected DirContext context

Constructor Detail

GenericHttpHeaderLdapLoginModule

public GenericHttpHeaderLdapLoginModule()

Method Detail

initialize

public void initialize(Subject subject,
                       CallbackHandler callbackHandler,
                       Map sharedState,
                       Map options)

Specified by:

initialize in interface LoginModule

login

public boolean login()
              throws LoginException

This LoginModule is not to be ignored. So, this method should never return false.

Specified by:

login in interface LoginModule

Returns:

true if authentication succeeds, or throw a LoginException such as FailedLoginException if authentication fails

Throws:

LoginException

commit

public boolean commit()
               throws LoginException

Specified by:

commit in interface LoginModule

Throws:

LoginException

abort

public boolean abort()
              throws LoginException

Specified by:

abort in interface LoginModule

Throws:

LoginException

logout

public boolean logout()
               throws LoginException

Specified by:

logout in interface LoginModule

Throws:

LoginException

close

protected void close(DirContext context)

authenticate

protected boolean authenticate(String username)
                        throws Exception

Throws:

Exception

getRoles

protected ArrayList<String> getRoles(DirContext context,
                                     String dn,
                                     String username,
                                     ArrayList<String> list)
                              throws NamingException

Throws:

NamingException

doRFC2254Encoding

protected String doRFC2254Encoding(String inputString)

bindUser

protected void bindUser(DirContext context,
                        String dn)
                 throws NamingException,
                        FailedLoginException

Throws:

NamingException

FailedLoginException

open

protected DirContext open()
                   throws NamingException

Throws:

NamingException