com.ibm.commerce.security.commands
Interface VerifyCredentialsCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
VerifyCredentialsCmdImpl

public interface VerifyCredentialsCmd
extends TaskCommand

This command will take the input credentials and update them in either the database, LDAP, or third party system depending on how the WCS system is configured.

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

    setLogonId
    setPassword
After execution, the isValidCredentials command should be called to see whether the credentials were valid or not.

Field Summary
static java.lang.String COPYRIGHT
          Copyright field.
static java.lang.String defaultCommandClassName
          Default command implementation class.
static java.lang.String NAME
          Command name.
 
Method Summary
 java.lang.String getAuthenticateUserId()
          Retrieves the userId of the logged in user.
 java.lang.String getLogonId()
          Retrieves the logon ID under which the current user wishes to logon.
 boolean isValidCredentials()
          After the this command task is executed, a boolean result flag will be set to indicate if the authentication was successful.
 void setLogonId(java.lang.String strLogonId)
          Sets the logon ID under which the current user wishes to logon.
 void setPassword(java.lang.String strPassword)
          Sets the password to be used for authentication with the new logon ID.
 

Field Detail
public static final java.lang.String COPYRIGHT
Copyright field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
Command name.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
Default command implementation class.
See Also:
Constant Field Values
Method Detail

getAuthenticateUserId

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

getLogonId

public java.lang.String getLogonId()
Retrieves the logon ID under which the current user wishes to logon.
Returns:
The logon ID.

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.
Returns:
True if authentication was successful.

setLogonId

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

setPassword

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