Class AttachmentUnmarshaller

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AttachmentUnmarshaller()
      Do-nothing constructor for the derived classes.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract byte[] getAttachmentAsByteArray​(java.lang.String cid)
      Retrieve the attachment identified by content-id, cid, as a byte[].
      abstract jakarta.activation.DataHandler getAttachmentAsDataHandler​(java.lang.String cid)
      Lookup MIME content by content-id, cid, and return as a DataHandler.
      boolean isXOPPackage()
      Read-only property that returns true if Jakarta XML Binding unmarshaller needs to perform XOP processing.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AttachmentUnmarshaller

        protected AttachmentUnmarshaller()
        Do-nothing constructor for the derived classes.
    • Method Detail

      • getAttachmentAsDataHandler

        public abstract jakarta.activation.DataHandler getAttachmentAsDataHandler​(java.lang.String cid)

        Lookup MIME content by content-id, cid, and return as a DataHandler.

        The returned DataHandler instance must be configured to meet the following required mapping constaint.

        Required Mappings between MIME and Java Types
        MIME Type Java Type
        DataHandler.getContentType() instanceof DataHandler.getContent()
        image/gif java.awt.Image
        image/jpeg java.awt.Image
        text/xml or application/xml javax.xml.transform.Source
        Note that it is allowable to support additional mappings.
        Parameters:
        cid - It is expected to be a valid lexical form of the XML Schema xs:anyURI datatype. If isXOPPackage()==true, it must be a valid URI per the cid: URI scheme (see RFC 2387)
        Returns:
        a DataHandler that represents the MIME attachment.
        Throws:
        java.lang.IllegalArgumentException - if the attachment for the given cid is not found.
      • getAttachmentAsByteArray

        public abstract byte[] getAttachmentAsByteArray​(java.lang.String cid)

        Retrieve the attachment identified by content-id, cid, as a byte[].

        Parameters:
        cid - It is expected to be a valid lexical form of the XML Schema xs:anyURI datatype. If isXOPPackage()==true, it must be a valid URI per the cid: URI scheme (see RFC 2387)
        Returns:
        byte[] representation of attachment identified by cid.
        Throws:
        java.lang.IllegalArgumentException - if the attachment for the given cid is not found.
      • isXOPPackage

        public boolean isXOPPackage()

        Read-only property that returns true if Jakarta XML Binding unmarshaller needs to perform XOP processing.

        This method returns true when the constraints specified in Identifying XOP Documents are met. This value must not change during the unmarshalling process.

        Returns:
        true when MIME context is a XOP Document.