javax.xml.ws.handler.soap

Interface SOAPMessageContext

Contents
  • All Superinterfaces:
    Map<String,Object>, MessageContext

    public interface SOAPMessageContext
extends 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.
    Since:
    JAX-WS 2.0
    See Also:
    SOAPMessage

    • Method Detail

      • getMessage

        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:
        Returns the SOAPMessage; returns null if no SOAPMessage is present in this message context

      • setMessage

        void setMessage(SOAPMessage message)
        Sets the SOAPMessage in this message context
        Parameters:
        message - SOAP message
        Throws:
        WebServiceException - If any error during the setting of the SOAPMessage in this message context
        UnsupportedOperationException - If this operation is not supported

      • getHeaders

        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 - The XML qualified name of the SOAP header(s).
        context - The JAXBContext that should be used to unmarshall the header
        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.
        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.
        Throws:
        WebServiceException - If an error occurs when using the supplied JAXBContext to unmarshall. The cause of the WebServiceException is the original JAXBException.

      • getRoles

        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 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.
        Returns:
        Array of String for SOAP actor roles

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/ws/handler/soap/soapmessagecontext.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut