Top Description Constructors Methods
jakarta.xml.bind.attachment

public abstract Class AttachmentUnmarshaller

extends Object
Class Inheritance
Imports
jakarta.activation.DataHandler

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.

Identifying the content-id, cid, to pass to getAttachment*(String cid)

Authors
Marc Hadley, Kohsuke Kawaguchi, Joseph Fialli
Since
1.6, JAXB 2.0
See Also
jakarta.xml.bind.Unmarshaller#setAttachmentUnmarshaller(AttachmentUnmarshaller), XML-binary Optimized Packaging, WS-I Attachments Profile Version 1.0., Describing Media Content of Binary Data in XML

Constructor Summary

AccessConstructor and Description
protected
AttachmentUnmarshaller()

Do-nothing constructor for the derived classes.

Method Summary

Modifier and TypeMethod and Description
public abstract byte[]

Returns:

byte[] representation of attachment identified by cid.
getAttachmentAsByteArray(String
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)
cid)

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

public abstract DataHandler

Returns:

a DataHandler that represents the MIME attachment.
getAttachmentAsDataHandler(String
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)
cid)

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

public boolean

Returns:

true when MIME context is a XOP Document.
isXOPPackage()

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AttachmentUnmarshallerback to summary
protected AttachmentUnmarshaller()

Do-nothing constructor for the derived classes.

Method Detail

getAttachmentAsByteArrayback to summary
public abstract byte[] getAttachmentAsByteArray(String cid)

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

Parameters
cid:String

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[]

byte[] representation of attachment identified by cid.

Exceptions
IllegalArgumentException:
if the attachment for the given cid is not found.
getAttachmentAsDataHandlerback to summary
public abstract DataHandler getAttachmentAsDataHandler(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:String

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:DataHandler

a DataHandler that represents the MIME attachment.

Exceptions
IllegalArgumentException:
if the attachment for the given cid is not found.
isXOPPackageback to summary
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:boolean

true when MIME context is a XOP Document.