org.jboss.security.auth.spi

Class ProxyLoginModule

java.lang.Object

org.jboss.security.auth.spi.ProxyLoginModule

All Implemented Interfaces:

LoginModule

public class ProxyLoginModule
extends Object
implements LoginModule

A proxy LoginModule that loads a delegate LoginModule using the current thread context class loader. The purpose of this module is to work around the current JAAS class loader limitation that requires LoginModules to be on the classpath. Some LoginModules use core JBoss classes that would have to be moved into the jboss-jaas.jar and packaging becomes a mess. Instead, these LoginModules are left in the jbosssx.jar and the ProxyLoginModule is used to bootstrap the non-classpath LoginModule.

Version:

$Revision: 276 $

Author:

Scott.Stark@jboss.org

Constructor Summary

Constructors

Constructor and Description
ProxyLoginModule()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	abort()
boolean	commit()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options) Initialize this LoginModule.
boolean	login() Perform the login.
boolean	logout()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyLoginModule

public ProxyLoginModule()

Method Detail

initialize

public void initialize(Subject subject,
              CallbackHandler callbackHandler,
              Map<String,?> sharedState,
              Map<String,?> options)

Initialize this LoginModule. This method loads the LoginModule specified by the moduleName option using the current thread context class loader and then delegates the initialize call to it.

Specified by:

initialize in interface LoginModule

Parameters:

options, - include: moduleName: the classname of the module that this proxy module delegates all calls to.

login

public boolean login()
              throws LoginException

Perform the login. If either the moduleName option was not specified or the module could not be loaded in initalize(), this method throws a LoginException.

Specified by:

login in interface LoginModule

Throws:

LoginException, - throw in the delegate login module failed.

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