|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.tagish.auth.BasicLogin | +--com.tagish.auth.SimpleLogin
Base class for a variety of simple login modules that simply authenticate a user against some database of user credentials.
Field Summary | |
protected boolean |
commitSucceeded
|
protected Vector |
pending
|
protected Vector |
principals
|
Fields inherited from class com.tagish.auth.BasicLogin |
callbackHandler, debug, options, sharedState, subject |
Constructor Summary | |
SimpleLogin()
|
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). |
boolean |
login()
Authenticate the user. |
boolean |
logout()
Logout the user. |
protected void |
putPrincipal(Set s,
Principal p)
Place the specified Principle in the subject and also record it in our
principles Vector so we can remove them all later. |
protected abstract Vector |
validateUser(String username,
char[] password)
Validate a user's credentials and either throw a LoginException (if validation fails) or return a Vector of Principals if validation succeeds. |
Methods inherited from class com.tagish.auth.BasicLogin |
getOption, getOption, getOption, initialize |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Vector principals
protected Vector pending
protected boolean commitSucceeded
Constructor Detail |
public SimpleLogin()
Method Detail |
protected abstract Vector validateUser(String username, char[] password) throws javax.security.auth.login.LoginException
username
- The usernamepassword
- The passwordjavax.security.auth.login.LoginException
- if the login fails.public boolean login() throws javax.security.auth.login.LoginException
LoginModule
should not be ignored.FailedLoginException
- if the authentication fails. javax.security.auth.login.LoginException
- if this LoginModule
is unable to perform the authentication.protected void putPrincipal(Set s, Principal p)
Principle
in the subject and also record it in our
principles Vector
so we can remove them all later.s
- The Set
to add the Principle top
- Principle to addpublic 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
number of NTPrincipal
s
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.
javax.security.auth.login.LoginException
- if the commit fails.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.
javax.security.auth.login.LoginException
- if the abort fails.public boolean logout() throws javax.security.auth.login.LoginException
This method removes the Principal
s
that were added by the commit
method.
LoginModule
should not be ignored.javax.security.auth.login.LoginException
- if the logout fails.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |