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

java.lang.Object
  org.apache.geronimo.security.realm.providers.CertificateChainLoginModule

All Implemented Interfaces:

LoginModule

public class CertificateChainLoginModule
extends Object
implements LoginModule

An example LoginModule that authenticates based on a client certificate. Authentication is provided by the SSL layer supplying the client certificate. All we check is that it is present. Expects to be run by a GenericSecurityRealm (doesn't work on its own). This login module checks security credentials so the lifecycle methods must return true to indicate success or throw LoginException to indicate failure.

Field Summary

static List<String>

supportedOptions

Constructor Summary

CertificateChainLoginModule()

Method Summary

boolean	abort()
boolean	commit()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
boolean	login() This LoginModule is not to be ignored.
boolean	logout()

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

Constructor Detail

CertificateChainLoginModule

public CertificateChainLoginModule()

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