Keel 2.1RC2

org.keel.services.authentication.config
Class ConfigLoginModule

java.lang.Object
  extended byorg.keel.services.authentication.config.ConfigLoginModule
All Implemented Interfaces:
javax.security.auth.spi.LoginModule

public class ConfigLoginModule
extends java.lang.Object
implements javax.security.auth.spi.LoginModule

ConfigLoginModule is a LoginModule that authenticates a given username/password credential against a configuration file.

Version:
1.0
Author:
Michael Nash
See Also:
LoginModule

Field Summary
(package private)  javax.security.auth.callback.CallbackHandler callbackHandler
           
(package private)  Configuration conf
           
(package private)  boolean debug
           
(package private)  java.util.Map options
           
(package private)  java.lang.String passwordSeq
           
(package private)  java.util.Map sharedState
           
(package private)  javax.security.auth.Subject subject
           
(package private)  boolean success
           
 
Constructor Summary
ConfigLoginModule()
          Creates a login module that can authenticate against configuration.
 
Method Summary
 boolean abort()
           This method is called if the LoginContext's overall authentication failed.
 boolean commit()
          Abstract method to commit the authentication process.
 void initialize(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map sharedState, java.util.Map options)
          Initialize this LoginModule.
 boolean login()
           Verify the user against the relevant JDBC datasource.
 boolean logout()
          Logout a user.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

callbackHandler

javax.security.auth.callback.CallbackHandler callbackHandler

subject

javax.security.auth.Subject subject

sharedState

java.util.Map sharedState

options

java.util.Map options

conf

Configuration conf

success

boolean success

debug

boolean debug

passwordSeq

java.lang.String passwordSeq
Constructor Detail

ConfigLoginModule

public ConfigLoginModule()

Creates a login module that can authenticate against configuration.

Method Detail

initialize

public void initialize(javax.security.auth.Subject subject,
                       javax.security.auth.callback.CallbackHandler callbackHandler,
                       java.util.Map sharedState,
                       java.util.Map options)
Initialize this LoginModule.

Specified by:
initialize in interface javax.security.auth.spi.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 - shared LoginModule state.

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

login

public boolean login()
              throws javax.security.auth.login.LoginException

Verify the user against the relevant JDBC datasource.

Specified by:
login in interface javax.security.auth.spi.LoginModule
Returns:
true always, since this LoginModule should not be ignored.
Throws:
FailedLoginException - if the authentication fails.

javax.security.auth.login.LoginException - if this LoginModule is unable to perform the authentication.

commit

public boolean commit()
               throws javax.security.auth.login.LoginException
Abstract method to commit the authentication process.

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 a KeelPrincipal with the Subject located in the LoginModule. If this LoginModule's own authentication attempted failed, then this method removes any state that was originally saved.

Specified by:
commit in interface javax.security.auth.spi.LoginModule
Returns:
true if this LoginModule's own login and commit attempts succeeded, or false otherwise.
Throws:
javax.security.auth.login.LoginException - if the commit fails

abort

public boolean abort()
              throws javax.security.auth.login.LoginException

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 and commit methods), then this method cleans up any state that was originally saved.

Specified by:
abort in interface javax.security.auth.spi.LoginModule
Returns:
false if this LoginModule's own login and/or commit attempts failed, and true otherwise.
Throws:
javax.security.auth.login.LoginException - if the abort fails.

logout

public boolean logout()
               throws javax.security.auth.login.LoginException
Logout a user.

This method removes the Principals that were added by the commit method.

Specified by:
logout in interface javax.security.auth.spi.LoginModule
Returns:
true in all cases since this LoginModule should not be ignored.
Throws:
javax.security.auth.login.LoginException - if the logout fails.

Keel 2.1RC2

Please see keelframework.org for information about new Keel releases.