org.apache.servicemix.soap.api

Interface Message

All Superinterfaces:

java.util.Map<java.lang.String,java.lang.Object>

All Known Implementing Classes:

MessageImpl

public interface Message
extends java.util.Map<java.lang.String,java.lang.Object>

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_TYPE
static java.lang.String	REQUEST_MESSAGE

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	get(java.lang.Class<T> key) Convenience method for storing/retrieving typed objects from the map.
java.util.Map<java.lang.String,javax.activation.DataHandler>	getAttachments() Acces to attachments
<T> T	getContent(java.lang.Class<T> format) Retreive the encapsulated content as a particular type (a result type if message is outbound, a source type if message is inbound)
java.util.Map<javax.xml.namespace.QName,org.w3c.dom.DocumentFragment>	getSoapHeaders() Access to soap headers
java.util.Map<java.lang.String,java.lang.String>	getTransportHeaders() Access to the transport level headers
<T> void	put(java.lang.Class<T> key, T value) Convenience method for storing/retrieving typed objects from the map.
<T> void	setContent(java.lang.Class<T> format, java.lang.Object content) Provide the encapsulated content as a particular type (a result type if message is outbound, a source type if message is inbound)

Methods inherited from interface java.util.Map

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

Field Detail

REQUEST_MESSAGE

static final java.lang.String REQUEST_MESSAGE

See Also:

Constant Field Values

CONTENT_TYPE

static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

Method Detail

getAttachments

java.util.Map<java.lang.String,javax.activation.DataHandler> getAttachments()

Acces to attachments

Returns:

getContent

<T> T getContent(java.lang.Class<T> format)

Retreive the encapsulated content as a particular type (a result type if message is outbound, a source type if message is inbound)

Parameters:

format - the expected content format

Returns:

the encapsulated content

setContent

<T> void setContent(java.lang.Class<T> format,
                  java.lang.Object content)

Provide the encapsulated content as a particular type (a result type if message is outbound, a source type if message is inbound)

Parameters:

format - the provided content format

content - the content to be encapsulated

get

<T> T get(java.lang.Class<T> key)

Convenience method for storing/retrieving typed objects from the map. equivilent to: (T)get(key.getName());

Type Parameters:

T - key

Returns:

put

<T> void put(java.lang.Class<T> key,
           T value)

Convenience method for storing/retrieving typed objects from the map. equivilent to: put(key.getName(), value);

Type Parameters:

T - key

getTransportHeaders

java.util.Map<java.lang.String,java.lang.String> getTransportHeaders()

Access to the transport level headers

Returns:

getSoapHeaders

java.util.Map<javax.xml.namespace.QName,org.w3c.dom.DocumentFragment> getSoapHeaders()

Access to soap headers

Returns: