org.apache.cxf.message

Class AbstractWrappedMessage

java.lang.Object

org.apache.cxf.message.AbstractWrappedMessage

All Implemented Interfaces:

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

Direct Known Subclasses:

XMLMessage, XMLMessage

public abstract class AbstractWrappedMessage
extends java.lang.Object
implements Message

A base class to build your own message implementations on.

Nested Class Summary

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

java.util.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_TRANSFER_ENCODING, CONTENT_TYPE, DECOUPLED_CHANNEL_MESSAGE, EMPTY_PARTIAL_RESPONSE_MESSAGE, ENCODING, ENDPOINT_ADDRESS, ERROR_MESSAGE, 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_RESPONSE, PROPOGATE_EXCEPTION, PROTOCOL_HEADERS, QUERY_STRING, RECEIVE_TIMEOUT, REQUEST_URI, REQUEST_URL, REQUESTOR_ROLE, RESPONSE_CODE, REST_MESSAGE, ROBUST_ONEWAY, SCHEMA_VALIDATION_ENABLED, SCHEMA_VALIDATION_TYPE, SERVICE_OBJECT, THREAD_CONTEXT_SWITCHED, THREAD_SAFE_STAX_FACTORIES, TRANSPORT, WSDL_DESCRIPTION, WSDL_INTERFACE, WSDL_OPERATION, WSDL_PORT, WSDL_SERVICE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWrappedMessage(Message msg)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	entrySet()
boolean	equals(java.lang.Object o)
<T> T	get(java.lang.Class<T> key) Convenience method for storing/retrieving typed objects from the map.
java.lang.Object	get(java.lang.Object key)
java.util.Collection<Attachment>	getAttachments() Retrieve any binary attachments associated with the message.
<T> T	getContent(java.lang.Class<T> format) Retrieve the encapsulated content as a particular type.
java.util.Set<java.lang.Class<?>>	getContentFormats()
java.lang.Object	getContextualProperty(java.lang.String key) Queries the Message object's metadata for a specific property.
java.util.Set<java.lang.String>	getContextualPropertyKeys()
Destination	getDestination()
Exchange	getExchange()
java.lang.String	getId()
InterceptorChain	getInterceptorChain() Returns a live copy of the messages interceptor chain.
Message	getMessage()
int	hashCode()
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
<T> void	put(java.lang.Class<T> key, T value) Convenience method for storing/retrieving typed objects from the map.
java.lang.Object	put(java.lang.String key, java.lang.Object value)
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> t)
<T> T	remove(java.lang.Class<T> key) Convenience method for removing typed objects from the map.
java.lang.Object	remove(java.lang.Object key)
<T> void	removeContent(java.lang.Class<T> format) Removes a content from a message.
void	resetContextCache() Resets the cache of contextual properties that messages may contain.
void	setAttachments(java.util.Collection<Attachment> attachments)
<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)
void	setExchange(Exchange exchange)
void	setId(java.lang.String id)
void	setInterceptorChain(InterceptorChain chain)
void	setMessage(Message message)
int	size()
java.util.Collection<java.lang.Object>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AbstractWrappedMessage

protected AbstractWrappedMessage(Message msg)

Method Detail

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.Object>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.Object>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

equals in class java.lang.Object

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

getAttachments

public java.util.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(java.util.Collection<Attachment> attachments)

Specified by:

setAttachments in interface Message

getMessage

public Message getMessage()

setMessage

public void setMessage(Message message)

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

setExchange

public final void setExchange(Exchange exchange)

Specified by:

setExchange in interface Message

getId

public java.lang.String getId()

Specified by:

getId in interface Message

setId

public void setId(java.lang.String id)

Specified by:

setId 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

setInterceptorChain

public void setInterceptorChain(InterceptorChain chain)

Specified by:

setInterceptorChain in interface Message

getContent

public <T> T getContent(java.lang.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

removeContent

public <T> void removeContent(java.lang.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 java.util.Set<java.lang.Class<?>> getContentFormats()

Specified by:

getContentFormats in interface Message

Returns:

the set of currently encapsulated content formats

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.Object>

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.Object> t)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.Object>

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>

setContent

public <T> void setContent(java.lang.Class<T> format,
                           java.lang.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

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.Object>

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.Object>

get

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

Description copied from interface: StringMap

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

Specified by:

get in interface StringMap

Parameters:

key - the key

Returns:

the value

put

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

Description copied from interface: StringMap

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

Specified by:

put in interface StringMap

Parameters:

key - the key

value - the value

remove

public <T> T remove(java.lang.Class<T> key)

Description copied from interface: StringMap

Convenience method for removing typed objects from the map. equivalent to: (T)remove(key.getName());

Specified by:

remove in interface StringMap

Parameters:

key - the key

getContextualProperty

public java.lang.Object getContextualProperty(java.lang.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

getContextualPropertyKeys

public java.util.Set<java.lang.String> getContextualPropertyKeys()

Specified by:

getContextualPropertyKeys in interface Message

Returns:

set of defined contextual property keys

resetContextCache

public void resetContextCache()

Description copied from interface: Message

Resets the cache of contextual properties that messages may contain. Subsequent calls to getContextualProperty will likely recalculate the cache.

Specified by:

resetContextCache in interface Message