oracle.security.jazn.realm
Class RealmLoginModule

java.lang.Object
  |
  +--oracle.security.jazn.realm.RealmLoginModule

All Implemented Interfaces:

javax.security.auth.spi.LoginModule

public class RealmLoginModule

extends Object

implements javax.security.auth.spi.LoginModule

A Realm-based Login module.

Constructor Summary

RealmLoginModule()

Method Summary

Type	Method
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, Map sharedState, Map options) Initialize this LoginModule.
boolean	login() Authenticate the user by prompting for a username and password.
boolean	login(JAZNConfig config, String username, String password)
boolean	login(JAZNConfig config, String realmname, String username, String password)
boolean	logout() Logout the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealmLoginModule

public RealmLoginModule()

Method Detail

initialize

public void initialize(javax.security.auth.Subject subject,
                       javax.security.auth.callback.CallbackHandler callbackHandler,
                       Map sharedState,
                       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

Authenticate the user by prompting for a username and password.

Specified by:

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

Returns:

true in all cases 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.

login

public boolean login(JAZNConfig config,
                     String username,
                     String password)
              throws javax.security.auth.login.LoginException

login

public boolean login(JAZNConfig config,
                     String realmname,
                     String username,
                     String password)
              throws javax.security.auth.login.LoginException

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 attempt succeeded (checked by retrieving the private state saved by the login method), then this method associates a RealmPrincipal 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 the user.

This method removes the RealmPrincipal that was 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.