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

Class MessageImpl

java.lang.Object
jakarta.xml.soap.SOAPMessage
com.sun.xml.messaging.saaj.soap.MessageImpl
All Implemented Interfaces:
SOAPConstants
Direct Known Subclasses:
Message1_1Impl, Message1_2Impl
public abstract class MessageImpl extends SOAPMessage implements SOAPConstants
The message implementation for SOAP messages with attachments. Messages for specific profiles will likely extend this MessageImpl class and add more value for that particular profile.

  • Field Details

    • CONTENT_ID

      public static final String CONTENT_ID
      See Also:

    • CONTENT_LOCATION

      public static final String CONTENT_LOCATION
      See Also:

    • PLAIN_XML_FLAG

      protected static final int PLAIN_XML_FLAG
      See Also:

    • MIME_MULTIPART_FLAG

      protected static final int MIME_MULTIPART_FLAG
      See Also:

    • SOAP1_1_FLAG

      protected static final int SOAP1_1_FLAG
      See Also:

    • SOAP1_2_FLAG

      protected static final int SOAP1_2_FLAG
      See Also:

    • MIME_MULTIPART_XOP_SOAP1_1_FLAG

      protected static final int MIME_MULTIPART_XOP_SOAP1_1_FLAG
      See Also:

    • MIME_MULTIPART_XOP_SOAP1_2_FLAG

      protected static final int MIME_MULTIPART_XOP_SOAP1_2_FLAG
      See Also:

    • XOP_FLAG

      protected static final int XOP_FLAG
      See Also:

    • FI_ENCODED_FLAG

      protected static final int FI_ENCODED_FLAG
      See Also:

    • headers

      protected MimeHeaders headers

    • contentType

      protected ContentType contentType

    • soapPartImpl

      protected SOAPPartImpl soapPartImpl

    • attachments

      protected FinalArrayList<AttachmentPart> attachments

    • saved

      protected boolean saved

    • messageBytes

      protected byte[] messageBytes

    • messageByteCount

      protected int messageByteCount

    • properties

      protected Map<String,Object> properties

    • multiPart

      protected MimeMultipart multiPart

    • attachmentsInitialized

      protected boolean attachmentsInitialized

    • isFastInfoset

      protected boolean isFastInfoset
      True if this part is encoded using Fast Infoset. MIME -> application/fastinfoset

    • acceptFastInfoset

      protected boolean acceptFastInfoset
      True if the Accept header of this message includes application/fastinfoset

    • mmp

      protected MimeMultipart mmp

    • LAZY_SOAP_BODY_PARSING

      public static final String LAZY_SOAP_BODY_PARSING
      See Also:

    • SAAJ_MIME_SOAP_BODY_PART_SIZE_LIMIT

      public static final String SAAJ_MIME_SOAP_BODY_PART_SIZE_LIMIT
      See Also:

  • Constructor Details

    • MessageImpl

      protected MessageImpl()
      Construct a new message. This will be invoked before message sends.

    • MessageImpl

      protected MessageImpl(boolean isFastInfoset, boolean acceptFastInfoset)
      Construct a new message. This will be invoked before message sends.
      Parameters:
      isFastInfoset - whether it is fast infoset
      acceptFastInfoset - whether to accept fast infoset

    • MessageImpl

      protected MessageImpl(SOAPMessage msg)
      Shallow copy.
      Parameters:
      msg - SoapMessage

    • MessageImpl

      protected MessageImpl(MimeHeaders headers, InputStream in) throws SOAPExceptionImpl
      Construct a message from an input stream. When messages are received, there's two parts -- the transport headers and the message content in a transport specific stream.
      Parameters:
      headers - MimeHeaders
      in - InputStream
      Throws:
      SOAPExceptionImpl - in case of I/O error

    • MessageImpl

      protected MessageImpl(MimeHeaders headers, ContentType contentType, int stat, InputStream in) throws SOAPExceptionImpl
      Construct a message from an input stream. When messages are received, there's two parts -- the transport headers and the message content in a transport specific stream.
      Parameters:
      headers - headers
      contentType - The parsed content type header from the headers variable. This is redundant parameter, but it avoids reparsing this header again.
      stat - The result of identifyContentType(ContentType) over the contentType parameter. This redundant parameter, but it avoids recomputing this information again.
      in - input stream
      Throws:
      SOAPExceptionImpl - in case of an error

    • MessageImpl

      protected MessageImpl(MimeHeaders headers, ContentType ct, int stat, XMLStreamReader reader) throws SOAPExceptionImpl
      Throws:
      SOAPExceptionImpl

  • Method Details

    • isSoap1_1Content

      protected static boolean isSoap1_1Content(int stat)
      Parameters:
      stat - the mask value obtained from identifyContentType(ContentType)
      Returns:
      true if SOAP 1.1 Content

    • isSoap1_2Content

      protected static boolean isSoap1_2Content(int stat)
      Check whether it is SOAP 1.2 content.
      Parameters:
      stat - the mask value obtained from identifyContentType(ContentType)
      Returns:
      true if it is SOAP 1.2 content

    • isFastInfoset

      public boolean isFastInfoset()

    • acceptFastInfoset

      public boolean acceptFastInfoset()

    • setIsFastInfoset

      public void setIsFastInfoset(boolean value)

    • isLazySoapBodyParsing

      public boolean isLazySoapBodyParsing()

    • getProperty

      public Object getProperty(String property)
      Description copied from class: SOAPMessage
      Retrieves value of the specified property.
      Overrides:
      getProperty in class SOAPMessage
      Parameters:
      property - the name of the property to retrieve
      Returns:
      the value associated with the named property or null if no such property exists.

    • setProperty

      public void setProperty(String property, Object value)
      Description copied from class: SOAPMessage
      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 SOAPMessage.WRITE_XML_DECLARATION and SOAPMessage.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 SOAPMessage
      Parameters:
      property - the property with which the specified value is to be associated.
      value - the value to be associated with the specified property

    • isCorrectSoapVersion

      protected abstract boolean isCorrectSoapVersion(int contentTypeId)

    • getExpectedContentType

      protected abstract String getExpectedContentType()

    • getExpectedAcceptHeader

      protected abstract String getExpectedAcceptHeader()

    • getMimeHeaders

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

    • getContentType

      public String getContentType()

    • setContentType

      public void setContentType(String type)

    • getBaseType

      public String getBaseType()

    • setBaseType

      public void setBaseType(String type)

    • getAction

      public String getAction()

    • setAction

      public void setAction(String action)

    • getCharset

      public String getCharset()

    • setCharset

      public void setCharset(String charset)

    • saveRequired

      public boolean saveRequired()
      Description copied from class: SOAPMessage
      Indicates whether this SOAPMessage object needs to have the method saveChanges called on it.
      Specified by:
      saveRequired in class SOAPMessage
      Returns:
      true if saveChanges needs to be called; false otherwise.

    • getContentDescription

      public String getContentDescription()
      Description copied from class: SOAPMessage
      Retrieves a description of this SOAPMessage object's content.
      Specified by:
      getContentDescription in class 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)
      Description copied from class: SOAPMessage
      Sets the description of this SOAPMessage object's content with the given description.
      Specified by:
      setContentDescription in class SOAPMessage
      Parameters:
      description - a String describing the content of this message
      See Also:

    • getSOAPPart

      public abstract SOAPPart getSOAPPart()
      Description copied from class: SOAPMessage
      Gets the SOAP part of this SOAPMessage object.

      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 SOAPMessage
      Returns:
      the SOAPPart object for this SOAPMessage object

    • removeAllAttachments

      public void removeAllAttachments()
      Description copied from class: SOAPMessage
      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 SOAPMessage

    • countAttachments

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

    • addAttachmentPart

      public void addAttachmentPart(AttachmentPart attachment)
      Description copied from class: SOAPMessage
      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 SOAPMessage
      Parameters:
      attachment - an attachmentPart object that is to become part of this SOAPMessage object

    • getAttachments

      public Iterator<AttachmentPart> getAttachments()
      Description copied from class: SOAPMessage
      Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.
      Specified by:
      getAttachments in class SOAPMessage
      Returns:
      an iterator over all the attachments in this message

    • getAttachments

      public Iterator<AttachmentPart> getAttachments(MimeHeaders headers)
      Description copied from class: SOAPMessage
      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 SOAPMessage
      Parameters:
      headers - a MimeHeaders object containing the MIME headers for which to search
      Returns:
      an iterator over all attachments that have a header that matches one of the given headers

    • removeAttachments

      public void removeAttachments(MimeHeaders headers)
      Description copied from class: SOAPMessage
      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 SOAPMessage
      Parameters:
      headers - a MimeHeaders object containing the MIME headers for which to search

    • createAttachmentPart

      public AttachmentPart createAttachmentPart()
      Description copied from class: SOAPMessage
      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 SOAPMessage
      Returns:
      a new AttachmentPart object that can be populated and added to this SOAPMessage object

    • getAttachment

      public AttachmentPart getAttachment(SOAPElement element) throws SOAPException
      Description copied from class: SOAPMessage
      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, 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. 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). other reference mechanisms may be supported by individual implementations of this standard. Contact your vendor for details.
      Specified by:
      getAttachment in class 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:
      SOAPException - if there is an error in the attempt to access the attachment

    • saveChanges

      public void saveChanges() throws SOAPException
      Description copied from class: SOAPMessage
      Updates this SOAPMessage object with all the changes that have been made to it. This method is called automatically when SOAPMessage.writeTo(OutputStream) is called. 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 SOAPMessage
      Throws:
      SOAPException - if there was a problem saving changes to this message.

    • writeTo

      public void writeTo(OutputStream out) throws SOAPException, IOException
      Description copied from class: SOAPMessage
      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.

      Note that this method does not write the transport-specific MIME Headers of the Message

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

    • getSOAPBody

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

    • getSOAPHeader

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

    • setLazyAttachments

      public void setLazyAttachments(boolean flag)