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

Class AttachmentPartImpl

java.lang.Object
jakarta.xml.soap.AttachmentPart
com.sun.xml.messaging.saaj.soap.AttachmentPartImpl
public class AttachmentPartImpl extends AttachmentPart
Implementation of attachments.

  • Constructor Details

    • AttachmentPartImpl

      public AttachmentPartImpl()

    • AttachmentPartImpl

      public AttachmentPartImpl(org.jvnet.mimepull.MIMEPart part)

  • Method Details

    • getSize

      public int getSize() throws SOAPException
      Description copied from class: AttachmentPart
      Returns the number of bytes in this AttachmentPart object.
      Specified by:
      getSize in class AttachmentPart
      Returns:
      the size of this AttachmentPart object in bytes or -1 if the size cannot be determined
      Throws:
      SOAPException - if the content of this attachment is corrupted of if there was an exception while trying to determine the size.

    • clearContent

      public void clearContent()
      Description copied from class: AttachmentPart
      Clears out the content of this AttachmentPart object. The MIME header portion is left untouched.
      Specified by:
      clearContent in class AttachmentPart

    • getContent

      public Object getContent() throws SOAPException
      Description copied from class: AttachmentPart
      Gets the content of this AttachmentPart object as a Java object. The type of the returned Java object depends on (1) the DataContentHandler object that is used to interpret the bytes and (2) the Content-Type given in the header.

      For the MIME content types "text/plain", "text/html" and "text/xml", the DataContentHandler object does the conversions to and from the Java types corresponding to the MIME types. For other MIME types,the DataContentHandler object can return an InputStream object that contains the content data as raw bytes.

      A SAAJ-compliant implementation must, as a minimum, return a java.lang.String object corresponding to any content stream with a Content-Type value of text/plain, a javax.xml.transform.stream.StreamSource object corresponding to a content stream with a Content-Type value of text/xml, a java.awt.Image object corresponding to a content stream with a Content-Type value of image/gif or image/jpeg. For those content types that an installed DataContentHandler object does not understand, the DataContentHandler object is required to return a java.io.InputStream object with the raw bytes.

      Specified by:
      getContent in class AttachmentPart
      Returns:
      a Java object with the content of this AttachmentPart object
      Throws:
      SOAPException - if there is no content set into this AttachmentPart object or if there was a data transformation error

    • setContent

      public void setContent(Object object, String contentType) throws IllegalArgumentException
      Description copied from class: AttachmentPart
      Sets the content of this attachment part to that of the given Object and sets the value of the Content-Type header to the given type. The type of the Object should correspond to the value given for the Content-Type. This depends on the particular set of DataContentHandler objects in use.
      Specified by:
      setContent in class AttachmentPart
      Parameters:
      object - the Java object that makes up the content for this attachment part
      contentType - the MIME string that specifies the type of the content
      Throws:
      IllegalArgumentException - may be thrown if the contentType does not match the type of the content object, or if there was no DataContentHandler object for this content object
      See Also:

    • getDataHandler

      public jakarta.activation.DataHandler getDataHandler() throws SOAPException
      Description copied from class: AttachmentPart
      Gets the DataHandler object for this AttachmentPart object.
      Specified by:
      getDataHandler in class AttachmentPart
      Returns:
      the DataHandler object associated with this AttachmentPart object
      Throws:
      SOAPException - if there is no data in this AttachmentPart object

    • setDataHandler

      public void setDataHandler(jakarta.activation.DataHandler dataHandler) throws IllegalArgumentException
      Description copied from class: AttachmentPart
      Sets the given DataHandler object as the data handler for this AttachmentPart object. Typically, on an incoming message, the data handler is automatically set. When a message is being created and populated with content, the setDataHandler method can be used to get data from various data sources into the message.
      Specified by:
      setDataHandler in class AttachmentPart
      Parameters:
      dataHandler - the DataHandler object to be set
      Throws:
      IllegalArgumentException - if there was a problem with the specified DataHandler object

    • removeAllMimeHeaders

      public void removeAllMimeHeaders()
      Description copied from class: AttachmentPart
      Removes all the MIME header entries.
      Specified by:
      removeAllMimeHeaders in class AttachmentPart

    • removeMimeHeader

      public void removeMimeHeader(String header)
      Description copied from class: AttachmentPart
      Removes all MIME headers that match the given name.
      Specified by:
      removeMimeHeader in class AttachmentPart
      Parameters:
      header - the string name of the MIME header/s to be removed

    • getMimeHeader

      public String[] getMimeHeader(String name)
      Description copied from class: AttachmentPart
      Gets all the values of the header identified by the given String.
      Specified by:
      getMimeHeader in class AttachmentPart
      Parameters:
      name - the name of the header; example: "Content-Type"
      Returns:
      a String array giving the value for the specified header
      See Also:

    • setMimeHeader

      public void setMimeHeader(String name, String value)
      Description copied from class: AttachmentPart
      Changes the first header entry that matches the given name to the given value, adding a new header if no existing header matches. This method also removes all matching headers but the first.

      Note that RFC822 headers can only contain US-ASCII characters.

      Specified by:
      setMimeHeader in class AttachmentPart
      Parameters:
      name - a String giving the name of the header for which to search
      value - a String giving the value to be set for the header whose name matches the given name

    • addMimeHeader

      public void addMimeHeader(String name, String value)
      Description copied from class: AttachmentPart
      Adds a MIME header with the specified name and value to this AttachmentPart object.

      Note that RFC822 headers can contain only US-ASCII characters.

      Specified by:
      addMimeHeader in class AttachmentPart
      Parameters:
      name - a String giving the name of the header to be added
      value - a String giving the value of the header to be added

    • getAllMimeHeaders

      public Iterator<MimeHeader> getAllMimeHeaders()
      Description copied from class: AttachmentPart
      Retrieves all the headers for this AttachmentPart object as an iterator over the MimeHeader objects.
      Specified by:
      getAllMimeHeaders in class AttachmentPart
      Returns:
      an Iterator object with all the Mime headers for this AttachmentPart object

    • getMatchingMimeHeaders

      public Iterator<MimeHeader> getMatchingMimeHeaders(String[] names)
      Description copied from class: AttachmentPart
      Retrieves all MimeHeader objects that match a name in the given array.
      Specified by:
      getMatchingMimeHeaders in class AttachmentPart
      Parameters:
      names - a String array with the name(s) of the MIME headers to be returned
      Returns:
      all the MIME headers that match one of the names in the given array as an Iterator object

    • getNonMatchingMimeHeaders

      public Iterator<MimeHeader> getNonMatchingMimeHeaders(String[] names)
      Description copied from class: AttachmentPart
      Retrieves all MimeHeader objects whose name does not match a name in the given array.
      Specified by:
      getNonMatchingMimeHeaders in class AttachmentPart
      Parameters:
      names - a String array with the name(s) of the MIME headers not to be returned
      Returns:
      all the MIME headers in this AttachmentPart object except those that match one of the names in the given array. The nonmatching MIME headers are returned as an Iterator object.

    • copyMimeHeaders

      public static void copyMimeHeaders(MimeHeaders headers, MimeBodyPart mbp) throws SOAPException
      Throws:
      SOAPException

    • copyMimeHeaders

      public static void copyMimeHeaders(MimeBodyPart mbp, AttachmentPartImpl ap) throws SOAPException
      Throws:
      SOAPException

    • setBase64Content

      public void setBase64Content(InputStream content, String contentType) throws SOAPException
      Description copied from class: AttachmentPart
      Sets the content of this attachment part from the Base64 source InputStream and sets the value of the Content-Type header to the value contained in contentType, This method would first decode the base64 input and write the resulting raw bytes to the attachment.

      A subsequent call to getSize() may not be an exact measure of the content size.

      Specified by:
      setBase64Content in class AttachmentPart
      Parameters:
      content - the base64 encoded data to add to the attachment part
      contentType - the value to set into the Content-Type header
      Throws:
      SOAPException - if there is an error in setting the content

    • getBase64Content

      public InputStream getBase64Content() throws SOAPException
      Description copied from class: AttachmentPart
      Returns an InputStream which can be used to obtain the content of AttachmentPart as Base64 encoded character data, this method would base64 encode the raw bytes of the attachment and return.
      Specified by:
      getBase64Content in class AttachmentPart
      Returns:
      an InputStream from which the Base64 encoded AttachmentPart can be read.
      Throws:
      SOAPException - if there is no content set into this AttachmentPart object or if there was a data transformation error.

    • setRawContent

      public void setRawContent(InputStream content, String contentType) throws SOAPException
      Description copied from class: AttachmentPart
      Sets the content of this attachment part to that contained by the InputStream content and sets the value of the Content-Type header to the value contained in contentType.

      A subsequent call to getSize() may not be an exact measure of the content size.

      Specified by:
      setRawContent in class AttachmentPart
      Parameters:
      content - the raw data to add to the attachment part
      contentType - the value to set into the Content-Type header
      Throws:
      SOAPException - if there is an error in setting the content

    • setRawContentBytes

      public void setRawContentBytes(byte[] content, int off, int len, String contentType) throws SOAPException
      Description copied from class: AttachmentPart
      Sets the content of this attachment part to that contained by the byte[] array content and sets the value of the Content-Type header to the value contained in contentType.
      Specified by:
      setRawContentBytes in class AttachmentPart
      Parameters:
      content - the raw data to add to the attachment part
      off - the offset in the byte array of the content
      len - the number of bytes that form the content
      contentType - the value to set into the Content-Type header
      Throws:
      SOAPException - if there is an error in setting the content or content is null

    • getRawContent

      public InputStream getRawContent() throws SOAPException
      Description copied from class: AttachmentPart
      Gets the content of this AttachmentPart object as an InputStream as if a call had been made to getContent and no DataContentHandler had been registered for the content-type of this AttachmentPart.

      Note that reading from the returned InputStream would result in consuming the data in the stream. It is the responsibility of the caller to reset the InputStream appropriately before calling a Subsequent API. If a copy of the raw attachment content is required then the AttachmentPart.getRawContentBytes() API should be used instead.

      Specified by:
      getRawContent in class AttachmentPart
      Returns:
      an InputStream from which the raw data contained by the AttachmentPart can be accessed.
      Throws:
      SOAPException - if there is no content set into this AttachmentPart object or if there was a data transformation error.
      See Also:

    • getRawContentBytes

      public byte[] getRawContentBytes() throws SOAPException
      Description copied from class: AttachmentPart
      Gets the content of this AttachmentPart object as a byte[] array as if a call had been made to getContent and no DataContentHandler had been registered for the content-type of this AttachmentPart.
      Specified by:
      getRawContentBytes in class AttachmentPart
      Returns:
      a byte[] array containing the raw data of the AttachmentPart.
      Throws:
      SOAPException - if there is no content set into this AttachmentPart object or if there was a data transformation error.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getMimeHeaders

      public MimeHeaders getMimeHeaders()

    • initializeJavaActivationHandlers

      public static void initializeJavaActivationHandlers()