com.ibm.commerce.security.commands

Class WMMAuthenticationCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.security.commands.WMMAuthenticationCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, WMMAuthenticationCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

Direct Known Subclasses:

LDAPAuthenticationCmdImpl

Deprecated.

in version 7. Use LDAPAuthenticationCmdImpl instead.

public class WMMAuthenticationCmdImpl
extends TaskCommandImpl
implements WMMAuthenticationCmd

If the system is configured to authenticate against LDAP then this task command will be called to perform the authentication.

Before executing this task command the following sets should be performed:

                setLogonId
                setPassword
 

To determine whether the authentication was successful a call should be made to isValidCredentials.

The setUpdateFlag does not change the functionality of this command.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ERRTASK_NAME Deprecated. Error task name.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

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

COPYRIGHT, defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
WMMAuthenticationCmdImpl() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthenticateUserId() Deprecated. Retrieve the logon ID under which the current user wishes to logon.
TypedProperty	getRequestProperties() Deprecated. since v6. This method has no replacement. It should not be called.
boolean	isLogonIdValid() Deprecated. Gets a boolean result flag will be set to indicate if the logon id supplied was correct.
boolean	isUpdatePending() Deprecated. Indicates whether the password should be verified against an existing one in the database or if the password should be updated in the database.
boolean	isValidCredentials() Deprecated. Gets a boolean flag indicating if the authentication was successful.
void	performExecute() Deprecated. Authenticates the user against LDAP using the logonId and password.
void	setLogonId(java.lang.String strLogonId) Deprecated. Sets the logon ID under which the current user wishes to logon.
void	setPassword(java.lang.String strPassword) Deprecated. Sets the password to be used for authentication with the new logon ID.
void	setUpdateFlag() Deprecated. This command always performs authentication, so this method is not used.
void	validateParameters() Deprecated. Validates the parameters.

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

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, 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

Deprecated.

Error task name.

See Also:

Constant Field Values

Constructor Detail

WMMAuthenticationCmdImpl

public WMMAuthenticationCmdImpl()

Deprecated.

Method Detail

getAuthenticateUserId

public java.lang.String getAuthenticateUserId()

Deprecated.

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

Specified by:

getAuthenticateUserId in interface WMMAuthenticationCmd

Returns:

The logon ID.

getRequestProperties

public TypedProperty getRequestProperties()
                                   throws ECException

Deprecated. since v6. This method has no replacement. It should not be called.

Return the request properties.

Returns:

TypedProperty The request properties.

Throws:

ECException

isLogonIdValid

public boolean isLogonIdValid()

Deprecated.

Gets a boolean result flag will be set to indicate if the logon id supplied was correct. This method will return the result flag to indicate if the authentication was successful.

Specified by:

isLogonIdValid in interface WMMAuthenticationCmd

Returns:

True if logon ID is valid.

isUpdatePending

public boolean isUpdatePending()

Deprecated.

Indicates whether the password should be verified against an existing one in the database or if the password should be updated in the database.

Returns:

True if password should be updated in the database.

isValidCredentials

public boolean isValidCredentials()

Deprecated.

Gets a boolean flag indicating if the authentication was successful. After this command task is executed, a boolean result flag will be set to indicate if the authentication was successful. This method will return the result flag to indicate if the authentication was successful.

Specified by:

isValidCredentials in interface WMMAuthenticationCmd

Returns:

True if authentication was successful.

performExecute

public void performExecute()
                    throws ECException

Deprecated.

Authenticates the user against LDAP using the logonId and password.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - ECSystemException is raised

setLogonId

public void setLogonId(java.lang.String strLogonId)

Deprecated.

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

Specified by:

setLogonId in interface WMMAuthenticationCmd

Parameters:

strLogonId - The login ID.

setPassword

public void setPassword(java.lang.String strPassword)

Deprecated.

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

Specified by:

setPassword in interface WMMAuthenticationCmd

Parameters:

strPassword - The password.

setUpdateFlag

public void setUpdateFlag()

Deprecated.

This command always performs authentication, so this method is not used.

Specified by:

setUpdateFlag in interface WMMAuthenticationCmd

validateParameters

public void validateParameters()
                        throws ECException

Deprecated.

Validates the parameters. Ensures that logonId and password are non-zero length Strings.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException