Package com.bea.wli.sb.transports

Class RequestMetaData<T extends RequestHeaders>

java.lang.Object
com.bea.wli.sb.transports.RequestMetaData<T>
Direct Known Subclasses:
DefaultRequestMetaData
public abstract class RequestMetaData<T extends RequestHeaders> extends Object
Represents inbound or outbound request 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/setQueryString(), get/setClientHost() and other methods.

  • Method Details

    • getJavaContentMap

      public Map<String,Object> getJavaContentMap()
      Returns:
      returns a map of java-content-ref-id vs object. Metadata's java-content elements will have ref-id which is mapped to the actual object that it represents in this map. This map is generally retreived by pipeline when refering java-content elements of the metadata.

    • setJavaContentMap

      public void setJavaContentMap(Map<String,Object> map)
      Passed map can be used to refer java-content element's object of the respective ref-id. It is generaly set by the pipeline.
      Parameters:
      map - ref-id vs Object map.

    • getUserMetaData

      public Map<String,String> getUserMetaData()

    • getCharacterEncoding

      public String getCharacterEncoding()
      Returns:
      character encoding used in message payload or null

    • setCharacterEncoding

      public void setCharacterEncoding(String encoding)
      sets the character encoding to use in message payload
      Parameters:
      encoding -

    • getCacheToken

      public String getCacheToken()
      Returns:
      the cache token to use for this request or null

    • setCacheToken

      public void setCacheToken(String cacheToken)
      sets the cache token to use for this request
      Parameters:
      cacheToken -

    • getCacheTTL

      public String getCacheTTL()
      Returns:
      the cache time to live to use for this request or null. This will either be an integer (representing seconds) or an XML Schema duration value.

    • setCacheTTL

      public void setCacheTTL(String cacheTTL)
      sets the cache time to live to use for this request. This will either be an integer (representing seconds) or an XML Schema duration value
      Parameters:
      cacheTTL -

    • getHeaders

      public T getHeaders()
      Returns:
      provider-specific request headers POJO that represent the headers for request message

    • setHeaders

      public void setHeaders(T headers)
      sets provider-specific request headers POJO that represent the headers for request message

    • toXML

      public abstract com.bea.wli.sb.transports.RequestMetaDataXML toXML() throws TransportException
      Returns:
      XMLBean representation of meta data for this request message
      Throws:
      TransportException