public abstract class AbstractLoginModule extends Object implements LoginModule
Modifier and Type | Field and Description |
---|---|
protected CallbackHandler |
callbackHandler
Initialized callback handler.
|
protected boolean |
clearPass
Whether credentials should be removed from the shared state map.
|
protected boolean |
commitSuccess
Whether commit was successful.
|
protected Set<LdapCredential> |
credentials
Credentials to add to the subject.
|
protected List<LdapRole> |
defaultRole
Default roles.
|
protected Logger |
logger
Logger for this class.
|
static String |
LOGIN_DN
Constant for entryDn stored in shared state.
|
static String |
LOGIN_NAME
Constant for login name stored in shared state.
|
static String |
LOGIN_PASSWORD
Constant for login password stored in shared state.
|
protected boolean |
loginSuccess
Whether authentication was successful.
|
protected String |
principalGroupName
Name of group to add all principals to.
|
protected Set<Principal> |
principals
Principals to add to the subject.
|
protected String |
roleGroupName
Name of group to add all roles to.
|
protected Set<Principal> |
roles
Roles to add to the subject.
|
protected boolean |
setLdapCredential
Whether ldap credential data should be set.
|
protected boolean |
setLdapDnPrincipal
Whether ldap dn principal data should be set.
|
protected boolean |
setLdapPrincipal
Whether ldap principal data should be set.
|
protected Map |
sharedState
Shared state from other login module.
|
protected boolean |
storePass
Whether credentials should be stored in the shared state map.
|
protected Subject |
subject
Initialized subject.
|
protected boolean |
tryFirstPass
Whether credentials from the shared state should be used if they are available.
|
protected boolean |
useFirstPass
Whether credentials from the shared state should be used.
|
Constructor and Description |
---|
AbstractLoginModule() |
Modifier and Type | Method and Description |
---|---|
boolean |
abort() |
protected void |
clearState()
Removes any stateful principals, credentials, or roles stored by login.
|
boolean |
commit() |
protected void |
getCredentials(NameCallback nameCb,
PasswordCallback passCb,
boolean useCallback)
Attempts to retrieve credentials for the supplied name and password callbacks.
|
void |
initialize(Subject subj,
CallbackHandler handler,
Map<String,?> state,
Map<String,?> options) |
boolean |
login() |
protected abstract boolean |
login(NameCallback nameCb,
PasswordCallback passCb)
Authenticates a
Subject with the supplied callbacks. |
boolean |
logout() |
protected void |
storeCredentials(NameCallback nameCb,
PasswordCallback passCb,
String loginDn)
Stores the supplied name, password, and entry dn in the stored state map.
|
public static final String LOGIN_NAME
public static final String LOGIN_DN
public static final String LOGIN_PASSWORD
protected final Logger logger
protected Subject subject
protected CallbackHandler callbackHandler
protected Map sharedState
protected boolean useFirstPass
protected boolean tryFirstPass
protected boolean storePass
protected boolean clearPass
protected boolean setLdapPrincipal
protected boolean setLdapDnPrincipal
protected boolean setLdapCredential
protected String principalGroupName
protected String roleGroupName
protected boolean loginSuccess
protected boolean commitSuccess
protected Set<LdapCredential> credentials
public void initialize(Subject subj, CallbackHandler handler, Map<String,?> state, Map<String,?> options)
initialize
in interface LoginModule
public boolean login() throws LoginException
login
in interface LoginModule
LoginException
protected abstract boolean login(NameCallback nameCb, PasswordCallback passCb) throws LoginException
Subject
with the supplied callbacks.nameCb
- callback handler for subject's namepassCb
- callback handler for subject's passwordLoginException
- if the authentication failspublic boolean commit() throws LoginException
commit
in interface LoginModule
LoginException
public boolean abort() throws LoginException
abort
in interface LoginModule
LoginException
public boolean logout() throws LoginException
logout
in interface LoginModule
LoginException
protected void clearState()
protected void getCredentials(NameCallback nameCb, PasswordCallback passCb, boolean useCallback) throws LoginException
nameCb
- to set name forpassCb
- to set password foruseCallback
- whether to force a callback handlerLoginException
- if the callback handler failsprotected void storeCredentials(NameCallback nameCb, PasswordCallback passCb, String loginDn)
nameCb
- to storepassCb
- to storeloginDn
- to storeCopyright © 2003-2019 Virginia Tech. All Rights Reserved.