jakarta.xml.bind.attachment.AttachmentUnmarshaller Maven / Gradle / Ivy
/*
* Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package jakarta.xml.bind.attachment;
import 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, {@link #isXOPPackage()}
* and provides retrieval of binary content stored as attachments by content-id.
*
* Identifying the content-id, cid, to pass to {@code 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 {@code ref:swaRef} specified in
*
* Section 4.4 Referencing Attachments from the SOAP Envelope
*
*
*
* @author Marc Hadley
* @author Kohsuke Kawaguchi
* @author Joseph Fialli
*
* @since 1.6, JAXB 2.0
*
* @see jakarta.xml.bind.Unmarshaller#setAttachmentUnmarshaller(AttachmentUnmarshaller)
*
* @see XML-binary Optimized Packaging
* @see WS-I Attachments Profile Version 1.0.
* @see Describing Media Content of Binary Data in XML
*/
public abstract class AttachmentUnmarshaller {
/**
* Lookup MIME content by content-id, {@code cid}, and return as a {@link DataHandler}.
*
* The returned {@code DataHandler} instance must be configured
* to meet the following required mapping constaint.
*
* Required Mappings between MIME and Java Types
*
*
* MIME Type
* Java Type
*
*
* {@code DataHandler.getContentType()}
* {@code 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.
*
* @param cid It is expected to be a valid lexical form of the XML Schema
* {@code xs:anyURI} datatype. If {@link #isXOPPackage()}{@code ==true},
* it must be a valid URI per the {@code cid:} URI scheme (see RFC 2387)
*
* @return
* a {@link DataHandler} that represents the MIME attachment.
*
* @throws IllegalArgumentException if the attachment for the given cid is not found.
*/
public abstract DataHandler getAttachmentAsDataHandler(String cid);
/**
* Retrieve the attachment identified by content-id, {@code cid}, as a {@code byte[]}.
*
* @param cid It is expected to be a valid lexical form of the XML Schema
* {@code xs:anyURI} datatype. If {@link #isXOPPackage()}{@code ==true},
* it must be a valid URI per the {@code cid:} URI scheme (see RFC 2387)
*
* @return byte[] representation of attachment identified by cid.
*
* @throws IllegalArgumentException if the attachment for the given cid is not found.
*/
public abstract byte[] getAttachmentAsByteArray(String cid);
/**
*
Read-only property that returns true if Jakarta XML Binding unmarshaller needs to perform XOP processing.
*
* This method returns {@code true} when the constraints specified
* in Identifying XOP Documents are met.
* This value must not change during the unmarshalling process.
*
* @return true when MIME context is a XOP Document.
*/
public boolean isXOPPackage() { return false; }
}