org.ow2.jonas.security.auth.spi
Class RemoteLoginModule

java.lang.Object
  org.ow2.jonas.security.auth.spi.RemoteLoginModule

All Implemented Interfaces:

LoginModule

public class RemoteLoginModule
extends Object
implements LoginModule

This Remote login module is used to run a JAAS authentication on the remote side. This allows users to provide a simple LoginModule which run on the server side and to share this login module from the client side (in this case it use remotely the user login module)

Author:

Florent Benoit

Constructor Summary

RemoteLoginModule()

Method Summary

boolean	abort() Method to abort the authentication process (phase 2).
boolean	commit() Method to commit the authentication process (phase 2).
protected JResourceRemote	findRemoteResource(List<String> resourceNames, List<String> userProviderURLs) Gets a remote resource in order to ask a remote authentication.
protected Context	getInitialContext(String providerURL) Builds an Initial Context for the given providerURL.
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options) Initialize this LoginModule.
boolean	login() Method to authenticate a Subject (phase 1).
boolean	logout() Method which logs out a Subject.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteLoginModule

public RemoteLoginModule()

Method Detail

initialize

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

Initialize this LoginModule. This method is called by the LoginContext after this LoginModule has been instantiated. The purpose of this method is to initialize this LoginModule with the relevant information. If this LoginModule does not understand any of the data stored in sharedState or options parameters, they can be ignored.

Specified by:

initialize in interface LoginModule

Parameters:

subject - the Subject to be authenticated.

callbackHandler - a CallbackHandler for communicating with the end user (prompting for usernames and passwords, for example).

sharedState - state shared with other configured LoginModules.

options - options specified in the login Configuration for this particular LoginModule.

login

public boolean login()
              throws LoginException

Method to authenticate a Subject (phase 1). The implementation of this method authenticates a Subject. For example, it may prompt for Subject information such as a username and password and then attempt to verify the password. This method saves the result of the authentication attempt as private state within the LoginModule.

Specified by:

login in interface LoginModule

Returns:

true if the authentication succeeded, or false if this LoginModule should be ignored.

Throws:

LoginException - if the authentication fails

findRemoteResource

protected JResourceRemote findRemoteResource(List<String> resourceNames,
                                             List<String> userProviderURLs)
                                      throws LoginException

Gets a remote resource in order to ask a remote authentication.

Parameters:

resourceNames - the names of the resources that should be in the registry.

userProviderURLs - the list of PROVIDER_URL to use (empty/null = default)

Returns:

the first resource found, else throw an exception

Throws:

LoginException - if no resources are available.

getInitialContext

protected Context getInitialContext(String providerURL)
                             throws NamingException

Builds an Initial Context for the given providerURL.

Parameters:

providerURL - the given URL to use. If null, use the default setting

Returns:

an instance of Initial Context

Throws:

NamingException - if no context can be built

commit

public boolean commit()
               throws LoginException

Method to commit the authentication process (phase 2). This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded). If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method associates relevant Principals and Credentials with the Subject located in the LoginModule. If this LoginModule's own authentication attempted failed, then this method removes/destroys any state that was originally saved.

Specified by:

commit in interface LoginModule

Returns:

true if this method succeeded, or false if this LoginModule should be ignored.

Throws:

LoginException - if the commit fails

abort

public boolean abort()
              throws LoginException

Method to abort the authentication process (phase 2). This method is called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed). If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method cleans up any state that was originally saved.

Specified by:

abort in interface LoginModule

Returns:

true if this method succeeded, or false if this LoginModule should be ignored.

Throws:

LoginException - if the abort fails

logout

public boolean logout()
               throws LoginException

Method which logs out a Subject. An implementation of this method might remove/destroy a Subject's Principals and Credentials.

Specified by:

logout in interface LoginModule

Returns:

true if this method succeeded, or false if this LoginModule should be ignored.

Throws:

LoginException - if the logout fails