- java.lang.Object
-
- javax.xml.bind.attachment.AttachmentUnmarshaller
-
public abstract class AttachmentUnmarshaller extends Object
Enables JAXB unmarshalling of a root document containing optimized binary data formats.
This API enables an efficient cooperative processing of optimized binary data formats between a JAXB 2.0 implementation and MIME-based package processor (MTOM/XOP and WS-I AP 1.0). JAXB unmarshals the body of a package, delegating the understanding of the packaging format being used to a MIME-based package processor that implements this abstract class.
This abstract class identifies if a package requires XOP processing,
isXOPPackage()
and provides retrieval of binary content stored as attachments by content-id.Identifying the content-id, cid, to pass to getAttachment*(String cid)
- For XOP processing, the infoset representation of the cid is described in step 2a in Section 3.2 Interpreting XOP Packages
-
For WS-I AP 1.0, the cid is identified as an element or attribute of
type
ref:swaRef
specified in Section 4.4 Referencing Attachments from the SOAP Envelope
-
-
Constructor Summary
Constructors Constructor and Description AttachmentUnmarshaller()
-
Method Summary
Methods Modifier and Type Method and Description abstract byte[]
getAttachmentAsByteArray(String cid)
Retrieve the attachment identified by content-id,cid
, as a byte[]abstract DataHandler
getAttachmentAsDataHandler(String cid)
Lookup MIME content by content-id,cid
, and return as aDataHandler
.boolean
isXOPPackage()
Read-only property that returns true if JAXB unmarshaller needs to perform XOP processing.
-
-
-
Method Detail
-
getAttachmentAsDataHandler
public abstract DataHandler getAttachmentAsDataHandler(String cid)
Lookup MIME content by content-id,
cid
, and return as aDataHandler
.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 - Parameters:
cid
- It is expected to be a valid lexical form of the XML Schemaxs:anyURI
datatype. If
, it must be a valid URI per theisXOPPackage()
==truecid:
URI scheme (see RFC 2387)- Returns:
- a
DataHandler
that represents the MIME attachment. - Throws:
IllegalArgumentException
- if the attachment for the given cid is not found.
-
getAttachmentAsByteArray
public abstract byte[] getAttachmentAsByteArray(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 Schemaxs:anyURI
datatype. If
, it must be a valid URI per theisXOPPackage()
==truecid:
URI scheme (see RFC 2387)- Returns:
- byte[] representation of attachment identified by cid.
- Throws:
IllegalArgumentException
- if the attachment for the given cid is not found.
-
isXOPPackage
public boolean isXOPPackage()
Read-only property that returns true if JAXB 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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/bind/attachment/attachmentunmarshaller.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.