|
JAAS Provider Java API Reference 10g (9.0.4.0.0) B10389-01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.security.jazn.realm.RealmLoginModule
A Realm-based Login module.
Constructor Summary | |
RealmLoginModule() |
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(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options) Initialize this LoginModule . |
boolean |
login() Authenticate the user by prompting for a username and password. |
boolean |
logout() Logout the user. |
boolean |
mylogin(JAZNConfig config, String username, char[] password) |
boolean |
mylogin(JAZNConfig config, String realmname, String username, char[] password) |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RealmLoginModule()
Method Detail |
public void initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
LoginModule
.initialize
in interface LoginModule
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
.public boolean login() throws LoginException
login
in interface LoginModule
LoginModule
should not be ignored.FailedLoginException
- if the authentication fails.LoginException
- if this LoginModule
is unable to perform the authentication.public boolean mylogin(JAZNConfig config, String username, char[] password) throws LoginException
LoginException
public boolean mylogin(JAZNConfig config, String realmname, String username, char[] password) throws LoginException
LoginException
public boolean commit() throws 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.
commit
in interface LoginModule
LoginException
- if the commit fails.public boolean abort() throws 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.
abort
in interface LoginModule
LoginException
- if the abort fails.public boolean logout() throws LoginException
This method removes the RealmPrincipal
that was added by the commit
method.
logout
in interface LoginModule
LoginModule
should not be ignored.LoginException
- if the logout fails.
|
JAAS Provider Java API Reference 10g (9.0.4.0.0) B10389-01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |