public interface MessageContext extends Map<String,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 String |
HTTP_REQUEST_HEADERS
Standard property: HTTP request headers.
|
static String |
HTTP_REQUEST_METHOD
Standard property: HTTP request method.
|
static String |
HTTP_RESPONSE_CODE
Standard property: HTTP response status code.
|
static String |
HTTP_RESPONSE_HEADERS
Standard property: HTTP response headers.
|
static 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 String |
MESSAGE_OUTBOUND_PROPERTY
Standard property: message direction,
true for
outbound messages, false for inbound. |
static 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 String |
PATH_INFO
Standard property: Request Path Info
|
static String |
QUERY_STRING
Standard property: Query string for request.
|
static String |
REFERENCE_PARAMETERS
Standard property: WS Addressing Reference Parameters.
|
static String |
SERVLET_CONTEXT
Standard property: servlet context object.
|
static String |
SERVLET_REQUEST
Standard property: servlet request object.
|
static String |
SERVLET_RESPONSE
Standard property: servlet response object.
|
static String |
WSDL_DESCRIPTION
Standard property: input source for WSDL document.
|
static String |
WSDL_INTERFACE
Standard property: name of wsdl interface (2.0) or port type (1.1).
|
static String |
WSDL_OPERATION
Standard property: name of WSDL operation.
|
static String |
WSDL_PORT
Standard property: name of WSDL port.
|
static String |
WSDL_SERVICE
Standard property: name of WSDL service.
|
Modifier and Type | Method and Description |
---|---|
MessageContext.Scope |
getScope(String name)
Gets the scope of a property.
|
void |
setScope(String name,
MessageContext.Scope scope)
Sets the scope of a property.
|
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
static final String MESSAGE_OUTBOUND_PROPERTY
true
for
outbound messages, false
for inbound.
Type: boolean
static final String INBOUND_MESSAGE_ATTACHMENTS
Type: java.util.Map<String,DataHandler>
static final String OUTBOUND_MESSAGE_ATTACHMENTS
Type: java.util.Map<String,DataHandler>
static final String WSDL_DESCRIPTION
Type: org.xml.sax.InputSource
static final String WSDL_SERVICE
Type: javax.xml.namespace.QName
static final String WSDL_PORT
Type: javax.xml.namespace.QName
static final String WSDL_INTERFACE
Type: javax.xml.namespace.QName
static final String WSDL_OPERATION
Type: javax.xml.namespace.QName
static final String HTTP_RESPONSE_CODE
Type: java.lang.Integer
static final String HTTP_REQUEST_HEADERS
Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>>
static final String HTTP_RESPONSE_HEADERS
Type: java.util.Map<java.lang.String, java.util.List<java.lang.String>>
static final String HTTP_REQUEST_METHOD
Type: java.lang.String
static final String SERVLET_REQUEST
Type: javax.servlet.http.HttpServletRequest
static final String SERVLET_RESPONSE
Type: javax.servlet.http.HttpServletResponse
static final String SERVLET_CONTEXT
Type: javax.servlet.ServletContext
static final String QUERY_STRING
Type: String
static final String PATH_INFO
Type: String
static final String REFERENCE_PARAMETERS
Type: List<Element>
void setScope(String name, MessageContext.Scope scope)
name
- Name of the property associated with the
MessageContext
scope
- Desired scope of the propertyIllegalArgumentException
- if an illegal
property name is specifiedMessageContext.Scope getScope(String name)
name
- Name of the propertyIllegalArgumentException
- if a non-existant
property name is specified Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2024, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.