com.ibm.commerce.security.commands

Interface DBAuthenticationCmd

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:

DBAuthenticationCmdImpl

public interface DBAuthenticationCmd
extends TaskCommand

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

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

                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

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
boolean	isValidCredentials() Sets a boolean result flag to 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) Deprecated. Retrieve the merchantkey by first calling ConfigProperties.singleton().getMerchantKey() and then call setMerchantKey(String) to set the merchant key to be used by the command.
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.
void	setUpdateFlag() Call this method 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.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

isValidCredentials

boolean isValidCredentials()

Sets a boolean result flag 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.

markPasswordAsTemporary

void markPasswordAsTemporary()

Call this method to indicate that the updated password is temporary.

setEncipheredMerchantKey

void setEncipheredMerchantKey(java.lang.String strEncipheredMerchantKey)

Deprecated. Retrieve the merchantkey by first calling ConfigProperties.singleton().getMerchantKey() and then call setMerchantKey(String) to set the merchant key to be used by the command.

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 key should only be set if the merchant key was not set.

Parameters:

strEncipheredMerchantKey - The enciphered merchant key.

setLogonId

void setLogonId(java.lang.String strLogonId)

Sets the logon ID under which the current user wishes to logon.

Parameters:

strLogonID - The logon ID.

setPassword

void setPassword(java.lang.String strPassword)

Sets the password to be used for authentication with the new logon ID.

Parameters:

strPassword - The password.

setUpdateFlag

void setUpdateFlag()

Call this method to indicate that instead of performing verification of the credentials, the credentials should be set in the database.