Interface SOAPEnvelope

    • Method Detail

      • getHeader

        SOAPHeader getHeader()
        Returns the SOAPHeader object for this envelope. This method takes advantage of the fact that the SOAPHeader must be the first child element (if it exists) to avoid building the SOAPBody if it is still incomplete.
        Returns:
        the SOAPHeader object or null if there is none
      • getOrCreateHeader

        SOAPHeader getOrCreateHeader()
        Returns the existing SOAPHeader object for this envelope or creates a new one if there is none. Similarly to getHeader(), this method avoids building the SOAPBody.
        Returns:
        the existing or newly created SOAPHeader object for this envelope
      • getBody

        SOAPBody getBody()
                  throws OMException
        Returns the SOAPBody object associated with this SOAPEnvelope object.

        This SOAPBody will just be a container for all the BodyElements in the OMMessage

        Returns:
        the SOAPBody object for this SOAPEnvelope object or null if there is none
        Throws:
        OMException - if there is a problem obtaining the SOAPBody object
      • hasFault

        boolean hasFault()
        Returns true if there is a SOAPFault in the body. The implementation may choose to get this information by building the OM tree or use parser provided information.
        Returns:
        true if SOAPFault in the body
      • getSOAPBodyFirstElementNS

        OMNamespace getSOAPBodyFirstElementNS()
        Retrieves the OMNamespace of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the OMNamespace, but don't necessarily need the OMElement.
        Returns:
        the namespace of first element in the body, or null if the element has no namespace or the body is empty
      • getSOAPBodyFirstElementLocalName

        String getSOAPBodyFirstElementLocalName()
        Retrieves the local name of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the name, but don't necessarily need the OMElement.
        Returns:
        local name of first element in the body or null