ThirdPartyB2BAuthCmd

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
```
public interface ThirdPartyB2BAuthCmd
extends TaskCommand
```
A requisitioner is a user of a B2B buyer organization. When a requisitioner logs on the supplier system, this task command will be called to perform either authentication or an update. This only occurs if the server is configured to authenticate against a third party system.

Before executing this task command the following setter methods should be called:
```
                setBuyerCredentials
                setMarketPlaceBuyerCredentials
                setSupplierCredentilas
                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 3:35:09 PM)

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` copyright notice
`static java.lang.String`	`defaultCommandClassName` name of the default implementation of this command
`static java.lang.String`	`NAME` name of this command

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

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getErrorCode()` If `isValidCredentials()` returns false (for example, the command fails) then this method can be called to get the error code.
`boolean`	`isValidCredentials()` After the this command task is executed, a boolean result flag is set to indicate if authentication succeeds.
`void`	`setBuyerCredentials(Credentials buyerCredentials)` This method sets the buyer credentials under which the current B2B user wishes to logon.
`void`	`setMarketPlaceBuyerCredentials(Credentials mpBuyerCredentials)` Use this method if the buyer comes from a marketplace and wants to be authenticated against the marketplace credentials.
`void`	`setSupplierCredentilas(Credentials supplierCredentials)` This method sets the supplier credentials for the store that the buyer wants to connect.
`void`	`setUpdateFlag()` This method is called to indicate the credentials should be set in the database instead of verified.

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
```
    copyright notice
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final java.lang.String NAME
```
    name of this command
    
    See Also:
    
    Constant Field Values
  - defaultCommandClassName
```
static final java.lang.String defaultCommandClassName
```
    name of the default implementation of this command
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getErrorCode
```
int getErrorCode()
```
    If isValidCredentials() returns false (for example, the command fails) then this method can be called to get the error code. This is required as the B2B scenario needs to know the exact reason for each authentication failure.
    
    Returns:
    
    True if authentication was successful.
  - isValidCredentials
```
boolean isValidCredentials()
```
    After the this command task is executed, a boolean result flag is set to indicate if authentication succeeds. This method will return the this result flag to indicate the authentication status
    
    Returns:
    
    True if authentication succeeds.
  - setBuyerCredentials
```
void setBuyerCredentials(Credentials buyerCredentials)
```
    This method sets the buyer credentials under which the current B2B user wishes to logon.
    
    Parameters:
    
    com.ibm.commerce.b2b.member.objects.Credentials - buyerCredentials.
  - setMarketPlaceBuyerCredentials
```
void setMarketPlaceBuyerCredentials(Credentials mpBuyerCredentials)
```
    Use this method if the buyer comes from a marketplace and wants to be authenticated against the marketplace credentials. This method will set the marketplace buyer credentials under which the current B2B user wishes to logon.
    
    Parameters:
    
    com.ibm.commerce.b2b.member.objects.Credentials - marketPlaceBuyerCredentials.
  - setSupplierCredentilas
```
void setSupplierCredentilas(Credentials supplierCredentials)
```
    This method sets the supplier credentials for the store that the buyer wants to connect.
    
    Parameters:
    
    com.ibm.commerce.b2b.member.objects.Credentials - supplierCredentials.
  - setUpdateFlag
```
void setUpdateFlag()
```
    This method is called to indicate the credentials should be set in the database instead of verified.

Interface ThirdPartyB2BAuthCmd

Field Summary

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

Method Summary

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

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

Methods inherited from interface com.ibm.websphere.command.CommandCaller

Methods inherited from interface com.ibm.commerce.command.ECCommand

Field Detail

COPYRIGHT

NAME

defaultCommandClassName

Method Detail

getErrorCode

isValidCredentials

setBuyerCredentials

setMarketPlaceBuyerCredentials

setSupplierCredentilas

setUpdateFlag