com.ibm.commerce.security.commands
Interface LDAPAuthenticationCmd

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

public interface LDAPAuthenticationCmd
extends TaskCommand

If the server is configured to authenticate against LDAP, then this task command is called to perform authentication and sychronization.

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

 		setCommandContext
		setLogonId
		setPassword
 
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
 java.lang.String getAuthenticateUserId()
          Gets the user id of the user after the authentication was successful.
 boolean isLogonIdValid()
          A boolean result flag will be set to indicate if the logon id supplied was correct.
 boolean isValidCredentials()
          After its execution, this task command sets a boolean flag to indicate whether 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.
 void setUpdateFlag()
          This method is called to indicate that instead of performing verification of the credentials, the credentials should be set on LDAP.
 
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

getAuthenticateUserId

public java.lang.String getAuthenticateUserId()
Gets the user id of the user after the authentication was successful. If the authentication was not successful, the method returns null.
Returns:
The user id.

isLogonIdValid

public boolean isLogonIdValid()
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.
Returns:
True if LogonId is valid.

isValidCredentials

public boolean isValidCredentials()
After its execution, this task command sets a boolean flag to indicate whether the authentication was successful. This method will return 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.
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.

setUpdateFlag

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