Class AttachmentUnmarshaller
- 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:swaRefspecified in Section 4.4 Referencing Attachments from the SOAP Envelope
-
-
Constructor Summary
Constructors Constructor and Description AttachmentUnmarshaller()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description abstract byte[]getAttachmentAsByteArray(String cid)Retrieve the attachment identified by content-id,cid, as a byte[]abstract DataHandlergetAttachmentAsDataHandler(String cid)Lookup MIME content by content-id,cid, and return as aDataHandler.booleanisXOPPackage()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
DataHandlerinstance must be configured to meet the following required mapping constaint.
Note that it is allowable to support additional mappings.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:anyURIdatatype. IfisXOPPackage()==truecid:URI scheme (see RFC 2387) - Returns:
-
a
DataHandlerthat 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:anyURIdatatype. IfisXOPPackage()==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
truewhen 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.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
