com.ibm.commerce.me.commands
Interface LdapAuthenticationCmd

All Superinterfaces:
TaskCommand

public interface LdapAuthenticationCmd
extends TaskCommand

When a requisitioner (a user of the B2B buyer org) logs on to the supplier system, if server is configured to authenticate against the LDAP, then this task command will be called to perform either authentication or an update.

Before executing this task command the following set ops should be performed:

    setAuthenticationLevel
    setBuyerCredentials
    setMarketPlaceBuyerCredentials
    setSupplierCredentilas
    setMerchantKey
    setUpdateFlag

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

If the setUpdateFlag is not called then, upon execution of this task command, verification of the credentials is performed. To determine whether the authentication was successful a call should be made to isValidCredentials(). Creation date: (2/27/01 5:17:51 PM)


Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright field
static java.lang.String defaultCommandClassName
          Name of the default implementation of this command
static java.lang.String NAME
          class name
 
Method Summary
 int getErrorCode()
          If the isValidCredentilas() returns false (ie.
 boolean isValidCredentials()
          After the this command task is executed, a boolean result flag will be set to indicate if the authentication was successful.
 void setAuthenticationLevel(int authenticationLevel)
          Sets the authentication level (See B2BLogonCmd for details about against which credentials the buyer and supplier are validated.)
 void setBuyerCredentials( Credentials buyerCredentials)
          Sets the buyer credentials under which the current B2B user wishes to logon.
 void setMarketPlaceBuyerCredentials( Credentials mpBuyerCredentials)
          In case the buyer comes from a marketplace and wants to be authenticated against the marketplace credentials, use this method.
 void setMerchantKey(java.lang.String strMerchantKey)
          Sets the Merchant Key to be used in the encryption of the password.
 void setSupplierCredentilas( Credentials supplierCredentials)
          Sets the supplier credentials for the store to which the buyer want to connect.
 void setUpdateFlag()           This method is called to indicate instead of performing verification of the credentials, the credentials should be set in the database.
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright field
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
class name
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
Name of the default implementation of this command
See Also:
Constant Field Values
Method Detail

getErrorCode

public int getErrorCode()
If the isValidCredentilas() returns false (ie. if authentication failed) then this method can be called to get the error code. This is required because in the B2B scenario we need to know what is the exact reason for which athentication failed.
Returns:
a code indicating the error status

isValidCredentials

public boolean isValidCredentials()
After the this command task is executed, a boolean result flag will be set to 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.

setAuthenticationLevel

public void setAuthenticationLevel(int authenticationLevel)
Sets the authentication level (See B2BLogonCmd for details about against which credentials the buyer and supplier are validated.)
Parameters:
authenticationLevel - the new authentication level

setBuyerCredentials

public void setBuyerCredentials(Credentials buyerCredentials)
Sets the buyer credentials under which the current B2B user wishes to logon.
Parameters:
buyerCredentials - the new buyer credential information

setMarketPlaceBuyerCredentials

public void setMarketPlaceBuyerCredentials(Credentials mpBuyerCredentials)
In case the buyer comes from a marketplace and wants to be authenticated against the marketplace credentials, use this method. This methode will set the marketplace buyer credentials under which the current B2B user wishes to logon.
Parameters:
mpBuyerCredentials - the marketspace buyer credential

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.

setSupplierCredentilas

public void setSupplierCredentilas(Credentials supplierCredentials)
Sets the supplier credentials for the store to which the buyer want to connect.
Parameters:
supplierCredentials - the supplier credential information

setUpdateFlag

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