| 
 | Apache CXF API | |||||||||
| 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 | 
|---|
| Map.Entry<K,V> | 
| Field Summary | |
|---|---|
| static String | ACCEPT_CONTENT_TYPE | 
| static String | ASYNC_POST_RESPONSE_DISPATCHBoolean property specifying if the server should send the response asynchronously. | 
| static String | ATTACHMENTS | 
| static String | BASE_PATH | 
| static String | CONNECTION_TIMEOUT | 
| static String | CONTENT_TYPE | 
| static String | DECOUPLED_CHANNEL_MESSAGEBoolean property specifying if this message arrived via a decoupled endpoint. | 
| static String | ENCODING | 
| static String | ENDPOINT_ADDRESS | 
| static String | EXCEPTION_MESSAGE_CAUSE_ENABLEDBoolean property specifying if the name of the exception that caused the Java stack trace is returned. | 
| static String | FAULT_IN_INTERCEPTORS | 
| static String | FAULT_OUT_INTERCEPTORS | 
| static String | FAULT_STACKTRACE_ENABLEDBoolean property specifying if the Java stack trace is returned as a SOAP fault message. | 
| static String | FIXED_PARAMETER_ORDER | 
| static String | HANDLING_PARTIAL_RESPONSE_MESSAGE | 
| static String | HTTP_REQUEST_METHOD | 
| static String | IN_INTERCEPTORSSome properties to allow adding interceptors to the chain on a per-request basis. | 
| static String | INBOUND_MESSAGEBoolean property specifying if the message is inbound. | 
| static String | INTERCEPTOR_PROVIDERSAs above, but Collection | 
| static String | INVOCATION_CONTEXTA Map keyed by a string that stores optional context information associated with the invocation that spawned the message. | 
| static String | MAINTAIN_SESSION | 
| static String | MIME_HEADERSA Map containing the MIME headers for a SOAP message. | 
| static String | MTOM_ENABLEDBoolean property specifying in the runtime is configured to process MTOM attachments. | 
| static String | MTOM_THRESHOLD | 
| static String | ONE_WAY_REQUEST | 
| static String | OUT_INTERCEPTORS | 
| static String | PARTIAL_RESPONSE_MESSAGE | 
| static String | PATH_INFO | 
| static String | PROPOGATE_EXCEPTION | 
| static String | PROTOCOL_HEADERS | 
| static String | QUERY_STRING | 
| static String | RECEIVE_TIMEOUT | 
| static String | REQUEST_URI | 
| static String | REQUEST_URL | 
| static String | REQUESTOR_ROLEBoolean property specifying if the message is a request message. | 
| static String | RESPONSE_CODE | 
| static String | SCHEMA_VALIDATION_ENABLED | 
| static String | TRANSPORT | 
| static String | WSDL_DESCRIPTION | 
| static String | WSDL_INTERFACE | 
| static String | WSDL_OPERATION | 
| static String | WSDL_PORT | 
| static String | WSDL_SERVICE | 
| Method Summary | ||
|---|---|---|
|  Collection<Attachment> | getAttachments()Retrieve any binary attachments associated with the message. | |
| 
 | 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. | |
| 
 | removeContent(Class<T> format)Removes a content from a message. | |
|  void | resetContextCache() | |
|  void | setAttachments(Collection<Attachment> attachments) | |
| 
 | 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 | setExchange(Exchange exchange) | |
|  void | setId(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 String TRANSPORT
static final String REQUESTOR_ROLE
static final String INBOUND_MESSAGE
static final String INVOCATION_CONTEXT
static final String MIME_HEADERS
static final String ASYNC_POST_RESPONSE_DISPATCH
static final String DECOUPLED_CHANNEL_MESSAGE
static final String PARTIAL_RESPONSE_MESSAGE
static final String HANDLING_PARTIAL_RESPONSE_MESSAGE
static final String ONE_WAY_REQUEST
static final String HTTP_REQUEST_METHOD
static final String REQUEST_URI
static final String REQUEST_URL
static final String PROTOCOL_HEADERS
static final String RESPONSE_CODE
static final String ENDPOINT_ADDRESS
static final String PATH_INFO
static final String QUERY_STRING
static final String PROPOGATE_EXCEPTION
static final String MTOM_ENABLED
static final String MTOM_THRESHOLD
static final String SCHEMA_VALIDATION_ENABLED
static final String FAULT_STACKTRACE_ENABLED
static final String EXCEPTION_MESSAGE_CAUSE_ENABLED
static final String CONTENT_TYPE
static final String ACCEPT_CONTENT_TYPE
static final String BASE_PATH
static final String ENCODING
static final String FIXED_PARAMETER_ORDER
static final String MAINTAIN_SESSION
static final String ATTACHMENTS
static final String WSDL_DESCRIPTION
static final String WSDL_SERVICE
static final String WSDL_PORT
static final String WSDL_INTERFACE
static final String WSDL_OPERATION
static final String IN_INTERCEPTORS
static final String OUT_INTERCEPTORS
static final String FAULT_IN_INTERCEPTORS
static final String FAULT_OUT_INTERCEPTORS
static final String INTERCEPTOR_PROVIDERS
static final String CONNECTION_TIMEOUT
static final String RECEIVE_TIMEOUT
| Method Detail | 
|---|
String getId()
void setId(String id)
InterceptorChain getInterceptorChain()
void setInterceptorChain(InterceptorChain chain)
Destination getDestination()
Exchange getExchange()
void setExchange(Exchange exchange)
Collection<Attachment> getAttachments()
void setAttachments(Collection<Attachment> attachments)
<T> T getContent(Class<T> format)
format - the expected content format
<T> void setContent(Class<T> format,
                    Object content)
format - the provided content formatcontent - the content to be encapsulatedSet<Class<?>> getContentFormats()
<T> void removeContent(Class<T> format)
format - the format to removeObject getContextualProperty(String key)
key - the Message interface's property strings that 
 correlates to the desired property
void resetContextCache()
void setContextualProperty(String key,
                           Object v)
| 
 | Apache CXF API | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||