org.apache.cxf.message

## Class MessageImpl

- java.lang.Object
- - java.util.AbstractMap<K,V>
  - - java.util.HashMap<String,Object>
    - - org.apache.cxf.message.StringMapImpl
      - - org.apache.cxf.message.MessageImpl

- All Implemented Interfaces:
    Serializable, Cloneable, Map<String,Object>, Message, StringMap

      public class MessageImpl
      extends StringMapImpl
      implements Message

  See Also:
    Serialized Form

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class java.util.AbstractMap

      `AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>`

    - ### Nested classes/interfaces inherited from interface java.util.Map

      `Map.Entry<K,V>`

  - ### Field Summary

    - ### Fields inherited from interface org.apache.cxf.message.Message

      `ACCEPT_CONTENT_TYPE, ASYNC_POST_RESPONSE_DISPATCH, ATTACHMENTS, BASE_PATH, CONNECTION_TIMEOUT, CONTENT_TYPE, DECOUPLED_CHANNEL_MESSAGE, EMPTY_PARTIAL_RESPONSE_MESSAGE, ENCODING, ENDPOINT_ADDRESS, EXCEPTION_CAUSE_SUFFIX, EXCEPTION_MESSAGE_CAUSE_ENABLED, FAULT_IN_INTERCEPTORS, FAULT_OUT_INTERCEPTORS, FAULT_STACKTRACE_ENABLED, FIXED_PARAMETER_ORDER, HTTP_REQUEST_METHOD, IN_INTERCEPTORS, INBOUND_MESSAGE, INTERCEPTOR_PROVIDERS, INVOCATION_CONTEXT, MAINTAIN_SESSION, MIME_HEADERS, MTOM_ENABLED, MTOM_THRESHOLD, ONE_WAY_REQUEST, OUT_INTERCEPTORS, PARTIAL_RESPONSE_MESSAGE, PATH_INFO, PROCESS_ONEWAY_REPONSE, PROCESS_ONEWAY_RESPONSE, PROPOGATE_EXCEPTION, PROTOCOL_HEADERS, QUERY_STRING, RECEIVE_TIMEOUT, REQUEST_URI, REQUEST_URL, REQUESTOR_ROLE, RESPONSE_CODE, REST_MESSAGE, ROBUST_ONEWAY, SCHEMA_VALIDATION_ENABLED, SUSPENDED_INVOCATION, TRANSPORT, WSDL_DESCRIPTION, WSDL_INTERFACE, WSDL_OPERATION, WSDL_PORT, WSDL_SERVICE`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `MessageImpl()`
    `MessageImpl(Message m)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static void` | `copyContent(Message m1, Message m2)`
    `String` | `getAttachmentMimeType()`
    `Collection<Attachment>` | `getAttachments()` Retrieve any binary attachments associated with the message.
    `<T> T` | `getContent(Class<T> format)` Retrieve the encapsulated content as a particular type.
    `Set<Class<?>>` | `getContentFormats()`
    `Object` | `getContextualProperty(String key)` Queries the Message object's metadata for a specific property.
    `Destination` | `getDestination()`
    `Exchange` | `getExchange()`
    `String` | `getId()`
    `InterceptorChain` | `getInterceptorChain()` Returns a live copy of the messages interceptor chain.
    `Object` | `put(String key, Object value)`
    `<T> void` | `removeContent(Class<T> format)` Removes a content from a message.
    `void` | `resetContextCache()`
    `void` | `setAttachments(Collection<Attachment> attachments)`
    `<T> void` | `setContent(Class<T> format, Object content)` Provide the encapsulated content as a particular type (a result type if message is outbound, a source type if message is inbound)
    `void` | `setContextualProperty(String key, Object v)`
    `void` | `setDestination(Destination d)`
    `void` | `setExchange(Exchange e)`
    `void` | `setId(String i)`
    `void` | `setInterceptorChain(InterceptorChain ic)`

    - ### Methods inherited from class org.apache.cxf.message.StringMapImpl

      `get, put`

    - ### Methods inherited from class java.util.HashMap

      `clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, putAll, remove, size, values`

    - ### Methods inherited from class java.util.AbstractMap

      `equals, hashCode, toString`

    - ### Methods inherited from class java.lang.Object

      `finalize, getClass, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface org.apache.cxf.message.StringMap

      `get, put`

    - ### Methods inherited from interface java.util.Map

      `clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putAll, remove, size, values`

- - ### Constructor Detail

    - #### MessageImpl

          public MessageImpl()

    - #### MessageImpl

          public MessageImpl(Message m)

  - ### Method Detail

    - #### getAttachments

          public Collection<Attachment> getAttachments()

      Description copied from interface: `Message`
      Retrieve any binary attachments associated with the message.
      Specified by:
        `getAttachments` in interface `Message`
      Returns:
        a collection containing the attachments

    - #### setAttachments

          public void setAttachments(Collection<Attachment> attachments)

      Specified by:
        `setAttachments` in interface `Message`

    - #### getAttachmentMimeType

          public String getAttachmentMimeType()

    - #### getDestination

          public Destination getDestination()

      Specified by:
        `getDestination` in interface `Message`
      Returns:
        the associated Destination if message is inbound, null otherwise

    - #### getExchange

          public Exchange getExchange()

      Specified by:
        `getExchange` in interface `Message`

    - #### getId

          public String getId()

      Specified by:
        `getId` in interface `Message`

    - #### getInterceptorChain

          public InterceptorChain getInterceptorChain()

      Description copied from interface: `Message`
      Returns a live copy of the messages interceptor chain. This is useful when an interceptor wants to modify the interceptor chain on the fly.
      Specified by:
        `getInterceptorChain` in interface `Message`
      Returns:
        the interceptor chain used to process the message

    - #### getContent

          public <T> T getContent(Class<T> format)

      Description copied from interface: `Message`
      Retrieve the encapsulated content as a particular type. The content is available as a result type if the message is outbound. The content is available as a source type if message is inbound. If the content is not available as the specified type null is returned.
      Specified by:
        `getContent` in interface `Message`
      Parameters:
        `format` - the expected content format
      Returns:
        the encapsulated content

    - #### setContent

          public <T> void setContent(Class<T> format,
                            Object content)

      Description copied from interface: `Message`
      Provide the encapsulated content as a particular type (a result type if message is outbound, a source type if message is inbound)
      Specified by:
        `setContent` in interface `Message`
      Parameters:
        `format` - the provided content format
        `content` - the content to be encapsulated

    - #### removeContent

          public <T> void removeContent(Class<T> format)

      Description copied from interface: `Message`
      Removes a content from a message. If some contents are completely consumed, removing them is a good idea
      Specified by:
        `removeContent` in interface `Message`
      Parameters:
        `format` - the format to remove

    - #### getContentFormats

          public Set<Class<?>> getContentFormats()

      Specified by:
        `getContentFormats` in interface `Message`
      Returns:
        the set of currently encapsulated content formats

    - #### setDestination

          public void setDestination(Destination d)

    - #### setExchange

          public void setExchange(Exchange e)

      Specified by:
        `setExchange` in interface `Message`

    - #### setId

          public void setId(String i)

      Specified by:
        `setId` in interface `Message`

    - #### setInterceptorChain

          public void setInterceptorChain(InterceptorChain ic)

      Specified by:
        `setInterceptorChain` in interface `Message`

    - #### put

          public Object put(String key,
                   Object value)

      Specified by:
        `put` in interface `Map<String,Object>`
      Overrides:
        `put` in class `HashMap<String,Object>`

    - #### getContextualProperty

          public Object getContextualProperty(String key)

      Description copied from interface: `Message`
      Queries the Message object's metadata for a specific property.
      Specified by:
        `getContextualProperty` in interface `Message`
      Parameters:
        `key` - the Message interface's property strings that correlates to the desired property
      Returns:
        the property's value

    - #### copyContent

          public static void copyContent(Message m1,
                         Message m2)

    - #### resetContextCache

          public void resetContextCache()

      Specified by:
        `resetContextCache` in interface `Message`

    - #### setContextualProperty

          public void setContextualProperty(String key,
                                   Object v)

      Specified by:
        `setContextualProperty` in interface `Message`

Apache CXF