FileDocCategorySizeDatePackage
SOAPMessageContext.javaAPI DocJava SE 6 API3374Tue Jun 10 00:27:16 BST 2008javax.xml.ws.handler.soap

SOAPMessageContext

public interface SOAPMessageContext implements MessageContext
The interface 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.
see
javax.xml.soap.SOAPMessage
since
JAX-WS 2.0

Fields Summary
Constructors Summary
Methods Summary
public java.lang.Object[]getHeaders(javax.xml.namespace.QName header, javax.xml.bind.JAXBContext context, boolean allRoles)
Gets headers that have a particular qualified name from the message in the message context. Note that a SOAP message can contain multiple headers with the same qualified name.

param
header The XML qualified name of the SOAP header(s).
param
context The JAXBContext that should be used to unmarshall the header
param
allRoles 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.
return
An array of unmarshalled headers; returns an empty array if no message is present in this message context or no headers match the supplied qualified name.
throws
WebServiceException If an error occurs when using the supplied JAXBContext to unmarshall. The cause of the WebServiceException is the original JAXBException.

public javax.xml.soap.SOAPMessagegetMessage()
Gets the SOAPMessage from this message context. Modifications to the returned SOAPMessage change the message in-place, there is no need to susequently call setMessage.

return
Returns the SOAPMessage; returns null if no SOAPMessage is present in this message context

public java.util.SetgetRoles()
Gets the SOAP actor roles associated with an execution of the handler chain. Note that SOAP actor roles apply to the SOAP node and are managed using {@link javax.xml.ws.soap.SOAPBinding#setRoles} and {@link javax.xml.ws.soap.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.

return
Array of String for SOAP actor roles

public voidsetMessage(javax.xml.soap.SOAPMessage message)
Sets the SOAPMessage in this message context

param
message SOAP message
throws
WebServiceException If any error during the setting of the SOAPMessage in this message context
throws
java.lang.UnsupportedOperationException If this operation is not supported