Apache CXF API

org.apache.cxf.message
Interface Message

All Superinterfaces:
java.util.Map<java.lang.String,java.lang.Object>
All Known Implementing Classes:
AbstractWrappedMessage, MessageImpl, XMLMessage

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
static java.lang.String BASE_PATH
           
static java.lang.String CONTENT_TYPE
           
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
           
static java.lang.String INVOCATION_OBJECTS
           
static java.lang.String MIME_HEADERS
           
static java.lang.String MTOM_ENABLED
           
static java.lang.String PASSWORD
           
static java.lang.String PATH_INFO
           
static java.lang.String PROTOCOL_HEADERS
           
static java.lang.String QUERY_STRING
           
static java.lang.String REQUESTOR_ROLE
           
static java.lang.String RESPONSE_CODE
           
static java.lang.String SCHEMA_VALIDATION_ENABLED
           
static java.lang.String TRANSPORT
           
static java.lang.String USERNAME
           
 
Method Summary
<T> T
get(java.lang.Class<T> key)
          Convenience method for storing/retrieving typed objects from the map.
 java.util.Collection<Attachment> getAttachments()
           
 Conduit getConduit()
           
<T> T
getContent(java.lang.Class<T> format)
          Retrieve the encapsulated content as a particular type (a result type if message is outbound, a source type if message is inbound)
 java.util.Set<java.lang.Class<?>> getContentFormats()
           
 java.lang.Object getContextualProperty(java.lang.String key)
           
 Destination getDestination()
           
 Exchange getExchange()
           
 java.lang.String getId()
           
 InterceptorChain getInterceptorChain()
           
<T> void
put(java.lang.Class<T> key, T value)
          Convenience method for storing/retrieving typed objects from the map.
 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)
           
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Field Detail

TRANSPORT

static final java.lang.String TRANSPORT
See Also:
Constant Field Values

REQUESTOR_ROLE

static final java.lang.String REQUESTOR_ROLE
See Also:
Constant Field Values

INBOUND_MESSAGE

static final java.lang.String INBOUND_MESSAGE
See Also:
Constant Field Values

INVOCATION_OBJECTS

static final java.lang.String INVOCATION_OBJECTS
See Also:
Constant Field Values

MIME_HEADERS

static final java.lang.String MIME_HEADERS
See Also:
Constant Field Values

USERNAME

static final java.lang.String USERNAME

PASSWORD

static final java.lang.String PASSWORD

PROTOCOL_HEADERS

static final java.lang.String PROTOCOL_HEADERS

RESPONSE_CODE

static final java.lang.String RESPONSE_CODE

ENDPOINT_ADDRESS

static final java.lang.String ENDPOINT_ADDRESS

HTTP_REQUEST_METHOD

static final java.lang.String HTTP_REQUEST_METHOD

PATH_INFO

static final java.lang.String PATH_INFO

QUERY_STRING

static final java.lang.String QUERY_STRING

MTOM_ENABLED

static final java.lang.String MTOM_ENABLED
See Also:
Constant Field Values

SCHEMA_VALIDATION_ENABLED

static final java.lang.String SCHEMA_VALIDATION_ENABLED

FAULT_STACKTRACE_ENABLED

static final java.lang.String FAULT_STACKTRACE_ENABLED
See Also:
Constant Field Values

CONTENT_TYPE

static final java.lang.String CONTENT_TYPE
See Also:
Constant Field Values

BASE_PATH

static final java.lang.String BASE_PATH

ENCODING

static final java.lang.String ENCODING

FIXED_PARAMETER_ORDER

static final java.lang.String FIXED_PARAMETER_ORDER
Method Detail

getId

java.lang.String getId()

setId

void setId(java.lang.String id)

getInterceptorChain

InterceptorChain getInterceptorChain()

setInterceptorChain

void setInterceptorChain(InterceptorChain chain)

getConduit

Conduit getConduit()
Returns:
the associated Conduit if message is outbound, null otherwise

getDestination

Destination getDestination()
Returns:
the associated Destination if message is inbound, null otherwise

getExchange

Exchange getExchange()

setExchange

void setExchange(Exchange exchange)

getAttachments

java.util.Collection<Attachment> getAttachments()

setAttachments

void setAttachments(java.util.Collection<Attachment> attachments)

getContent

<T> T getContent(java.lang.Class<T> format)
Retrieve 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

getContentFormats

java.util.Set<java.lang.Class<?>> getContentFormats()
Returns:
the set of currently encapsulated content formats

get

<T> T get(java.lang.Class<T> key)
Convenience method for storing/retrieving typed objects from the map. equivalent 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. equivalent to: put(key.getName(), value);

Type Parameters:
T - key

getContextualProperty

java.lang.Object getContextualProperty(java.lang.String key)

Apache CXF API

Apache CXF is an effort undergoing incubation at the Apache Software Foundation(ASF) and sponsored by the Apache Incubator PMC.