Package com.sun.xml.messaging.saaj.soap.impl

Class EnvelopeImpl

    • Method Detail

      • getHeaderName

        protected abstract NameImpl getHeaderName​(String prefix)

      • getBodyName

        protected abstract NameImpl getBodyName​(String prefix)

      • addHeader

        public SOAPHeader addHeader()
                     throws SOAPException
        Description copied from interface: SOAPEnvelope
        Creates a SOAPHeader object and sets it as the SOAPHeader object for this SOAPEnvelope object.

        It is illegal to add a header when the envelope already contains a header. Therefore, this method should be called only after the existing header has been removed.

        Specified by:
        addHeader in interface SOAPEnvelope
        Returns:
        the new SOAPHeader object
        Throws:
        SOAPException - if this SOAPEnvelope object already contains a valid SOAPHeader object

      • getHeader

        public SOAPHeader getHeader()
                     throws SOAPException
        Description copied from interface: SOAPEnvelope
        Returns the SOAPHeader object for this SOAPEnvelope object.

        A new SOAPMessage object is by default created with a SOAPEnvelope object that contains an empty SOAPHeader object. As a result, the method getHeader will always return a SOAPHeader object unless the header has been removed and a new one has not been added.

        Specified by:
        getHeader in interface SOAPEnvelope
        Returns:
        the SOAPHeader object or null if there is none
        Throws:
        SOAPException - if there is a problem obtaining the SOAPHeader object

      • addBody

        public SOAPBody addBody()
                 throws SOAPException
        Description copied from interface: SOAPEnvelope
        Creates a SOAPBody object and sets it as the SOAPBody object for this SOAPEnvelope object.

        It is illegal to add a body when the envelope already contains a body. Therefore, this method should be called only after the existing body has been removed.

        Specified by:
        addBody in interface SOAPEnvelope
        Returns:
        the new SOAPBody object
        Throws:
        SOAPException - if this SOAPEnvelope object already contains a valid SOAPBody object

      • getBody

        public SOAPBody getBody()
                 throws SOAPException
        Description copied from interface: SOAPEnvelope
        Returns the SOAPBody object associated with this SOAPEnvelope object.

        A new SOAPMessage object is by default created with a SOAPEnvelope object that contains an empty SOAPBody object. As a result, the method getBody will always return a SOAPBody object unless the body has been removed and a new one has not been added.

        Specified by:
        getBody in interface SOAPEnvelope
        Returns:
        the SOAPBody object for this SOAPEnvelope object or null if there is none
        Throws:
        SOAPException - if there is a problem obtaining the SOAPBody object

      • getContent

        public Source getContent()
        Description copied from interface: Envelope
        Get the content as a JAXP Source.
        Specified by:
        getContent in interface Envelope
        Returns:
        source

      • createName

        public Name createName​(String localName,
                       String prefix,
                       String uri)
                throws SOAPException
        Description copied from interface: SOAPEnvelope
        Creates a new Name object initialized with the given local name, namespace prefix, and namespace URI.

        This factory method creates Name objects for use in the SOAP/XML document.

        Specified by:
        createName in interface SOAPEnvelope
        Parameters:
        localName - a String giving the local name
        prefix - a String giving the prefix of the namespace
        uri - a String giving the URI of the namespace
        Returns:
        a Name object initialized with the given local name, namespace prefix, and namespace URI
        Throws:
        SOAPException - if there is a SOAP error

      • createName

        public Name createName​(String localName,
                       String uri)
                throws SOAPException
        Description copied from interface: SOAPEnvelope
        Creates a new Name object initialized with the given local name and namespace prefix.

        This factory method creates Name objects for use in the SOAP/XML document.

        Specified by:
        createName in interface SOAPEnvelope
        Parameters:
        localName - a String giving the local name
        uri - a String giving the URI of the namespace
        Returns:
        a Name object initialized with the given local name, namespace prefix, and namespace URI
        Throws:
        SOAPException - if there is a SOAP error

      • createName

        public Name createName​(String localName)
                throws SOAPException
        Description copied from interface: SOAPEnvelope
        Creates a new Name object initialized with the given local name.

        This factory method creates Name objects for use in the SOAP/XML document.

        Specified by:
        createName in interface SOAPEnvelope
        Parameters:
        localName - a String giving the local name
        Returns:
        a Name object initialized with the given local name
        Throws:
        SOAPException - if there is a SOAP error

      • setOmitXmlDecl

        public void setOmitXmlDecl​(String value)

      • setXmlDecl

        public void setXmlDecl​(String value)

      • setCharsetEncoding

        public void setCharsetEncoding​(String value)

      • output

        public void output​(OutputStream out,
                   boolean isFastInfoset)
            throws IOException
        Serialize to FI if boolean parameter set.
        Specified by:
        output in interface Envelope
        Parameters:
        out - output stream
        isFastInfoset - true if it is fast infoset.
        Throws:
        IOException - in case of an I/O error.

      • setElementQName

        public SOAPElement setElementQName​(QName newName)
                            throws SOAPException
        Description copied from interface: SOAPElement
        Changes the name of this Element to newName if possible. SOAP Defined elements such as SOAPEnvelope, SOAPHeader, SOAPBody etc. cannot have their names changed using this method. Any attempt to do so will result in a SOAPException being thrown.

        Callers should not rely on the element instance being renamed as is. Implementations could end up copying the content of the SOAPElement to a renamed instance.

        Specified by:
        setElementQName in interface SOAPElement
        Overrides:
        setElementQName in class ElementImpl
        Parameters:
        newName - the new name for the Element.
        Returns:
        The renamed Node
        Throws:
        SOAPException - if changing the name of this Element is not allowed.