com.ibm.commerce.security.commands

Interface VerifyCredentialsCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

VerifyCredentialsCmdImpl

public interface VerifyCredentialsCmd
extends TaskCommand

This command takes the input credentials and updates them in either the database, the LDAP server, or third-party system. Credentials are updated depending on how the WebSphere Commerce server is configured.

Before executing this task command, the methods listed below must be invoked.

• setLogonId
• setPassword

After execution, call the isValidCredentials command to check if the credentials are valid or not.

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.
java.lang.String	getLogonId() This method retrieves the logon ID under which the current user wishes to log on.
boolean	isValidCredentials() After this command task is executed, a boolean result flag is set to indicate if the authentication is successful.
void	setLogonId(java.lang.String strLogonId) This method sets the logon ID under which the current user wishes to logon.
void	setPassword(java.lang.String strPassword) This method sets the password to use for authentication with the new logon ID.

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

execute

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.Command

isReadyToCallExecute, reset

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

unionDependencies

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

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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.

getLogonId

java.lang.String getLogonId()

This method retrieves the logon ID under which the current user wishes to log on.

Returns:

The logon ID.

isValidCredentials

boolean isValidCredentials()

After this command task is executed, a boolean result flag is set to indicate if the authentication is successful. This method returns this result flag to indicate if the authentication is successful.

Returns:

"True", if authentication is successful.

setLogonId

void setLogonId(java.lang.String strLogonId)

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

Parameters:

strLogonId - The login ID.

setPassword

void setPassword(java.lang.String strPassword)

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

Parameters:

strPassword - The password.