|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
weblogic.security.auth.login.UsernamePasswordLoginModule
public class UsernamePasswordLoginModule
UsernamePasswordLoginModule
is used in a WLS client to authenticate to the WLS server. This LoginModule authenticates users with a username/password. It can be used for both the T3 and IIOP clients. Callers of this module must implement callbacks to pass the username, password, and optional URL for the WLS server. Caller must implement a NameCallback for the username, a PasswordCallback for the username, and a URLCallback for the URL. If no URL is available, then the callback handler should return null for the URLCallback.
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 the login module. |
boolean |
login() Authenticate the user by username and password passed in |
boolean |
logout() Logout the user. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options)
initialize
in interface LoginModule
subject
- Subject to contain principals returned from WLS server.callbackHandler
- CallbackHandler containing Name, Password, and URL callbacks.sharedState
- Map used to share state among different login modules. This is not used by this login module.options
- Map used to specify options to this login module. Supported options debug and URL. The debug option can be used to display additional debugging information. The URL option can be used instead of the URL callback.public boolean login() throws LoginException
login
in interface LoginModule
FailedLoginException
- if the authentication fails.LoginException
- if this LoginModule is unable to perform the authentication.public boolean commit() throws LoginException
commit
in interface LoginModule
LoginException
- if the commit fails.public boolean abort() throws LoginException
abort
in interface LoginModule
LoginException
- if the abort fails.public boolean logout() throws LoginException
logout
in interface LoginModule
LoginException
- if the logout fails.
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |