com.ibm.commerce.security.commands

Interface LogonCmd

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Subinterfaces:

BusinessContextServiceLogonCmd

All Known Implementing Classes:

BusinessContextServiceLogonCmdImpl, LogonCmdImpl

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.

• 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

Fields

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.

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

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.

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The copyright field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The command name.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default command implementation class.

See Also:

Constant Field Values

Method Detail

getAuthenticateUserId

java.lang.String getAuthenticateUserId()

This method retrieves the user ID of the logged in user.

Returns:

The user ID.

setLogonId

void setLogonId(java.lang.String strLogonId)

This method sets the logon ID under which the current user wishes to logon.

Parameters:

strLogonId - The logon ID

setLogonPassword

void setLogonPassword(java.lang.String strPassword)

This method sets the password to use for authentication with the new logon ID.

Parameters:

strPassword - The password.

setPostLogonURL

void setPostLogonURL(java.lang.String strPostLoginURL)

This method sets the URL to redirect the user to after a successful authentication.

Parameters:

strPostLoginURL - The post login URL.

setReLogonURL

void setReLogonURL(java.lang.String strReLoginURL)

This method sets the URL to redirct the user to after an unsuccessful authentication.

Parameters:

strReLoginURL - The relogin login URL.