VerifyCredentialsCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.TaskCommandImpl
    - - com.ibm.commerce.security.commands.VerifyCredentialsCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, VerifyCredentialsCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
```
public class VerifyCredentialsCmdImpl
extends TaskCommandImpl
implements VerifyCredentialsCmd
```
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.
Error View Task: VerifyCredentialsErrorView

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ERRTASK_NAME
Error task name.

protected java.lang.String istrAuthenticateUserId
userId for authenticated user.
- Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
  commandContext
- Fields inherited from interface com.ibm.commerce.security.commands.VerifyCredentialsCmd
  defaultCommandClassName, NAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ERRTASK_NAME` Error task name.
`protected java.lang.String`	`istrAuthenticateUserId` userId for authenticated user.

Constructor Summary

Constructors
Constructor and Description

VerifyCredentialsCmdImpl()

Constructors
Constructor and Description
`VerifyCredentialsCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`authenticationByDB()` This method authenticate current user through DB
`java.lang.String`	`getAuthenticateUserId()` This method retrieves the user ID of the logged in user.
`protected java.lang.String`	`getEncipheredMerchantKey()` This method retrieves the enciphered merchant key to use in the authentication process.
`java.lang.String`	`getLogonId()` This method retrieves the logon ID under which the current user wishes to logon.
`protected java.lang.String`	`getPassword()` This method retrieves the password to use for authentication with the new logon ID.
`boolean`	`isValidCredentials()` After the this command task is executed, a boolean result flag will be set to indicate if the authentication was successful.
`void`	`performExecute()` This method executes the command through updating the credentials in either LDAP, the database, or a third-party authentication repository.
`protected void`	`resetPasswordGuest()` Calls ResetPasswordGuestCmd to reset password for a guest shopper.
`protected boolean`	`resetPasswordRequired(java.lang.String astrLogonId)` Checks if it requires to reset password.
`void`	`setLogonId(java.lang.String strLogonId)` This method sets the logon ID.
`void`	`setPassword(java.lang.String strPassword)` This method sets the password.
`protected void`	`throwPasswordResetException()` This method always throws an ECApplicationException with an error code 2430.
`void`	`validateParameters()` This method validates the parameters through ensuring that the logon ID and password parameters are non-zero length strings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, 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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

- Field Detail
  - ERRTASK_NAME
```
public static final java.lang.String ERRTASK_NAME
```
    Error task name.
    
    See Also:
    
    Constant Field Values
  - istrAuthenticateUserId
```
protected java.lang.String istrAuthenticateUserId
```
    userId for authenticated user.
- Constructor Detail
  - VerifyCredentialsCmdImpl
```
public VerifyCredentialsCmdImpl()
```
- Method Detail
  - getAuthenticateUserId
```
public java.lang.String getAuthenticateUserId()
```
    This method retrieves the user ID of the logged in user.
    
    Specified by:
    
    getAuthenticateUserId in interface VerifyCredentialsCmd
    
    Returns:
    
    The userId.
  - getEncipheredMerchantKey
```
protected java.lang.String getEncipheredMerchantKey()
```
    This method retrieves the enciphered merchant key to use in the authentication process.
    
    Returns:
    
    The enciphered merchant key.
  - getLogonId
```
public java.lang.String getLogonId()
```
    This method retrieves the logon ID under which the current user wishes to logon.
    
    Specified by:
    
    getLogonId in interface VerifyCredentialsCmd
    
    Returns:
    
    The logon ID.
  - getPassword
```
protected java.lang.String getPassword()
```
    This method retrieves the password to use for authentication with the new logon ID.
    
    Returns:
    
    The password.
  - isValidCredentials
```
public boolean isValidCredentials()
```
    After the this command task is executed, a boolean result flag will be set to indicate if the authentication was successful. This method returns this result flag to indicate if the authentication was successful.
    
    Specified by:
    
    isValidCredentials in interface VerifyCredentialsCmd
    
    Returns:
    
    True if authentication was successful.
  - performExecute
```
public void performExecute()
                    throws ECException
```
    This method executes the command through updating the credentials in either LDAP, the database, or a third-party authentication repository. Credentials are updated depending on the configuration of the WebSphere Commerce server.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
  - setLogonId
```
public void setLogonId(java.lang.String strLogonId)
```
    This method sets the logon ID.
    
    Specified by:
    
    setLogonId in interface VerifyCredentialsCmd
    
    Parameters:
    
    strLogonId - The new value for the logonID parameter.
  - setPassword
```
public void setPassword(java.lang.String strPassword)
```
    This method sets the password.
    
    Specified by:
    
    setPassword in interface VerifyCredentialsCmd
    
    Parameters:
    
    strPassword - The new value for the password parameter.
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    This method validates the parameters through ensuring that the logon ID and password parameters are non-zero length strings.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AbstractECTargetableCommand
    
    Throws:
    
    ECException
  - resetPasswordGuest
```
protected void resetPasswordGuest()
                           throws ECException
```
    Calls ResetPasswordGuestCmd to reset password for a guest shopper.
    
    Throws:
    
    ECException
  - resetPasswordRequired
```
protected boolean resetPasswordRequired(java.lang.String astrLogonId)
```
    Checks if it requires to reset password. It first checks if the reset password flag is enabled in the instance configuration file. It then checks if the password for the logon ID is null in the database. If both checks are true, it returns true. Otherwise, it returns false.
    
    Parameters:
    
    astrLogonId - a logon ID
    
    Returns:
    
    true if it requires to reset password.
  - throwPasswordResetException
```
protected void throwPasswordResetException()
                                    throws ECApplicationException
```
    This method always throws an ECApplicationException with an error code 2430.
    
    Throws:
    
    ECApplicationException - it always throws an ECApplicationException.
  - authenticationByDB
```
protected void authenticationByDB()
                           throws ECException
```
    This method authenticate current user through DB
    
    Throws:
    
    ECException

Class VerifyCredentialsCmdImpl

Field Summary

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Fields inherited from interface com.ibm.commerce.security.commands.VerifyCredentialsCmd

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

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

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

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

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

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

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

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

Field Detail

ERRTASK_NAME

istrAuthenticateUserId

Constructor Detail

VerifyCredentialsCmdImpl

Method Detail

getAuthenticateUserId

getEncipheredMerchantKey

getLogonId

getPassword

isValidCredentials

performExecute

setLogonId

setPassword

validateParameters

resetPasswordGuest

resetPasswordRequired

throwPasswordResetException

authenticationByDB