- All Known Subinterfaces:
LogicalMessageContext
,SOAPMessageContext
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.
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Standard property: HTTP request headers.static final String
Standard property: HTTP request method.static final String
Standard property: HTTP response status code.static final String
Standard property: HTTP response headers.static final String
Standard property: Map of attachments to a message for the inbound message, key is the MIME Content-ID, value is a DataHandler.static final String
Standard property: message direction,true
for outbound messages,false
for inbound.static final String
Standard property: Map of attachments to a message for the outbound message, key is the MIME Content-ID, value is a DataHandler.static final String
Standard property: Request Path Infostatic final String
Standard property: Query string for request.static final String
Standard property: WS Addressing Reference Parameters.static final String
Standard property: servlet context object.static final String
Standard property: servlet request object.static final String
Standard property: servlet response object.static final String
Standard property: input source for WSDL document.static final String
Standard property: name of wsdl interface (2.0) or port type (1.1).static final String
Standard property: name of WSDL operation.static final String
Standard property: name of WSDL port.static final String
Standard property: name of WSDL service. -
Method Summary
Modifier and TypeMethodDescriptionGets the scope of a property.void
setScope
(String name, MessageContext.Scope scope) Sets the scope of a property.Methods inherited from interface java.util.Map
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
-
Field Details
-
MESSAGE_OUTBOUND_PROPERTY
Standard property: message direction,true
for outbound messages,false
for inbound.Type: boolean
- See Also:
-
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.Type:
java.util.Map<String, DataHandler>
- See Also:
-
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.Type:
java.util.Map<String, DataHandler>
- See Also:
-
WSDL_DESCRIPTION
Standard property: input source for WSDL document.Type: org.xml.sax.InputSource
- See Also:
-
WSDL_SERVICE
Standard property: name of WSDL service.Type: javax.xml.namespace.QName
- See Also:
-
WSDL_PORT
Standard property: name of WSDL port.Type: javax.xml.namespace.QName
- See Also:
-
WSDL_INTERFACE
Standard property: name of wsdl interface (2.0) or port type (1.1).Type: javax.xml.namespace.QName
- See Also:
-
WSDL_OPERATION
Standard property: name of WSDL operation.Type: javax.xml.namespace.QName
- See Also:
-
HTTP_RESPONSE_CODE
Standard property: HTTP response status code.Type: java.lang.Integer
- See Also:
-
HTTP_REQUEST_HEADERS
Standard property: HTTP request headers.Type:
java.util.Map<java.lang.String, java.util.List<java.lang.String>>
- See Also:
-
HTTP_RESPONSE_HEADERS
Standard property: HTTP response headers.Type:
java.util.Map<java.lang.String, java.util.List<java.lang.String>>
- See Also:
-
HTTP_REQUEST_METHOD
Standard property: HTTP request method.Type: java.lang.String
- See Also:
-
SERVLET_REQUEST
Standard property: servlet request object.Type: jakarta.servlet.http.HttpServletRequest
- See Also:
-
SERVLET_RESPONSE
Standard property: servlet response object.Type: jakarta.servlet.http.HttpServletResponse
- See Also:
-
SERVLET_CONTEXT
Standard property: servlet context object.Type: jakarta.servlet.ServletContext
- See Also:
-
QUERY_STRING
Standard property: Query string for request.Type: String
- See Also:
-
PATH_INFO
Standard property: Request Path InfoType: String
- See Also:
-
REFERENCE_PARAMETERS
Standard property: WS Addressing Reference Parameters. The list MUST include all SOAP headers marked with the wsa:IsReferenceParameter="true" attribute.Type:
List<Element>
- See Also:
-
-
Method Details
-
setScope
Sets the scope of a property.- Parameters:
name
- Name of the property associated with theMessageContext
scope
- Desired scope of the property- Throws:
IllegalArgumentException
- if an illegal property name is specified
-
getScope
Gets the scope of a property.- Parameters:
name
- Name of the property- Returns:
- Scope of the property
- Throws:
IllegalArgumentException
- if a non-existing property name is specified
-