com.ibm.commerce.programadapter.security

Interface ProgramAdapterSessionContext

  • All Superinterfaces:
    com.ibm.commerce.adapter.SessionContext
    All Known Implementing Classes:
    DummyProgramAdapterSessionContext


    public interface ProgramAdapterSessionContext
    extends com.ibm.commerce.adapter.SessionContext
    Extention of the com.ibm.commerce.adapter.SessionContext interface for Program Adapters.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      boolean didErrorOccur()
      Indicates whether an error occured and the Program Adapter should indicate this.
      CommandProperty getCommandProperty()
      Returns the command property of the request.
      void setCommandProperty(CommandProperty propertyCommand)
      Sets the command property.
      void setConfiguration(TypedProperty config)
      Sets the configuration.
      void setRequest(java.lang.Object request)
      Sets the Request Object.
      void setResponse(java.lang.Object response)
      Sets the Response Object.
      • Methods inherited from interface com.ibm.commerce.adapter.SessionContext

        commit, getExtendedSessionData, getSessionData, getUniqueSessionTag, getValidUserId, resolveActivityToken, rollback, setExtendedSessionData, setSessionData, setUniqueSessionTag, updateActivityToken
    • Field Detail

      • COPYRIGHT

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

      • getCommandProperty

        CommandProperty getCommandProperty()
        Returns the command property of the request.
        Returns:
        The command properties of the request being processed.
      • setCommandProperty

        void setCommandProperty(CommandProperty propertyCommand)
        Sets the command property.
        Parameters:
        commandProperty - the command properties of the request.
      • setConfiguration

        void setConfiguration(TypedProperty config)
        Sets the configuration.
        Parameters:
        config - The configuration of the session context.
      • setRequest

        void setRequest(java.lang.Object request)
        Sets the Request Object.
        Parameters:
        request - the request object of the request.
      • setResponse

        void setResponse(java.lang.Object response)
        Sets the Response Object.
        Parameters:
        response - the response object of the request.
      • didErrorOccur

        boolean didErrorOccur()
        Indicates whether an error occured and the Program Adapter should indicate this. This will be called when the response is processed.
        Returns:
        Whether an error occured when creating and resolving the session context information.