public interface SOAPMessageContext extends MessageContext
SOAPMessageContext
provides access to the SOAP message for either RPC request or
response. The javax.xml.soap.SOAPMessage specifies
the standard Java API for the representation of a SOAP 1.1 message
with attachments.SOAPMessageMessageContext.ScopeHTTP_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 |
|---|---|
Object[] |
getHeaders(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 |
Set<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, setScopeSOAPMessage getMessage()
SOAPMessage from this message context. Modifications
to the returned SOAPMessage change the message in-place, there
is no need to susequently 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 contextUnsupportedOperationException - If this
operation is not supportedObject[] getHeaders(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.Set<String> getRoles()
SOAPBinding.setRoles(java.util.Set) 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 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, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138