spinjar.javax.xml.bind.attachment.AttachmentUnmarshaller Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.bind.attachment;
import javax.activation.DataHandler;
/**
* 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, {@link #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
*
*
*
* @author Marc Hadley
* @author Kohsuke Kawaguchi
* @author Joseph Fialli
*
* @since JAXB 2.0
*
* @see javax.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, cid, and return as a {@link 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.
*
* @param cid It is expected to be a valid lexical form of the XML Schema
* xs:anyURI datatype. If {@link #isXOPPackage()}
* ==true, it must be a valid URI per the 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, cid, as a byte[]
.
*
* @param cid It is expected to be a valid lexical form of the XML Schema
* xs:anyURI datatype. If {@link #isXOPPackage()}
* ==true, it must be a valid URI per the 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 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.
*
* @return true when MIME context is a XOP Document.
*/
public boolean isXOPPackage() { return false; }
}