public interface MessageContext
extends java.util.Map<java.lang.String,java.lang.Object>
MessageContext
abstracts the message
context that is processed by a handler in the handle
method.
The MessageContext
interface provides methods to
manage a property set. MessageContext
properties
enable handlers in a handler chain to share processing related
state.
Modifier and Type | Interface and Description |
---|---|
static class |
MessageContext.Scope
Property scope.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
HTTP_REQUEST_HEADERS
Standard property: HTTP request headers.
|
static java.lang.String |
HTTP_REQUEST_METHOD
Standard property: HTTP request method.
|
static java.lang.String |
HTTP_RESPONSE_CODE
Standard property: HTTP response status code.
|
static java.lang.String |
HTTP_RESPONSE_HEADERS
Standard property: HTTP response headers.
|
static java.lang.String |
INBOUND_MESSAGE_ATTACHMENTS
Standard property: Map of attachments to a message for the inbound
message, key is the MIME Content-ID, value is a DataHandler.
|
static java.lang.String |
MESSAGE_OUTBOUND_PROPERTY
Standard property: message direction,
true for
outbound messages, false for inbound. |
static java.lang.String |
OUTBOUND_MESSAGE_ATTACHMENTS
Standard property: Map of attachments to a message for the outbound
message, key is the MIME Content-ID, value is a DataHandler.
|
static java.lang.String |
PATH_INFO
Standard property: Request Path Info
|
static java.lang.String |
QUERY_STRING
Standard property: Query string for request.
|
static java.lang.String |
REFERENCE_PARAMETERS
Standard property: WS Addressing Reference Parameters.
|
static java.lang.String |
SERVLET_CONTEXT
Standard property: servlet context object.
|
static java.lang.String |
SERVLET_REQUEST
Standard property: servlet request object.
|
static java.lang.String |
SERVLET_RESPONSE
Standard property: servlet response object.
|
static java.lang.String |
WSDL_DESCRIPTION
Standard property: input source for WSDL document.
|
static java.lang.String |
WSDL_INTERFACE
Standard property: name of wsdl interface (2.0) or port type (1.1).
|
static java.lang.String |
WSDL_OPERATION
Standard property: name of WSDL operation.
|
static java.lang.String |
WSDL_PORT
Standard property: name of WSDL port.
|
static java.lang.String |
WSDL_SERVICE
Standard property: name of WSDL service.
|
Modifier and Type | Method and Description |
---|---|
MessageContext.Scope |
getScope(java.lang.String name)
Gets the scope of a property.
|
void |
setScope(java.lang.String name,
MessageContext.Scope scope)
Sets the scope of a property.
|
static final java.lang.String MESSAGE_OUTBOUND_PROPERTY
true
for
outbound messages, false
for inbound.
Type: boolean
static final java.lang.String INBOUND_MESSAGE_ATTACHMENTS
Type: java.util.Map<String, DataHandler>
static final java.lang.String OUTBOUND_MESSAGE_ATTACHMENTS
Type: java.util.Map<String, DataHandler>
static final java.lang.String WSDL_DESCRIPTION
Type: org.xml.sax.InputSource
static final java.lang.String WSDL_SERVICE
Type: javax.xml.namespace.QName
static final java.lang.String WSDL_PORT
Type: javax.xml.namespace.QName
static final java.lang.String WSDL_INTERFACE
Type: javax.xml.namespace.QName
static final java.lang.String WSDL_OPERATION
Type: javax.xml.namespace.QName
static final java.lang.String HTTP_RESPONSE_CODE
Type: java.lang.Integer
static final java.lang.String HTTP_REQUEST_HEADERS
Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>>
static final java.lang.String HTTP_RESPONSE_HEADERS
Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>>
static final java.lang.String HTTP_REQUEST_METHOD
Type: java.lang.String
static final java.lang.String SERVLET_REQUEST
Type: jakarta.servlet.http.HttpServletRequest
static final java.lang.String SERVLET_RESPONSE
Type: jakarta.servlet.http.HttpServletResponse
static final java.lang.String SERVLET_CONTEXT
Type: jakarta.servlet.ServletContext
static final java.lang.String QUERY_STRING
Type: String
static final java.lang.String PATH_INFO
Type: String
static final java.lang.String REFERENCE_PARAMETERS
Type: List<Element>
void setScope(java.lang.String name, MessageContext.Scope scope)
name
- Name of the property associated with the
MessageContext
scope
- Desired scope of the propertyjava.lang.IllegalArgumentException
- if an illegal
property name is specifiedMessageContext.Scope getScope(java.lang.String name)
name
- Name of the propertyjava.lang.IllegalArgumentException
- if a non-existant
property name is specified