Package org.apache.axis2.saaj

Class SOAPMessageImpl

java.lang.Object
jakarta.xml.soap.SOAPMessage
org.apache.axis2.saaj.SOAPMessageImpl
public class SOAPMessageImpl extends jakarta.xml.soap.SOAPMessage

  • Field Summary

    Fields inherited from class jakarta.xml.soap.SOAPMessage

    CHARACTER_SET_ENCODING, WRITE_XML_DECLARATION

  • Constructor Summary

    Constructors
    Constructor
    Description
    SOAPMessageImpl(InputStream inputstream, jakarta.xml.soap.MimeHeaders mimeHeaders, boolean processMTOM)
     
    SOAPMessageImpl(SOAPEnvelopeImpl soapEnvelope)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAttachmentPart(jakarta.xml.soap.AttachmentPart attachmentPart)
    Adds the given AttachmentPart object to this SOAPMessage object.
    int
    countAttachments()
    Gets a count of the number of attachments in this message.
    jakarta.xml.soap.AttachmentPart
    createAttachmentPart()
    Creates a new empty AttachmentPart object.
    jakarta.xml.soap.AttachmentPart
    getAttachment(jakarta.xml.soap.SOAPElement soapelement)
    Returns an AttachmentPart object that is associated with an attachment that is referenced by this SOAPElement or null if no such attachment exists.
    Iterator
    getAttachments()
    Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.
    Iterator
    getAttachments(jakarta.xml.soap.MimeHeaders headers)
    Retrieves all the AttachmentPart objects that have header entries that match the specified headers.
    String
    getContentDescription()
    Retrieves a description of this SOAPMessage object's content.
    jakarta.xml.soap.MimeHeaders
    getMimeHeaders()
    Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.
    Object
    getProperty(String property)
    Retrieves value of the specified property.
    jakarta.xml.soap.SOAPBody
    getSOAPBody()
    Gets the SOAP Body contained in this SOAPMessage object.
    jakarta.xml.soap.SOAPHeader
    getSOAPHeader()
    Gets the SOAP Header contained in this SOAPMessage object.
    jakarta.xml.soap.SOAPPart
    getSOAPPart()
    Gets the SOAP part of this SOAPMessage object.
    void
    removeAllAttachments()
    Removes all AttachmentPart objects that have been added to this SOAPMessage object.
    void
    removeAttachments(jakarta.xml.soap.MimeHeaders headers)
    Removes all the AttachmentPart objects that have header entries that match the specified headers.
    void
    saveChanges()
    Updates this SOAPMessage object with all the changes that have been made to it.
    boolean
    saveRequired()
    Indicates whether this SOAPMessage object has had the method saveChanges() called on it.
    void
    setContentDescription(String description)
    Sets the description of this SOAPMessage object's content with the given description.
    void
    setProperty(String property, Object value)
    Associates the specified value with the specified property.
    void
    setSaveRequired()
     
    void
    writeTo(OutputStream out)
    Writes this SOAPMessage object to the given output stream.

    Methods inherited from class jakarta.xml.soap.SOAPMessage

    createAttachmentPart, createAttachmentPart

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SOAPMessageImpl

      public SOAPMessageImpl(SOAPEnvelopeImpl soapEnvelope)

    • SOAPMessageImpl

      public SOAPMessageImpl(InputStream inputstream, jakarta.xml.soap.MimeHeaders mimeHeaders, boolean processMTOM) throws jakarta.xml.soap.SOAPException
      Throws:
      jakarta.xml.soap.SOAPException

  • Method Details

    • getContentDescription

      public String getContentDescription()
      Retrieves a description of this SOAPMessage object's content.
      Specified by:
      getContentDescription in class jakarta.xml.soap.SOAPMessage
      Returns:
      a String describing the content of this message or null if no description has been set
      See Also:

    • setContentDescription

      public void setContentDescription(String description)
      Sets the description of this SOAPMessage object's content with the given description.
      Specified by:
      setContentDescription in class jakarta.xml.soap.SOAPMessage
      Parameters:
      description - a String describing the content of this message
      See Also:

    • getSOAPPart

      public jakarta.xml.soap.SOAPPart getSOAPPart()
      Gets the SOAP part of this SOAPMessage object.

      If a SOAPMessage object contains one or more attachments, the SOAP Part must be the first MIME body part in the message.

      Specified by:
      getSOAPPart in class jakarta.xml.soap.SOAPMessage
      Returns:
      the SOAPPart object for this SOAPMessage object

    • removeAllAttachments

      public void removeAllAttachments()
      Removes all AttachmentPart objects that have been added to this SOAPMessage object.

      This method does not touch the SOAP part.

      Specified by:
      removeAllAttachments in class jakarta.xml.soap.SOAPMessage

    • countAttachments

      public int countAttachments()
      Gets a count of the number of attachments in this message. This count does not include the SOAP part.
      Specified by:
      countAttachments in class jakarta.xml.soap.SOAPMessage
      Returns:
      the number of AttachmentPart objects that are part of this SOAPMessage object

    • getAttachments

      public Iterator getAttachments()
      Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.
      Specified by:
      getAttachments in class jakarta.xml.soap.SOAPMessage
      Returns:
      an iterator over all the attachments in this message

    • getAttachments

      public Iterator getAttachments(jakarta.xml.soap.MimeHeaders headers)
      Retrieves all the AttachmentPart objects that have header entries that match the specified headers. Note that a returned attachment could have headers in addition to those specified.
      Specified by:
      getAttachments in class jakarta.xml.soap.SOAPMessage
      Parameters:
      headers - a MimeHeaders object containing the MIME headers for which to search
      Returns:
      an iterator over all attachments(AttachmentPart) that have a header that matches one of the given headers

    • addAttachmentPart

      public void addAttachmentPart(jakarta.xml.soap.AttachmentPart attachmentPart)
      Adds the given AttachmentPart object to this SOAPMessage object. An AttachmentPart object must be created before it can be added to a message.
      Specified by:
      addAttachmentPart in class jakarta.xml.soap.SOAPMessage
      Parameters:
      attachmentPart - an AttachmentPart object that is to become part of this SOAPMessage object
      Throws:
      IllegalArgumentException

    • createAttachmentPart

      public jakarta.xml.soap.AttachmentPart createAttachmentPart()
      Creates a new empty AttachmentPart object. Note that the method addAttachmentPart must be called with this new AttachmentPart object as the parameter in order for it to become an attachment to this SOAPMessage object.
      Specified by:
      createAttachmentPart in class jakarta.xml.soap.SOAPMessage
      Returns:
      a new AttachmentPart object that can be populated and added to this SOAPMessage object

    • getMimeHeaders

      public jakarta.xml.soap.MimeHeaders getMimeHeaders()
      Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.
      Specified by:
      getMimeHeaders in class jakarta.xml.soap.SOAPMessage
      Returns:
      a MimeHeaders object containing the MimeHeader objects

    • saveChanges

      public void saveChanges() throws jakarta.xml.soap.SOAPException
      Updates this SOAPMessage object with all the changes that have been made to it. This method is called automatically when a message is sent or written to by the methods ProviderConnection.send, SOAPConnection.call, or SOAPMessage.writeTo. However, if changes are made to a message that was received or to one that has already been sent, the method saveChanges needs to be called explicitly in order to save the changes. The method saveChanges also generates any changes that can be read back (for example, a MessageId in profiles that support a message id). All MIME headers in a message that is created for sending purposes are guaranteed to have valid values only after saveChanges has been called.

      In addition, this method marks the point at which the data from all constituent AttachmentPart objects are pulled into the message.

      Specified by:
      saveChanges in class jakarta.xml.soap.SOAPMessage
      Throws:
      jakarta.xml.soap.SOAPException - if there was a problem saving changes to this message.

    • setSaveRequired

      public void setSaveRequired()

    • saveRequired

      public boolean saveRequired()
      Indicates whether this SOAPMessage object has had the method saveChanges() called on it.
      Specified by:
      saveRequired in class jakarta.xml.soap.SOAPMessage
      Returns:
      true if saveChanges has been called on this message at least once; false otherwise.

    • writeTo

      public void writeTo(OutputStream out) throws jakarta.xml.soap.SOAPException, IOException
      Writes this SOAPMessage object to the given output stream. The externalization format is as defined by the SOAP 1.1 with Attachments specification.

      If there are no attachments, just an XML stream is written out. For those messages that have attachments, writeTo writes a MIME-encoded byte stream.

      Specified by:
      writeTo in class jakarta.xml.soap.SOAPMessage
      Parameters:
      out - the OutputStream object to which this SOAPMessage object will be written
      Throws:
      jakarta.xml.soap.SOAPException - if there was a problem in externalizing this SOAP message
      IOException - if an I/O error occurs

    • setProperty

      public void setProperty(String property, Object value)
      Associates the specified value with the specified property. If there was already a value associated with this property, the old value is replaced.

      The valid property names include WRITE_XML_DECLARATION and CHARACTER_SET_ENCODING. All of these standard SAAJ properties are prefixed by "jakarta.xml.soap". Vendors may also add implementation specific properties. These properties must be prefixed with package names that are unique to the vendor.

      Setting the property WRITE_XML_DECLARATION to "true" will cause an XML Declaration to be written out at the start of the SOAP message. The default value of "false" suppresses this declaration.

      The property CHARACTER_SET_ENCODING defaults to the value "utf-8" which causes the SOAP message to be encoded using UTF-8. Setting CHARACTER_SET_ENCODING to "utf-16" causes the SOAP message to be encoded using UTF-16.

      Some implementations may allow encodings in addition to UTF-8 and UTF-16. Refer to your vendor's documentation for details.

      Overrides:
      setProperty in class jakarta.xml.soap.SOAPMessage
      Parameters:
      property - the property with which the specified value is to be associated
      value - the value to be associated with the specified property

    • getProperty

      public Object getProperty(String property) throws jakarta.xml.soap.SOAPException
      Retrieves value of the specified property.
      Overrides:
      getProperty in class jakarta.xml.soap.SOAPMessage
      Parameters:
      property - the name of the property to retrieve
      Returns:
      the value of the property or null if no such property exists
      Throws:
      jakarta.xml.soap.SOAPException - if the property name is not recognized

    • getAttachment

      public jakarta.xml.soap.AttachmentPart getAttachment(jakarta.xml.soap.SOAPElement soapelement) throws jakarta.xml.soap.SOAPException
      Returns an AttachmentPart object that is associated with an attachment that is referenced by this SOAPElement or null if no such attachment exists. References can be made via an href attribute as described in SOAP Messages with Attachments (http://www.w3.org/TR/SOAPattachments#SOAPReferenceToAttachements) , or via a single Text child node containing a URI as described in the WS-I Attachments Profile 1.0 for elements of schema type ref:swaRef(ref:swaRef (http://www.wsi.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html") ). These two mechanisms must be supported. The support for references via href attribute also implies that this method should also be supported on an element that is an xop:Include element (XOP (http://www.w3.org/2000/xp/Group/3/06/Attachments/XOP.html) ). other reference mechanisms may be supported by individual implementations of this standard. Contact your vendor for details.
      Specified by:
      getAttachment in class jakarta.xml.soap.SOAPMessage
      Parameters:
      element - - The SOAPElement containing the reference to an Attachment
      Returns:
      the referenced AttachmentPart or null if no such AttachmentPart exists or no reference can be found in this SOAPElement.
      Throws:
      jakarta.xml.soap.SOAPException - - if there is an error in the attempt to access the attachment

    • removeAttachments

      public void removeAttachments(jakarta.xml.soap.MimeHeaders headers)
      Removes all the AttachmentPart objects that have header entries that match the specified headers. Note that the removed attachment could have headers in addition to those specified.
      Specified by:
      removeAttachments in class jakarta.xml.soap.SOAPMessage
      Parameters:
      headers - - a MimeHeaders object containing the MIME headers for which to search
      Since:
      SAAJ 1.3

    • getSOAPHeader

      public jakarta.xml.soap.SOAPHeader getSOAPHeader() throws jakarta.xml.soap.SOAPException
      Gets the SOAP Header contained in this SOAPMessage object.
      Overrides:
      getSOAPHeader in class jakarta.xml.soap.SOAPMessage
      Returns:
      the SOAPHeader object contained by this SOAPMessage object
      Throws:
      jakarta.xml.soap.SOAPException - if the SOAP Header does not exist or cannot be retrieved

    • getSOAPBody

      public jakarta.xml.soap.SOAPBody getSOAPBody() throws jakarta.xml.soap.SOAPException
      Gets the SOAP Body contained in this SOAPMessage object.
      Overrides:
      getSOAPBody in class jakarta.xml.soap.SOAPMessage
      Returns:
      the SOAPBody object contained by this SOAPMessage object
      Throws:
      jakarta.xml.soap.SOAPException - if the SOAP Body does not exist or cannot be retrieved