Interface SOAPBody

  • All Superinterfaces:
    org.w3c.dom.Element, Node, org.w3c.dom.Node, SOAPElement

    public interface SOAPBody
    extends SOAPElement
    An object that represents the contents of the SOAP body element in a SOAP message. A SOAP body element consists of XML data that affects the way the application-specific content is processed.

    A SOAPBody object contains SOAPBodyElement objects, which have the content for the SOAP body. A SOAPFault object, which carries status and/or error information, is an example of a SOAPBodyElement object.

    See Also:
    SOAPFault
    • Method Detail

      • addFault

        SOAPFault addFault()
                    throws SOAPException
        Creates a new SOAPFault object and adds it to this SOAPBody object.
        Returns:
        the new SOAPFault object
        Throws:
        SOAPException - if there is a SOAP error
      • hasFault

        boolean hasFault()
        Indicates whether a SOAPFault object exists in this SOAPBody object.
        Returns:
        true if a SOAPFault object exists in this SOAPBody object; false otherwise
      • getFault

        SOAPFault getFault()
        Returns the SOAPFault object in this SOAPBody object.
        Returns:
        the SOAPFault object in this SOAPBody object
      • addBodyElement

        SOAPBodyElement addBodyElement​(Name name)
                                throws SOAPException
        Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.
        Parameters:
        name - a Name object with the name for the new SOAPBodyElement object
        Returns:
        the new SOAPBodyElement object
        Throws:
        SOAPException - if a SOAP error occurs
      • addFault

        SOAPFault addFault​(Name faultCode,
                           java.lang.String faultString,
                           java.util.Locale locale)
                    throws SOAPException
        Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have a faultcode element that is set to the faultCode parameter and a faultstring set to faultstring and localized to locale.
        Parameters:
        faultCode - a Name object giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification and of type QName
        faultString - a String giving an explanation of the fault
        locale - a Locale object indicating the native language of the faultString
        Returns:
        the new SOAPFault object
        Throws:
        SOAPException - if there is a SOAP error
      • addFault

        SOAPFault addFault​(Name faultCode,
                           java.lang.String faultString)
                    throws SOAPException
        Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have a faultcode element that is set to the faultCode parameter and a faultstring set to faultstring.
        Parameters:
        faultCode - a Name object giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification and of type QName
        faultString - a String giving an explanation of the fault
        Returns:
        the new SOAPFault object
        Throws:
        SOAPException - if there is a SOAP error
      • addDocument

        SOAPBodyElement addDocument​(org.w3c.dom.Document document)
                             throws SOAPException
        Adds the root node of the DOM Document to this SOAPBody object.

        Calling this method invalidates the document parameter. The client application should discard all references to this Document and its contents upon calling addDocument. The behavior of an application that continues to use such references is undefined.

        Parameters:
        document - the Document object whose root node will be added to this SOAPBody
        Returns:
        the SOAPBodyElement that represents the root node that was added
        Throws:
        SOAPException - if the Document cannot be added