- 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.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
23/11/2024 01:45:01 Cette version de la page est en cache (à la date du 23/11/2024 01:45:01) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/bind/attachment/AttachmentUnmarshaller.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.