Package com.bea.wli.sb.transports

Class ResponseMetaData<T extends ResponseHeaders>

java.lang.Object
com.bea.wli.sb.transports.ResponseMetaData<T>
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
DefaultResponseMetaData
public abstract class ResponseMetaData<T extends ResponseHeaders> extends Object implements Serializable
Represents inbound or outbound response message meta-data information (e.g. headers, request character set encoding, etc.) Transport Providers will provide an extension of this class that adds meta-data information applicable to the transport provider. For example, HTTP transport provider will add get/setHttpResponseCode() and other methods.
See Also:

  • Method Details

    • getCharacterEncoding

      public String getCharacterEncoding()
      Returns:
      character encoding to use for message payload

    • setCharacterEncoding

      public void setCharacterEncoding(String encoding)
      sets character encoding to use for message payload

    • getResponseCode

      public int getResponseCode()
      Returns:
      response code to indicate success/failure. See TransportManager for response code constants

    • setResponseCode

      public void setResponseCode(int code)
      Sets response code to indicate success/failure. See TransportManager for response code constants

    • getResponseMessage

      public String getResponseMessage()
      Returns:
      provider-specific response message

    • setResponseMessage

      public void setResponseMessage(String message)
      sets provider-specific response message

    • isSetResponseMessage

      public boolean isSetResponseMessage()
      Returns:
      whether or not there is a provider-specific response message in meta data

    • getHeaders

      public T getHeaders()
      Returns:
      provider-specific response headers POJO that represents transport-level headers for the message

    • setHeaders

      public void setHeaders(T headers)
      sets provider-specific response headers POJO that represents transport-level headers for the message

    • getCacheToken

      public String getCacheToken()
      Returns:
      the cache token used for this response or null

    • setCacheToken

      public void setCacheToken(String cacheToken)
      sets the cache token used for this response
      Parameters:
      cacheToken -

    • getCacheOriginated

      public Boolean getCacheOriginated()
      Returns:
      whether this response originated from the cache or not (can be null if caching is not enabled)

    • setCacheOriginated

      public void setCacheOriginated(Boolean cacheOriginated)
      sets whether this response originated from the cache or not (only set if caching enabled)
      Parameters:
      cacheOriginated -

    • toXML

      public abstract com.bea.wli.sb.transports.ResponseMetaDataXML toXML() throws TransportException
      Returns:
      XMLBean representation of this response meta data object
      Throws:
      TransportException