JAX-WS API 2.3.1 · javax.xml.ws.handler.soap.SOAPMessageContext

Method Summary

Modifier and Type	Method and Description
public Object[]	Returns: 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. getHeaders(QName The XML qualified name of the SOAP header(s). header, JAXBContext The JAXBContext that should be used to unmarshall the header context, boolean 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`. allRoles) Gets headers that have a particular qualified name from the message in the message context.
public SOAPMessage	Returns: Returns the `SOAPMessage`; returns `null` if no `SOAPMessage` is present in this message context getMessage() Gets the `SOAPMessage` from this message context.
public Set<String>	Returns: Array of `String` for SOAP actor roles getRoles() Gets the SOAP actor roles associated with an execution of the handler chain.
public void	setMessage(SOAPMessage SOAP message message) Sets the SOAPMessage in this message context

Inherited from javax.xml.ws.handler.MessageContext:: getScope setScope

Method Detail

getHeaders back to summary

getHeaders	back to summary
public Object[] getHeaders(QName header, 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. Parameters header:QName The XML qualified name of the SOAP header(s). context:JAXBContext The JAXBContext that should be used to unmarshall the header allRoles:boolean 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`. Returns:Object[] 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. Exceptions WebServiceException: If an error occurs when using the supplied `JAXBContext` to unmarshall. The cause of the `WebServiceException` is the original `JAXBException`.

public Object[] getHeaders(QName header, 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.

Parameters

header:QName: The XML qualified name of the SOAP header(s).
context:JAXBContext: The JAXBContext that should be used to unmarshall the header
allRoles:boolean: 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.

Returns:Object[]

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.

Exceptions

WebServiceException:: If an error occurs when using the supplied JAXBContext to unmarshall. The cause of the WebServiceException is the original JAXBException.

getMessage back to summary

getMessage	back to summary
public SOAPMessage getMessage() Gets the `SOAPMessage` from this message context. Modifications to the returned `SOAPMessage` change the message in-place, there is no need to subsequently call `setMessage`. Returns:SOAPMessage Returns the `SOAPMessage`; returns `null` if no `SOAPMessage` is present in this message context

public SOAPMessage getMessage()

Gets the SOAPMessage from this message context. Modifications to the returned SOAPMessage change the message in-place, there is no need to subsequently call setMessage.

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

getRoles back to summary

getRoles	back to summary
public Set<String> getRoles() 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 `javax.xml.ws.soap.SOAPBinding#setRoles` and `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. Returns:Set<String> Array of `String` for SOAP actor roles

public Set<String> getRoles()

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 javax.xml.ws.soap.SOAPBinding#setRoles and 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.

Returns:Set<String>: Array of String for SOAP actor roles

setMessage back to summary

setMessage	back to summary
public void setMessage(SOAPMessage message) Sets the SOAPMessage in this message context Parameters message:SOAPMessage SOAP message Exceptions WebServiceException: If any error during the setting of the `SOAPMessage` in this message context UnsupportedOperationException: If this operation is not supported

public void setMessage(SOAPMessage message)

Sets the SOAPMessage in this message context

Parameters

message:SOAPMessage: SOAP message

Exceptions

WebServiceException:: If any error during the setting of the SOAPMessage in this message context
UnsupportedOperationException:: If this operation is not supported

public Interface SOAPMessageContext

Field Summary

Method Summary

Method Detail