java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.security.commands.LogonCmdImpl
This controller command will log the user into the system. If the user is logging in from a guest shopper identity then the resources that exist under the guest shopper identity is migrated to the identity to which the user is logging in.
Before executing this task command, the methods listed below must be invoked.
setLogonId setPassword setReLogonURL setPostLogonURL
Upon successful authentication the user is redirected to the URL specified by the setPostLogonURL. Upon unsuccessful authentication the user is redirected to the URL specified by setReLogonURL.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT Copyright field. |
static java.lang.String |
ERRTASK_NAME Error task name. |
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.security.commands. LogonCmd |
defaultCommandClassName,
NAME |
Constructor Summary | |
---|---|
LogonCmdImpl() |
Method Summary | |
---|---|
java.lang.String |
getAuthenticateUserId() Retrieves the userId of the logged in user. |
protected
java.lang.String |
getLogonId() Retrieves the logonId under which the current user wishes to logon. |
protected
java.lang.String |
getLogonPassword() Retrieves the password to be used for authentication with the new logonId. |
protected
MemberAccessBean |
getMemberObject() Get the member object. |
protected
java.lang.String |
getPostLogonURL() Retrieves the URL to w which the user should be redirected to after successful authentication. |
protected
java.lang.String |
getReLogonURL() Retrieves the URL to which the user should be redirected to if authentication was unsuccessful. |
protected
UserRegistryAccessBean |
getUserRegistryObject() Get the user registry object. |
protected
boolean |
isAccountDisabled() Whether or not the account is disabled. |
protected
boolean |
isAnyParentOrgLocked() Returns true if any parent organization is locked. |
boolean |
isGeneric() Whether or not a generic user is permitted to execute this command. |
protected
boolean |
isLDAPUsed() Whether or not authentication mode is LDAP. |
protected
boolean |
isLogonAllowedNow() Whether or not the user is allowed to logon at this time. |
protected
boolean |
isUserApproved() Whether or not the user is approved. |
protected
boolean |
isUserRegisteredInOrg() Whether or not the user has a role in the org owning the store. |
protected
boolean |
isValidCredentials() Based on the configuration parameters in the WCS configuration file, one of three authentication task will be called. |
protected
void |
migrateUserEntries() This method will migrate 'resources' belonging to the current user to the identity, associated with the logon ID, which the user will be assuming once the logon is successful. |
void |
performExecute() Execute the command. |
void |
setLogonId(java.lang.String strLogonId) Set the logonId. |
void |
setLogonPassword(java.lang.String strPassword) Set the logonPassword. |
void |
setPostLogonURL(java.lang.String strPostLoginURL) Set the postLogonURL. |
void |
setReLogonURL(java.lang.String strReLoginURL) Set the relogonURL. |
void |
setRequestProperties(
TypedProperty hshReqParameters) Set the request properties. |
protected
void |
updateCmdContext() Switches the current user identity to the identity associated with the LoginID supplied to this Logon command. |
void |
updateLockoutInformation(boolean valid_credentials) Updates the lockount information |
void |
validateParameters() Validate the parameters. |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
getViewInputProperties,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
reset,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
execute,
getGeneric,
getRequestProperties,
getResolvedRequestProperties,
getResponseProperties,
getRetriable,
getViewInputProperties,
isRetriable,
mergeProperties,
setGeneric,
setRetriable,
setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command. AccCommand |
accessControlCheck,
getAccCheck,
getForUserId,
getResourceOwners,
setAccCheck,
setForUserId,
setOwner |
Methods inherited from interface com.ibm.commerce.command. ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String ERRTASK_NAME
Constructor Detail |
---|
public LogonCmdImpl()
Method Detail |
---|
public java.lang.String getAuthenticateUserId()
getAuthenticateUserId
in interface
LogonCmd
protected java.lang.String getLogonId()
protected java.lang.String getLogonPassword()
protected java.lang.String getPostLogonURL()
protected java.lang.String getReLogonURL()
protected boolean isAccountDisabled() throws ECSystemException
ECSystemException
public boolean isGeneric()
isGeneric
in interface
ControllerCommand
isGeneric
in class
ControllerCommandImpl
protected boolean isLogonAllowedNow()
protected boolean isValidCredentials() throws ECException
ECException
protected void migrateUserEntries() throws ECException
ECException
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
public void setLogonId(java.lang.String strLogonId)
setLogonId
in interface
LogonCmd
strLogonId
- The logonId to use when logging on to the
store.public void setLogonPassword(java.lang.String strPassword)
setLogonPassword
in interface
LogonCmd
strPassword
- The password to use when logging on to the
store.public void setPostLogonURL(java.lang.String strPostLoginURL)
setPostLogonURL
in interface
LogonCmd
strPostLoginURL
- The post login URL.public void setReLogonURL(java.lang.String strReLoginURL)
setReLogonURL
in interface
LogonCmd
strReLoginURL
- The URL to redirect to if logon is not
successful.public void setRequestProperties(TypedProperty hshReqParameters) throws ECApplicationException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
hshReqParameters
- The request parameters.
ECApplicationException
protected void updateCmdContext() throws ECException
ECException
public void updateLockoutInformation(boolean valid_credentials) throws ECException
valid_credentials
-ECException
public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException
protected boolean isAnyParentOrgLocked() throws ECException
ECException
protected boolean isUserRegisteredInOrg() throws ECException
Exception.
ECException
protected boolean isUserApproved()
protected UserRegistryAccessBean getUserRegistryObject()
protected MemberAccessBean getMemberObject()
protected boolean isLDAPUsed()