Package org.apache.cxf.message
Class AbstractWrappedMessage
java.lang.Object
org.apache.cxf.message.AbstractWrappedMessage
- Direct Known Subclasses:
XMLMessage
A base class to build your own message implementations on.
-
Nested Class Summary
-
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_202_RESPONSE_ONEWAY_OR_PARTIAL, PROCESS_ONEWAY_RESPONSE, PROPAGATE_202_RESPONSE_ONEWAY_OR_PARTIAL, 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 -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()booleancontainsKey(Object key) booleancontainsValue(Object value) entrySet()boolean<T> TConvenience method for storing/retrieving typed objects from the map.Retrieve any binary attachments associated with the message.<T> TgetContent(Class<T> format) Retrieve the encapsulated content as a particular type.Queries the Message object's metadata for a specific property.getId()Returns a live copy of the messages interceptor chain.inthashCode()booleanisEmpty()keySet()<T> voidConvenience method for storing/retrieving typed objects from the map.void<T> TConvenience method for removing typed objects from the map.<T> voidremoveContent(Class<T> format) Removes a content from a message.voidResets the cache of contextual properties that messages may contain.voidsetAttachments(Collection<Attachment> attachments) <T> voidsetContent(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)final voidsetExchange(Exchange exchange) voidvoidvoidsetMessage(Message message) intsize()values()Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Constructor Details
-
AbstractWrappedMessage
-
-
Method Details
-
clear
public void clear() -
containsKey
- Specified by:
containsKeyin interfaceMap<String,Object>
-
containsValue
- Specified by:
containsValuein interfaceMap<String,Object>
-
entrySet
-
equals
-
get
-
getAttachments
Description copied from interface:MessageRetrieve any binary attachments associated with the message.- Specified by:
getAttachmentsin interfaceMessage- Returns:
- a collection containing the attachments
-
setAttachments
- Specified by:
setAttachmentsin interfaceMessage
-
getMessage
-
setMessage
-
getDestination
- Specified by:
getDestinationin interfaceMessage- Returns:
- the associated Destination if message is inbound, null otherwise
-
getExchange
- Specified by:
getExchangein interfaceMessage
-
setExchange
- Specified by:
setExchangein interfaceMessage
-
getId
-
setId
-
getInterceptorChain
Description copied from interface:MessageReturns 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:
getInterceptorChainin interfaceMessage- Returns:
- the interceptor chain used to process the message
-
setInterceptorChain
- Specified by:
setInterceptorChainin interfaceMessage
-
getContent
Description copied from interface:MessageRetrieve 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:
getContentin interfaceMessage- Parameters:
format- the expected content format- Returns:
- the encapsulated content
-
removeContent
Description copied from interface:MessageRemoves a content from a message. If some contents are completely consumed, removing them is a good idea- Specified by:
removeContentin interfaceMessage- Parameters:
format- the format to remove
-
getContentFormats
- Specified by:
getContentFormatsin interfaceMessage- Returns:
- the set of currently encapsulated content formats
-
hashCode
public int hashCode() -
isEmpty
public boolean isEmpty() -
keySet
-
put
-
putAll
-
remove
-
setContent
Description copied from interface:MessageProvide the encapsulated content as a particular type (a result type if message is outbound, a source type if message is inbound)- Specified by:
setContentin interfaceMessage- Parameters:
format- the provided content formatcontent- the content to be encapsulated
-
size
public int size() -
values
-
get
Description copied from interface:StringMapConvenience method for storing/retrieving typed objects from the map. equivalent to: (T)get(key.getName()); -
put
Description copied from interface:StringMapConvenience method for storing/retrieving typed objects from the map. equivalent to: put(key.getName(), value); -
remove
Description copied from interface:StringMapConvenience method for removing typed objects from the map. equivalent to: (T)remove(key.getName()); -
getContextualProperty
Description copied from interface:MessageQueries the Message object's metadata for a specific property.- Specified by:
getContextualPropertyin interfaceMessage- Parameters:
key- the Message interface's property strings that correlates to the desired property- Returns:
- the property's value
-
getContextualPropertyKeys
- Specified by:
getContextualPropertyKeysin interfaceMessage- Returns:
- set of defined contextual property keys
-
resetContextCache
public void resetContextCache()Description copied from interface:MessageResets the cache of contextual properties that messages may contain. Subsequent calls to getContextualProperty will likely recalculate the cache.- Specified by:
resetContextCachein interfaceMessage
-