Class ClientPasswordLoginModule
- All Implemented Interfaces:
LoginModule
If testUser successfully authenticates itself, a UserPrincipal
with the testUser's
username is added to the Subject.
- Author:
- Harpreet Singh ([email protected])
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
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
(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options) Initialize thisLoginModule
.boolean
login()
Authenticate the user by prompting for a username and password.boolean
logout()
Logout the user.
-
Field Details
-
LOGIN_NAME
- See Also:
-
LOGIN_PASSWORD
- See Also:
-
-
Constructor Details
-
ClientPasswordLoginModule
public ClientPasswordLoginModule()
-
-
Method Details
-
initialize
public void initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options) Initialize thisLoginModule
.- Specified by:
initialize
in interfaceLoginModule
- Parameters:
subject
- theSubject
to be authenticated.callbackHandler
- aCallbackHandler
for communicating with the end user (prompting for usernames and passwords, for example).sharedState
- sharedLoginModule
state.options
- options specified in the loginConfiguration
for this particularLoginModule
.
-
login
Authenticate the user by prompting for a username and password.- Specified by:
login
in interfaceLoginModule
- Returns:
- true in all cases since this
LoginModule
should not be ignored. - Throws:
FailedLoginException
- if the authentication fails.LoginException
- if thisLoginModule
is unable to perform the authentication.
-
commit
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 aUserPrincipal
with theSubject
located in theLoginModule
. If this LoginModule's own authentication attempted failed, then this method removes any state that was originally saved.- Specified by:
commit
in interfaceLoginModule
- Returns:
- true if this LoginModule's own login and commit attempts succeeded, or false otherwise.
- Throws:
LoginException
- if the commit fails.
-
abort
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
andcommit
methods), then this method cleans up any state that was originally saved.- Specified by:
abort
in interfaceLoginModule
- Returns:
- false if this LoginModule's own login and/or commit attempts failed, and true otherwise.
- Throws:
LoginException
- if the abort fails.
-
logout
Logout the user.This method removes the
UserPrincipal
that was added by thecommit
method.- Specified by:
logout
in interfaceLoginModule
- Returns:
- true in all cases since this
LoginModule
should not be ignored. - Throws:
LoginException
- if the logout fails.
-