public interface LogonCmd extends ControllerCommand
This controller command logs a user into the system. If the user is logging in from a guest shopper identity, then also migrate the guest shopper resources to the new user login identity.
Before executing this task command, the methods listed below must be invoked.
Upon successful authentication, the user is redirected to the URL specified by setPostLogonURL. Upon unsuccessful authentication, the user is redirected to the URL specified by setReLogonURL.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The copyright field.
|
static java.lang.String |
defaultCommandClassName
The default command implementation class.
|
static java.lang.String |
NAME
The command name.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAuthenticateUserId()
This method retrieves the user ID of the logged in user.
|
void |
setLogonId(java.lang.String strLogonId)
This method sets the logon ID under which the current user wishes to logon.
|
void |
setLogonPassword(java.lang.String strPassword)
This method sets the password to use for authentication with the
new logon ID.
|
void |
setPostLogonURL(java.lang.String strPostLoginURL)
This method sets the URL to redirect the user to after a successful authentication.
|
void |
setReLogonURL(java.lang.String strReLoginURL)
This method sets the URL to redirct the user to after an unsuccessful authentication.
|
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
fulfills, getOwner
static final java.lang.String COPYRIGHT
static final java.lang.String NAME
static final java.lang.String defaultCommandClassName
java.lang.String getAuthenticateUserId()
void setLogonId(java.lang.String strLogonId)
strLogonId
- The logon IDvoid setLogonPassword(java.lang.String strPassword)
strPassword
- The password.void setPostLogonURL(java.lang.String strPostLoginURL)
strPostLoginURL
- The post login URL.void setReLogonURL(java.lang.String strReLoginURL)
strReLoginURL
- The relogin login URL.