Package org.apache.axis2.saaj

Class AttachmentPartImpl

java.lang.Object
jakarta.xml.soap.AttachmentPart
org.apache.axis2.saaj.AttachmentPartImpl
public class AttachmentPartImpl extends jakarta.xml.soap.AttachmentPart

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttachmentPartImpl()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMimeHeader(String name, String value)
    Adds a MIME header with the specified name and value to this AttachmentPart object.
    void
    clearContent()
    Clears out the content of this AttachmentPart object.
    void
    detachAttachmentFile()
    Detach the attachment file from this class, so it is not cleaned up.
    Iterator
    getAllMimeHeaders()
    Retrieves all the headers for this AttachmentPart object as an iterator over the MimeHeader objects.
    String
    getAttachmentFile()
    Get the filename of this attachment.
    InputStream
    getBase64Content()
     
    Object
    getContent()
    Gets the content of this AttachmentPart object as a Java object.
    jakarta.activation.DataHandler
    getDataHandler()
    Gets the DataHandler object for this AttachmentPart object.
    Iterator
    getMatchingMimeHeaders(String[] names)
    Retrieves all MimeHeader objects that match a name in the given array.
    String[]
    getMimeHeader(String name)
    Gets all the values of the header identified by the given String.
    Iterator
    getNonMatchingMimeHeaders(String[] names)
    Retrieves all MimeHeader objects whose name does not match a name in the given array.
    org.apache.axiom.om.OMText
    getOMText()
    Retrieve the OMText
    InputStream
    getRawContent()
    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.
    byte[]
    getRawContentBytes()
    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.
    int
    getSize()
    Returns the number of bytes in this AttachmentPart object.
    boolean
    isAttachmentReferenced()
     
    boolean
    matches(jakarta.xml.soap.MimeHeaders headers)
    Check whether at least one of the headers of this object matches a provided header
    void
    removeAllMimeHeaders()
    Removes all the MIME header entries.
    void
    removeMimeHeader(String header)
    Removes all MIME headers that match the given name.
    protected void
    setAttachmentFile(String path)
    Set the filename of this attachment part.
    void
    setAttachmentReferenced(boolean attachmentReferenced)
     
    void
    setBase64Content(InputStream content, String contentType)
    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.
    void
    setContent(Object object, String contentType)
    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.
    void
    setDataHandler(jakarta.activation.DataHandler datahandler)
    Sets the given DataHandler object as the data handler for this AttachmentPart object.
    void
    setMimeHeader(String name, String value)
    Changes the first header entry that matches the given name to the given value, adding a new header if no existing header matches.
    void
    setRawContent(InputStream content, String contentType)
    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.
    void
    setRawContentBytes(byte[] content, int offset, int len, String contentType)
    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.

    Methods inherited from class jakarta.xml.soap.AttachmentPart

    getContentId, getContentLocation, getContentType, setContentId, setContentLocation, setContentType

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AttachmentPartImpl

      public AttachmentPartImpl()

  • Method Details

    • matches

      public boolean matches(jakarta.xml.soap.MimeHeaders headers)
      Check whether at least one of the headers of this object matches a provided header
      Parameters:
      headers -
      Returns:
      true if at least one header of this AttachmentPart matches a header in the provided headers parameter, false if none of the headers of this AttachmentPart matches at least one of the header in the provided headers parameter

    • isAttachmentReferenced

      public boolean isAttachmentReferenced()

    • setAttachmentReferenced

      public void setAttachmentReferenced(boolean attachmentReferenced)

    • getSize

      public int getSize() throws jakarta.xml.soap.SOAPException
      Returns the number of bytes in this AttachmentPart object.
      Specified by:
      getSize in class jakarta.xml.soap.AttachmentPart
      Returns:
      the size of this AttachmentPart object in bytes or -1 if the size cannot be determined
      Throws:
      jakarta.xml.soap.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()
      Clears out the content of this AttachmentPart object. The MIME header portion is left untouched.
      Specified by:
      clearContent in class jakarta.xml.soap.AttachmentPart

    • getContent

      public Object getContent() throws jakarta.xml.soap.SOAPException
      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
      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 JAXM-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.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 jakarta.xml.soap.AttachmentPart
      Returns:
      a Java object with the content of this AttachmentPart object
      Throws:
      jakarta.xml.soap.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)
      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 jakarta.xml.soap.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 - 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 jakarta.xml.soap.SOAPException
      Gets the DataHandler object for this AttachmentPart object.
      Specified by:
      getDataHandler in class jakarta.xml.soap.AttachmentPart
      Returns:
      the DataHandler object associated with this AttachmentPart object
      Throws:
      jakarta.xml.soap.SOAPException - if there is no data in this AttachmentPart object

    • setDataHandler

      public void setDataHandler(jakarta.activation.DataHandler datahandler)
      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 jakarta.xml.soap.AttachmentPart
      Parameters:
      datahandler - DataHandler object to be set
      Throws:
      IllegalArgumentException - if there was a problem with the specified DataHandler object

    • removeMimeHeader

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

    • removeAllMimeHeaders

      public void removeAllMimeHeaders()
      Removes all the MIME header entries.
      Specified by:
      removeAllMimeHeaders in class jakarta.xml.soap.AttachmentPart

    • getMimeHeader

      public String[] getMimeHeader(String name)
      Gets all the values of the header identified by the given String.
      Specified by:
      getMimeHeader in class jakarta.xml.soap.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)
      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 jakarta.xml.soap.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
      Throws:
      IllegalArgumentException - if there was a problem with the specified mime header name or value

    • addMimeHeader

      public void addMimeHeader(String name, String value)
      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 jakarta.xml.soap.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
      Throws:
      IllegalArgumentException - if there was a problem with the specified mime header name or value

    • getAllMimeHeaders

      public Iterator getAllMimeHeaders()
      Retrieves all the headers for this AttachmentPart object as an iterator over the MimeHeader objects.
      Specified by:
      getAllMimeHeaders in class jakarta.xml.soap.AttachmentPart
      Returns:
      an Iterator object with all of the Mime headers for this AttachmentPart object

    • getMatchingMimeHeaders

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

    • getNonMatchingMimeHeaders

      public Iterator getNonMatchingMimeHeaders(String[] names)
      Retrieves all MimeHeader objects whose name does not match a name in the given array.
      Specified by:
      getNonMatchingMimeHeaders in class jakarta.xml.soap.AttachmentPart
      Parameters:
      names - a String array with the name(s) of the MIME headers not to be returned
      Returns:
      all of 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.

    • getBase64Content

      public InputStream getBase64Content() throws jakarta.xml.soap.SOAPException
      Specified by:
      getBase64Content in class jakarta.xml.soap.AttachmentPart
      Throws:
      jakarta.xml.soap.SOAPException

    • getRawContent

      public InputStream getRawContent() throws jakarta.xml.soap.SOAPException
      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 getRawContentBytes() API should be used instead.
      Specified by:
      getRawContent in class jakarta.xml.soap.AttachmentPart
      Returns:
      an InputStream from which the raw data contained by the AttachmentPart can be accessed.
      Throws:
      jakarta.xml.soap.SOAPException - - if there is no content set into this AttachmentPart object or if there was a data transformation error.
      Since:
      SAAJ 1.3

    • getRawContentBytes

      public byte[] getRawContentBytes() throws jakarta.xml.soap.SOAPException
      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 jakarta.xml.soap.AttachmentPart
      Returns:
      a byte[] array containing the raw data of the AttachmentPart.
      Throws:
      jakarta.xml.soap.SOAPException - - if there is no content set into this AttachmentPart object or if there was a data transformation error.
      Since:
      SAAJ 1.3

    • setBase64Content

      public void setBase64Content(InputStream content, String contentType) throws jakarta.xml.soap.SOAPException
      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 jakarta.xml.soap.AttachmentPart
      Parameters:
      content - - the base64 encoded data to add to the attachment part contentType - the value to set into the Content-Type header
      Throws:
      jakarta.xml.soap.SOAPException - - if there is an error in setting the content java.lang.NullPointerException - if content is null

    • setRawContent

      public void setRawContent(InputStream content, String contentType) throws jakarta.xml.soap.SOAPException
      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 jakarta.xml.soap.AttachmentPart
      Parameters:
      content - - the raw data to add to the attachment part contentType - the value to set into the Content-Type header
      Throws:
      jakarta.xml.soap.SOAPException - - if there is an error in setting the content java.lang.NullPointerException - if content is null

    • setRawContentBytes

      public void setRawContentBytes(byte[] content, int offset, int len, String contentType) throws jakarta.xml.soap.SOAPException
      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 jakarta.xml.soap.AttachmentPart
      Parameters:
      content - - the raw data to add to the attachment part contentType - the value to set into the Content-Type header offset - the offset in the byte array of the content len - the number of bytes that form the content
      Throws:
      jakarta.xml.soap.SOAPException - - if an there is an error in setting the content or content is null
      Since:
      SAAJ 1.3

    • getOMText

      public org.apache.axiom.om.OMText getOMText() throws jakarta.xml.soap.SOAPException
      Retrieve the OMText
      Returns:
      the OMText
      Throws:
      jakarta.xml.soap.SOAPException - If omText is not available

    • setAttachmentFile

      protected void setAttachmentFile(String path)
      Set the filename of this attachment part.
      Parameters:
      path - the new file path

    • detachAttachmentFile

      public void detachAttachmentFile()
      Detach the attachment file from this class, so it is not cleaned up. This has the side-effect of making subsequent calls to getAttachmentFile() return null.

    • getAttachmentFile

      public String getAttachmentFile()
      Get the filename of this attachment.
      Returns:
      the filename or null for an uncached file