public interface SOAPMessageContext extends MessageContext
SOAPMessageContext
provides access to the SOAP message for either RPC request or
response. The jakarta.xml.soap.SOAPMessage
specifies
the standard Java API for the representation of a SOAP 1.1 message
with attachments.SOAPMessage
MessageContext.Scope
HTTP_REQUEST_HEADERS, HTTP_REQUEST_METHOD, HTTP_RESPONSE_CODE, HTTP_RESPONSE_HEADERS, INBOUND_MESSAGE_ATTACHMENTS, MESSAGE_OUTBOUND_PROPERTY, OUTBOUND_MESSAGE_ATTACHMENTS, PATH_INFO, QUERY_STRING, REFERENCE_PARAMETERS, SERVLET_CONTEXT, SERVLET_REQUEST, SERVLET_RESPONSE, WSDL_DESCRIPTION, WSDL_INTERFACE, WSDL_OPERATION, WSDL_PORT, WSDL_SERVICE
Modifier and Type | Method and Description |
---|---|
java.lang.Object[] |
getHeaders(javax.xml.namespace.QName header,
JAXBContext context,
boolean allRoles)
Gets headers that have a particular qualified name from the message in the
message context.
|
SOAPMessage |
getMessage()
Gets the
SOAPMessage from this message context. |
java.util.Set<java.lang.String> |
getRoles()
Gets the SOAP actor roles associated with an execution
of the handler chain.
|
void |
setMessage(SOAPMessage message)
Sets the SOAPMessage in this message context
|
getScope, setScope
SOAPMessage getMessage()
SOAPMessage
from this message context. Modifications
to the returned SOAPMessage
change the message in-place, there
is no need to subsequently call setMessage
.SOAPMessage
; returns null
if no
SOAPMessage
is present in this message contextvoid setMessage(SOAPMessage message)
message
- SOAP messageWebServiceException
- If any error during the setting
of the SOAPMessage
in this message contextjava.lang.UnsupportedOperationException
- If this
operation is not supportedjava.lang.Object[] getHeaders(javax.xml.namespace.QName header, JAXBContext context, boolean allRoles)
header
- The XML qualified name of the SOAP header(s).context
- The JAXBContext that should be used to unmarshall the
headerallRoles
- If true
then returns headers for all SOAP
roles, if false
then only returns headers targetted
at the roles currently being played by this SOAP node, see
getRoles
.WebServiceException
- If an error occurs when using the supplied
JAXBContext
to unmarshall. The cause of
the WebServiceException
is the original JAXBException
.java.util.Set<java.lang.String> getRoles()
SOAPBinding.setRoles(java.util.Set<java.lang.String>)
and
SOAPBinding.getRoles()
. Handler
instances in
the handler chain use this information about the SOAP actor
roles to process the SOAP header blocks. Note that the
SOAP actor roles are invariant during the processing of
SOAP message through the handler chain.String
for SOAP actor roles