Class SOAPBody

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, Node, SOAPBody, SOAPElement, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList

    public class SOAPBody
    extends MessageElement
    implements SOAPBody
    Holder for body elements.
    Author:
    Glyn Normington (glyn@apache.org)
    See Also:
    Serialized Form
    • Method Detail

      • disableFormatting

        public void disableFormatting()
      • setEncodingStyle

        public void setEncodingStyle​(java.lang.String encodingStyle)
                              throws SOAPException
        Description copied from class: MessageElement
        Sets the encoding style for this SOAPElement object to one specified. The semantics of a null value, as above in getEncodingStyle() are to just use the parent's value, but null here means set to "".
        Specified by:
        setEncodingStyle in interface SOAPElement
        Overrides:
        setEncodingStyle in class MessageElement
        Parameters:
        encodingStyle - a String giving the encoding style
        Throws:
        SOAPException
        See Also:
        getEncodingStyle()
      • outputImpl

        protected void outputImpl​(SerializationContext context)
                           throws java.lang.Exception
        Description copied from class: MessageElement
        override point -output to a serialization context.
        Overrides:
        outputImpl in class MessageElement
        Parameters:
        context - destination.
        Throws:
        java.lang.Exception - if something went wrong.
      • addBodyElement

        public SOAPBodyElement addBodyElement​(Name name)
                                       throws SOAPException
        Description copied from interface: SOAPBody
        Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.
        Specified by:
        addBodyElement in interface SOAPBody
        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

        public SOAPFault addFault​(Name name,
                                  java.lang.String s,
                                  java.util.Locale locale)
                           throws SOAPException
        Description copied from interface: SOAPBody
        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.
        Specified by:
        addFault in interface SOAPBody
        Parameters:
        name - 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
        s - 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

        public SOAPFault addFault​(Name name,
                                  java.lang.String s)
                           throws SOAPException
        Description copied from interface: SOAPBody
        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.
        Specified by:
        addFault in interface SOAPBody
        Parameters:
        name - 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
        s - a String giving an explanation of the fault
        Returns:
        the new SOAPFault object
        Throws:
        SOAPException - if there is a SOAP error
      • addDocument

        public SOAPBodyElement addDocument​(org.w3c.dom.Document document)
                                    throws SOAPException
        Description copied from interface: SOAPBody
        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.

        Specified by:
        addDocument in interface SOAPBody
        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
      • addFault

        public SOAPFault addFault()
                           throws SOAPException
        Description copied from interface: SOAPBody
        Creates a new SOAPFault object and adds it to this SOAPBody object.
        Specified by:
        addFault in interface SOAPBody
        Returns:
        the new SOAPFault object
        Throws:
        SOAPException - if there is a SOAP error
      • getFault

        public SOAPFault getFault()
        Description copied from interface: SOAPBody
        Returns the SOAPFault object in this SOAPBody object.
        Specified by:
        getFault in interface SOAPBody
        Returns:
        the SOAPFault object in this SOAPBody object
      • hasFault

        public boolean hasFault()
        Description copied from interface: SOAPBody
        Indicates whether a SOAPFault object exists in this SOAPBody object.
        Specified by:
        hasFault in interface SOAPBody
        Returns:
        true if a SOAPFault object exists in this SOAPBody object; false otherwise
      • setSAAJEncodingCompliance

        public void setSAAJEncodingCompliance​(boolean comply)