examples.security.jaas
Class SampleLoginModule

java.lang.Object
  |
  +--examples.security.jaas.SampleLoginModule

All Implemented Interfaces:

javax.security.auth.spi.LoginModule

public class SampleLoginModule

extends java.lang.Object

implements javax.security.auth.spi.LoginModule

Sample login module that performs password authentication.

Constructor Summary

SampleLoginModule()

Method Summary

boolean	abort() This method is called if the LoginContext's overall authentication failed.
boolean	commit() This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).
void	initialize(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map sharedState, java.util.Map options) Initialize
boolean	login() Authenticate the user by username and password passed in
boolean	logout() Logout the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleLoginModule

public SampleLoginModule()

Method Detail

abort

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

This method is called if the LoginContext's overall authentication failed. 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.

commit

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

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 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.

initialize

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

Initialize

Specified by:

initialize in interface javax.security.auth.spi.LoginModule

login

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

Authenticate the user by username and password passed in

Specified by:

login in interface javax.security.auth.spi.LoginModule

Returns:

true in all cases

Throws:

javax.security.auth.login.FailedLoginException - if the authentication fails.

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

logout

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

Logout the user.

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.