com.ibm.commerce.security.commands
Interface AuthenticationPolicyCmd

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

public interface AuthenticationPolicyCmd
extends TaskCommand

This task command is called by every command that performs verification or update of a user credentials. Therefore this command can be used to enforce policies such as minimum password length.

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

		setLogonId
		setPassword
 


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 boolean isPasswordCompliant()
          After this command task is executed, a boolean result flag will be set to indicate if the password complies with the password policy defined for this user.
 void setAccountPolicy(java.lang.String strDefinedAccountPolicy)
          Sets the account policy to be used to check this password.
 void setErrorTask(java.lang.String strErrorTask)
          This function allows for the default error view task of the command to be overwritten.
 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.
 
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

isPasswordCompliant

public boolean isPasswordCompliant()
After this command task is executed, a boolean result flag will be set to indicate if the password complies with the password policy defined for this user. This function returns a boolean flag to indicate if the password complies with the policy.
Returns:
True if authentication was successful.

setAccountPolicy

public void setAccountPolicy(java.lang.String strDefinedAccountPolicy)
Sets the account policy to be used to check this password. This overrides the default account policy for the user.
Parameters:
strDefinedAccountPolicy - The account policy.

setErrorTask

public void setErrorTask(java.lang.String strErrorTask)
This function allows for the default error view task of the command to be overwritten.
Parameters:
strErrorTask - The name of the new error view task.

setLogonId

public void setLogonId(java.lang.String strLogonId)
Sets the logon ID under which the current user wishes to logon.
Parameters:
strLogonID - The login ID.

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.