com.ibm.commerce.security.commands
Interface LogonCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
All Known Implementing Classes:
LogonCmdImpl

public interface LogonCmd
extends ControllerCommand

This controller command logs 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 setPostLogonURL. Upon unsuccessful authentication, the user is redirected to the URL specified by setReLogonURL.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 java.lang.String getAuthenticateUserId()
          Retrieves the user ID of the logged in user.
 void setLogonId(java.lang.String strLogonId)
          Sets the logon ID under which the current user wishes to logon.
 void setLogonPassword(java.lang.String strPassword)
          Sets the password to be used for authentication with the new logon ID.
 void setPostLogonURL(java.lang.String strPostLoginURL)
          Sets the URL to which the user should be redirected after successful authentication.
 void setReLogonURL(java.lang.String strReLoginURL)
          Sets the URL to which the user should be redirected to if authentication was unsuccessful.
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

NAME

public static final java.lang.String NAME
Method Detail

getAuthenticateUserId

public java.lang.String getAuthenticateUserId()
Retrieves the user ID of the logged in user.
Returns:
The user ID.

setLogonId

public void setLogonId(java.lang.String strLogonId)
Sets the logon ID under which the current user wishes to logon.
Parameters:
strLogonID - The logon ID.

setLogonPassword

public void setLogonPassword(java.lang.String strPassword)
Sets the password to be used for authentication with the new logon ID.
Parameters:
strPassword - The password.

setPostLogonURL

public void setPostLogonURL(java.lang.String strPostLoginURL)
Sets the URL to which the user should be redirected after successful authentication.
Parameters:
strPostLoginURL - The post login URL.

setReLogonURL

public void setReLogonURL(java.lang.String strReLoginURL)
Sets the URL to which the user should be redirected to if authentication was unsuccessful.
Parameters:
strReLoginURL - The relogin login URL.