public abstract class AttachmentUnmarshaller
extends java.lang.Object
Enables Jakarta XML Binding unmarshalling of a root document containing optimized binary data formats.
This API enables an efficient cooperative processing of optimized binary data formats between a Jakarta XML Binding implementation and MIME-based package processor (MTOM/XOP and WS-I AP 1.0). Jakarta XML Binding 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.
getAttachment*(String cid)ref:swaRef specified in
Section 4.4 Referencing Attachments from the SOAP Envelope
| Modifier | Constructor and Description |
|---|---|
protected |
AttachmentUnmarshaller()
Do-nothing constructor for the derived classes.
|
| Modifier and Type | Method and Description |
|---|---|
abstract byte[] |
getAttachmentAsByteArray(java.lang.String cid)
Retrieve the attachment identified by content-id,
cid, as a byte[]. |
abstract 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.
|
protected AttachmentUnmarshaller()
public abstract 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.
| 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 |
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)DataHandler that represents the MIME attachment.java.lang.IllegalArgumentException - if the attachment for the given cid is not found.public abstract byte[] getAttachmentAsByteArray(java.lang.String cid)
Retrieve the attachment identified by content-id, cid, as a byte[].
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)java.lang.IllegalArgumentException - if the attachment for the given cid is not found.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.