com.ibm.commerce.me.commands

Interface AuthenticationHelperCmd

  • 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
    All Known Implementing Classes:
    AuthenticationHelperCmdImpl


    public interface AuthenticationHelperCmd
    extends TaskCommand
    Invoked by the Business Direct command to authenticate a Business Direct buyer.
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        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

      • getBuyerCredentials

        Credentials getBuyerCredentials()
        This method gets the buyer credential information that stores the buyer organizations code, code type, user ID and password.
        Returns:
        the buyer credential information
      • getBuyerId

        long getBuyerId()
        If the isValidCredentials() returns true (if the command is successful) then this method can be called to get the buyer organization ID.
        Returns:
        The ID of the buyer organization.
      • getErrorCode

        int getErrorCode()
        If the 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.
        Returns:
        A code indicating the error status.
      • getSessionInfo

        SessionInfo getSessionInfo()
        This method gets the sessionInfo (information pertaining to requisitioner registration).
        Returns:
        the session information
        See Also:
        com.ibm.commerce.me.datatype
      • getSupplierCredentials

        Credentials getSupplierCredentials()
        This method gets the supplier credential information that stores the supplier organizations code, code type, user ID and password.
        Returns:
        The supplier credential information.
      • getSupplierId

        long getSupplierId()
        If the isValidCredentials() returns true (if the command succeeds) then this method can be called to get the supplier organization ID.
        Returns:
        The ID of the supplier organization.
      • isValidCredentials

        boolean isValidCredentials()
        After the task commands are executed, a boolean result flag is set to indicate if the authentication succeeds. This method returns the result flag to indicate if authentication succeeds.
        Returns:
        true if authentication succeeds, otherwise false
      • setAuthType

        void setAuthType(int authType)
        This method sets the authentication type.
        Parameters:
        the - authentication type
      • setBuyerCredentials

        void setBuyerCredentials(Credentials buyerCredentials)
        This method sets the buyer credentials under which the current B2B user wishes to logon.
        Parameters:
        buyerCredentials - the buyer credential
      • setLogonMode

        void setLogonMode(short logonMode)
        This method sets the logon mode.
        Parameters:
        logonMode - the new logon mode
      • 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:
        mpBuyerCredentials - The marketplace buyer credentials.
      • setProtocolId

        void setProtocolId(java.lang.Integer protocolId)
        This method sets the protocol ID.
        Parameters:
        aProtocolId - the protocol ID
      • setSessionInfo

        void setSessionInfo(SessionInfo sessionInfo)
        This method sets information pertaining to requisitioner registration.
        Parameters:
        sessionInfo - the session information pertaining to requisitioner registration.
        See Also:
        com.ibm.commerce.me.datatype
      • setSupplierCredentials

        void setSupplierCredentials(Credentials supplierCredentials)
        This method sets the supplier credentials for the store that the buyer wants to connect too.
        Parameters:
        supplierCredentials - the supplier credential
      • setUpdateFlag

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