|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Message
The base interface for all all message implementations. All message objects passed to interceptors use this interface.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Field Summary | |
---|---|
static java.lang.String |
ACCEPT_CONTENT_TYPE
|
static java.lang.String |
ASYNC_POST_RESPONSE_DISPATCH
Boolean property specifying if the server should send the response asynchronously. |
static java.lang.String |
ATTACHMENTS
|
static java.lang.String |
BASE_PATH
|
static java.lang.String |
CONTENT_TYPE
|
static java.lang.String |
DECOUPLED_CHANNEL_MESSAGE
Boolean property specifying if this message arrived via a decoupled endpoint. |
static java.lang.String |
ENCODING
|
static java.lang.String |
ENDPOINT_ADDRESS
|
static java.lang.String |
FAULT_STACKTRACE_ENABLED
|
static java.lang.String |
FIXED_PARAMETER_ORDER
|
static java.lang.String |
HTTP_REQUEST_METHOD
|
static java.lang.String |
INBOUND_MESSAGE
Boolean property specifying if the message is inbound. |
static java.lang.String |
INVOCATION_CONTEXT
A Map keyed by a string that stores optional context information associated with the invocation that spawned the message. |
static java.lang.String |
MAINTAIN_SESSION
|
static java.lang.String |
MIME_HEADERS
A Map containing the MIME headers for a SOAP message. |
static java.lang.String |
MTOM_ENABLED
Boolean property specifying in the runtime is configured to process MTOM attachments. |
static java.lang.String |
MTOM_THRESHOLD
|
static java.lang.String |
PARTIAL_RESPONSE_MESSAGE
|
static java.lang.String |
PATH_INFO
|
static java.lang.String |
PROTOCOL_HEADERS
|
static java.lang.String |
QUERY_STRING
|
static java.lang.String |
REQUEST_URI
|
static java.lang.String |
REQUESTOR_ROLE
Boolean property specifying if the message is a request message. |
static java.lang.String |
RESPONSE_CODE
|
static java.lang.String |
SCHEMA_VALIDATION_ENABLED
|
static java.lang.String |
TRANSPORT
|
static java.lang.String |
WSDL_DESCRIPTION
|
static java.lang.String |
WSDL_INTERFACE
|
static java.lang.String |
WSDL_OPERATION
|
static java.lang.String |
WSDL_PORT
|
static java.lang.String |
WSDL_SERVICE
|
Method Summary | ||
---|---|---|
java.util.Collection<Attachment> |
getAttachments()
Retrieve any binary attachments associated with the message. |
|
|
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. |
|
Destination |
getDestination()
|
|
Exchange |
getExchange()
|
|
java.lang.String |
getId()
|
|
InterceptorChain |
getInterceptorChain()
Returns a live copy of the messages interceptor chain. |
|
|
removeContent(java.lang.Class<T> format)
Removes a content from a message. |
|
void |
setAttachments(java.util.Collection<Attachment> attachments)
|
|
|
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)
|
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, put, putAll, remove, size, values |
Field Detail |
---|
static final java.lang.String TRANSPORT
static final java.lang.String REQUESTOR_ROLE
static final java.lang.String INBOUND_MESSAGE
static final java.lang.String INVOCATION_CONTEXT
static final java.lang.String MIME_HEADERS
static final java.lang.String ASYNC_POST_RESPONSE_DISPATCH
static final java.lang.String DECOUPLED_CHANNEL_MESSAGE
static final java.lang.String PARTIAL_RESPONSE_MESSAGE
static final java.lang.String PROTOCOL_HEADERS
static final java.lang.String RESPONSE_CODE
static final java.lang.String ENDPOINT_ADDRESS
static final java.lang.String HTTP_REQUEST_METHOD
static final java.lang.String PATH_INFO
static final java.lang.String REQUEST_URI
static final java.lang.String QUERY_STRING
static final java.lang.String MTOM_ENABLED
static final java.lang.String MTOM_THRESHOLD
static final java.lang.String SCHEMA_VALIDATION_ENABLED
static final java.lang.String FAULT_STACKTRACE_ENABLED
static final java.lang.String CONTENT_TYPE
static final java.lang.String ACCEPT_CONTENT_TYPE
static final java.lang.String BASE_PATH
static final java.lang.String ENCODING
static final java.lang.String FIXED_PARAMETER_ORDER
static final java.lang.String MAINTAIN_SESSION
static final java.lang.String ATTACHMENTS
static final java.lang.String WSDL_DESCRIPTION
static final java.lang.String WSDL_SERVICE
static final java.lang.String WSDL_PORT
static final java.lang.String WSDL_INTERFACE
static final java.lang.String WSDL_OPERATION
Method Detail |
---|
java.lang.String getId()
void setId(java.lang.String id)
InterceptorChain getInterceptorChain()
void setInterceptorChain(InterceptorChain chain)
Destination getDestination()
Exchange getExchange()
void setExchange(Exchange exchange)
java.util.Collection<Attachment> getAttachments()
void setAttachments(java.util.Collection<Attachment> attachments)
<T> T getContent(java.lang.Class<T> format)
format
- the expected content format
<T> void setContent(java.lang.Class<T> format, java.lang.Object content)
format
- the provided content formatcontent
- the content to be encapsulatedjava.util.Set<java.lang.Class<?>> getContentFormats()
<T> void removeContent(java.lang.Class<T> format)
format
- the format to removejava.lang.Object getContextualProperty(java.lang.String key)
key
- the Message interface's property strings that
correlates to the desired property
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |