/* * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ 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.
* *getAttachment*(String cid)
ref:swaRef
specified in
* Section 4.4 Referencing Attachments from the SOAP Envelope
* 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 | *
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[]
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.