org.ow2.jonas.security.auth.spi
Class SignLoginModule
java.lang.Object
org.ow2.jonas.security.auth.spi.SignLoginModule
- All Implemented Interfaces:
- LoginModule
public class SignLoginModule
- extends Object
- implements LoginModule
This class is used to sign the current subject.
- Author:
- Florent Benoit
Method Summary |
boolean |
abort()
Method to abort the authentication process (phase 2). |
boolean |
commit()
Method to commit the authentication process (phase 2). |
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 |
SignLoginModule
public SignLoginModule()
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
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
Copyright © 2010 OW2 Consortium. All Rights Reserved.