public interface AuthenticationHelperCmd extends TaskCommand
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
static java.lang.String |
defaultCommandClassName
Name of the default implementation of this command
|
static java.lang.String |
NAME
Class name
|
Modifier and Type | Method and Description |
---|---|
Credentials |
getBuyerCredentials()
This method gets the buyer credential information that stores the
buyer organizations code, code type, user ID and password.
|
long |
getBuyerId()
If the
isValidCredentials() returns true (if the
command is successful) then this method can be called to get the
buyer organization ID. |
int |
getErrorCode()
If the
isValidCredentials() returns false (if
authentication failed) then this method can be called to get the
error code. |
SessionInfo |
getSessionInfo()
This method gets the sessionInfo (information pertaining to requisitioner registration).
|
Credentials |
getSupplierCredentials()
This method gets the supplier credential information that stores the
supplier organizations code, code type, user ID and password.
|
long |
getSupplierId()
If the
isValidCredentials() returns true (if the
command succeeds) then this method can be called to get the
supplier organization ID. |
boolean |
isValidCredentials()
After the task commands are executed, a boolean result flag is
set to indicate if the authentication succeeds.
|
void |
setAuthType(int authType)
This method sets the authentication type.
|
void |
setBuyerCredentials(Credentials buyerCredentials)
This method sets the buyer credentials under which the current
B2B user wishes to logon.
|
void |
setLogonMode(short logonMode)
This method sets the logon mode.
|
void |
setMarketPlaceBuyerCredentials(Credentials mpBuyerCredentials)
Use this method if the buyer comes from a marketplace and wants to be authenticated
against the marketplace credentials.
|
void |
setProtocolId(java.lang.Integer protocolId)
This method sets the protocol ID.
|
void |
setSessionInfo(SessionInfo sessionInfo)
This method sets information pertaining to requisitioner registration.
|
void |
setSupplierCredentials(Credentials supplierCredentials)
This method sets the supplier credentials for the store that
the buyer wants to connect too.
|
void |
setUpdateFlag()
This method is called to indicate the credentials should be set in the
database, instead of performing verification on the credentials.
|
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
static final java.lang.String COPYRIGHT
static final java.lang.String NAME
static final java.lang.String defaultCommandClassName
Credentials getBuyerCredentials()
long getBuyerId()
isValidCredentials()
returns true (if the
command is successful) then this method can be called to get the
buyer organization ID.int getErrorCode()
isValidCredentials()
returns false (if
authentication failed) 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.SessionInfo getSessionInfo()
com.ibm.commerce.me.datatype
Credentials getSupplierCredentials()
long getSupplierId()
isValidCredentials()
returns true (if the
command succeeds) then this method can be called to get the
supplier organization ID.boolean isValidCredentials()
void setAuthType(int authType)
the
- authentication typevoid setBuyerCredentials(Credentials buyerCredentials)
buyerCredentials
- the buyer credentialvoid setLogonMode(short logonMode)
logonMode
- the new logon modevoid setMarketPlaceBuyerCredentials(Credentials mpBuyerCredentials)
mpBuyerCredentials
- The marketplace buyer credentials.void setProtocolId(java.lang.Integer protocolId)
aProtocolId
- the protocol IDvoid setSessionInfo(SessionInfo sessionInfo)
sessionInfo
- the session information pertaining to requisitioner
registration.com.ibm.commerce.me.datatype
void setSupplierCredentials(Credentials supplierCredentials)
supplierCredentials
- the supplier credentialvoid setUpdateFlag()