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

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

All Implemented Interfaces:

LoginModule

public class PropertiesFileNoPasswordLoginModule
extends Object
implements LoginModule

This login module should only be used if the user is already authenticated, such as from client cert or openid, and the only remaining task is to add group information. A LoginModule that reads groups from a file on disk. The file should be formatted using standard Java properties syntax. Expects to be run by a GenericSecurityRealm (doesn't work on its own).

This login module does not check security credentials so the lifecycle methods must return true to indicate success or throw a LoginException if the user is not known or supplied in the callback.

Version:

$Rev: 809078 $ $Date: 2009-08-29 08:51:12 +0800 (Sat, 29 Aug 2009) $

Field Summary

static String	GROUPS_URI
static List<String>	supportedOptions

Constructor Summary

PropertiesFileNoPasswordLoginModule()

Method Summary

boolean	abort()
boolean	commit()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
void	loadProperties(ServerInfo serverInfo, URI groupURI)
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

GROUPS_URI

public static final String GROUPS_URI

See Also:

Constant Field Values

supportedOptions

public static final List<String> supportedOptions

Constructor Detail

PropertiesFileNoPasswordLoginModule

public PropertiesFileNoPasswordLoginModule()

Method Detail

initialize

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

Specified by:

initialize in interface LoginModule

loadProperties

public void loadProperties(ServerInfo serverInfo,
                           URI groupURI)
                    throws GeronimoSecurityException

Throws:

GeronimoSecurityException

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