com.ibm.commerce.context.audit

Class TransportData

  • java.lang.Object
    • com.ibm.commerce.context.audit.TransportData
  • All Implemented Interfaces:
    java.io.Serializable


    public class TransportData
    extends java.lang.Object
    implements java.io.Serializable
    This class defines the signature of an object that contains the information to represent the channel that is making the request. This information pertains to the attributes that the audit context is expecting in the session data of the pre-invoke method. It gives unique information about the requestor.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      TransportData()
      This is the default constructor for this class.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getActionRequest()
      This method gets the request of the action.
      java.lang.String getClientReferral()
      This method gets the referral application that referred the client to make the request on the current server.
      java.lang.String getClientSessionIdentifier()
      This method gets the session identifier associated with the client that is making the request.
      java.lang.String getLocalAddress()
      This method gets the local address of the server handling the request.
      java.lang.String getRemoteAddress()
      This method gets the remote address of the channel making the request.
      java.lang.String getRemoteAgent()
      This method gets the remote agent of the channel making the request.
      java.lang.String getRemoteHost()
      This method gets the remote address of the channel making the request.
      java.lang.String getRequestMethod()
      This method gets the request method of the request.
      java.lang.Boolean getSecureRequest()
      This method gets whether the request is made under a secure channel or a non-secure channel.
      java.lang.String getTransportIdentifier()
      This method gets the transport identifier of the request.
      void setActionRequest(java.lang.String actionRequest)
      This method sets the action request token for the request
      void setClientReferral(java.lang.String clientReferral)
      This method sets the client referral.
      void setClientSessionIdentifier(java.lang.String clientSessionId)
      This method sets the client session identifier.
      void setLocalAddress(java.lang.String localAddress)
      This method sets the local address.
      void setRemoteAddress(java.lang.String remoteAddress)
      This method sets the remote address.
      void setRemoteAgent(java.lang.String remoteAgent)
      This method sets the remote agent.
      void setRemoteHost(java.lang.String remoteHost)
      This method sets the remote host.
      void setRequestMethod(java.lang.String requestMethod)
      This method sets the request method.
      void setSecureRequest(java.lang.Boolean secureRequest)
      This method sets whether the channel is secure or not.
      void setTransportIdentifier(java.lang.String transportIdentifier)
      This method sets the transport identifier.
      java.lang.String toString()
      This method gets the string representation of the object.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • TransportData

        public TransportData()
        This is the default constructor for this class. It calls the constructor from the superclass.
    • Method Detail

      • getTransportIdentifier

        public java.lang.String getTransportIdentifier()
        This method gets the transport identifier of the request.
        Returns:
        This method returns the transport identifier.
      • setTransportIdentifier

        public void setTransportIdentifier(java.lang.String transportIdentifier)
        This method sets the transport identifier.
        Parameters:
        transportIdentifier - This is the transport identifier.
      • getRemoteAddress

        public java.lang.String getRemoteAddress()
        This method gets the remote address of the channel making the request.
        Returns:
        This method returns the remote address.
      • getRemoteHost

        public java.lang.String getRemoteHost()
        This method gets the remote address of the channel making the request.
        Returns:
        This method returns the remote address.
      • getRemoteAgent

        public java.lang.String getRemoteAgent()
        This method gets the remote agent of the channel making the request.
        Returns:
        This method returns the remote agent.
      • getClientSessionIdentifier

        public java.lang.String getClientSessionIdentifier()
        This method gets the session identifier associated with the client that is making the request.
        Returns:
        This method returns the client session identifier.
      • getClientReferral

        public java.lang.String getClientReferral()
        This method gets the referral application that referred the client to make the request on the current server.
        Returns:
        This method returns the referral string to represent the referral application.
      • getLocalAddress

        public java.lang.String getLocalAddress()
        This method gets the local address of the server handling the request.
        Returns:
        This method returns the local address.
      • getRequestMethod

        public java.lang.String getRequestMethod()
        This method gets the request method of the request.
        Returns:
        This method returns the request method.
      • getSecureRequest

        public java.lang.Boolean getSecureRequest()
        This method gets whether the request is made under a secure channel or a non-secure channel.
        Returns:
        This method returns whether the channel is secure.
      • setClientReferral

        public void setClientReferral(java.lang.String clientReferral)
        This method sets the client referral.
        Parameters:
        clientReferral - This is the client referral.
      • setClientSessionIdentifier

        public void setClientSessionIdentifier(java.lang.String clientSessionId)
        This method sets the client session identifier.
        Parameters:
        clientSessionId - This is the client session identifier.
      • setLocalAddress

        public void setLocalAddress(java.lang.String localAddress)
        This method sets the local address.
        Parameters:
        localAddress - This is the local address.
      • setRemoteAddress

        public void setRemoteAddress(java.lang.String remoteAddress)
        This method sets the remote address.
        Parameters:
        remoteAddress - This is the remote address.
      • setRemoteAgent

        public void setRemoteAgent(java.lang.String remoteAgent)
        This method sets the remote agent.
        Parameters:
        remoteAgent - This is the remote agent.
      • setRemoteHost

        public void setRemoteHost(java.lang.String remoteHost)
        This method sets the remote host.
        Parameters:
        remoteHost - This is the remote host.
      • setRequestMethod

        public void setRequestMethod(java.lang.String requestMethod)
        This method sets the request method.
        Parameters:
        requestMethod - This is the request method.
      • setSecureRequest

        public void setSecureRequest(java.lang.Boolean secureRequest)
        This method sets whether the channel is secure or not.
        Parameters:
        secureRequest - This is a boolean value; true if the channel is secure and false otherwise.
      • getActionRequest

        public java.lang.String getActionRequest()
        This method gets the request of the action.
        Returns:
        This method returns the request of the action.
      • setActionRequest

        public void setActionRequest(java.lang.String actionRequest)
        This method sets the action request token for the request
        Parameters:
        actionRequest - This is the request action.
      • toString

        public java.lang.String toString()
        This method gets the string representation of the object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        This method returns the string version of the object for tracing purposes.