- 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.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/xml/bind/attachment/attachmentunmarshaller.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.