com.ibm.commerce.security.commands
Interface DBAuthenticationCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
DBAuthenticationCmdImpl

public interface DBAuthenticationCmd
extends TaskCommand

If the server is configured to authenticate against the database, this task command will be called to perform either authentication or an update.

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

 		setEnciphereMerchantKey or setMerchantKey
		setLogonId
		setPassword
 

If the setUpdateFlag is called, then upon execution of this task command, the credentials set are updated in the database.

If the setUpdateFlag is not called, upon execution of this task command, verification of the credentials is performed. To determine whether the authentication was successful, call isValidCredentials.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 boolean isValidCredentials()
          Sets a boolean result flag indicate if the authentication was successful.
 void markPasswordAsTemporary()
          Call this method to indicate that the updated password is temporary.
 void setEncipheredMerchantKey(java.lang.String strEncipheredMerchantKey)
          Sets the enciphered merchant key to be used in the encryption of the password.
 void setLogonId(java.lang.String strLogonId)
          Sets the logon ID under which the current user wishes to logon.
 void setMerchantKey(java.lang.String strMerchantKey)
          Sets the merchant key to be used in the encryption of the password.
 void setPassword(java.lang.String strPassword)
          Sets the password to be used for authentication with the new logon ID.
 void setUpdateFlag()
          This method is called to indicate that instead of performing verification of the credentials, the credentials should be set in the database.
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

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

isValidCredentials

public boolean isValidCredentials()
Sets a boolean result flag indicate if the authentication was successful. This method will return the this result flag to indicate if the authentication was successful.
Returns:
True if authentication was successful.

markPasswordAsTemporary

public void markPasswordAsTemporary()
Call this method to indicate that the updated password is temporary.

setEncipheredMerchantKey

public void setEncipheredMerchantKey(java.lang.String strEncipheredMerchantKey)
Sets the enciphered merchant key to be used in the encryption of the password. This command task will implicitly decrypt the enciphered merchant key. This should only be set if the merchant key was not set.
Parameters:
strEncipheredMerchantKey - The enciphered merchant key.

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.

setMerchantKey

public void setMerchantKey(java.lang.String strMerchantKey)
Sets the merchant key to be used in the encryption of the password. This should only be set if an enciphered merchant key was not set.
Parameters:
strMerchantKey - The merchant key.

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.

setUpdateFlag

public void setUpdateFlag()
This method is called to indicate that instead of performing verification of the credentials, the credentials should be set in the database.