View Javadoc
1   /*
2    * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package javax.xml.bind.attachment;
27  
28  import javax.activation.DataHandler;
29  import javax.xml.bind.Marshaller;
30  
31  /**
32   * <p>Enable JAXB marshalling to optimize storage of binary data.</p>
33   *
34   * <p>This API enables an efficient cooperative creation of optimized
35   * binary data formats between a JAXB marshalling process and a MIME-based package
36   * processor. A JAXB implementation marshals the root body of a MIME-based package,
37   * delegating the creation of referenceable MIME parts to
38   * the MIME-based package processor that implements this abstraction.</p>
39   *
40   * <p>XOP processing is enabled when {@link #isXOPPackage()} is true.
41   *    See {@link #addMtomAttachment(DataHandler, String, String)} for details.
42   * </p>
43   *
44   * <p>WS-I Attachment Profile 1.0 is supported by
45   * {@link #addSwaRefAttachment(DataHandler)} being called by the
46   * marshaller for each JAXB property related to
47   * {http://ws-i.org/profiles/basic/1.1/xsd}swaRef.</p>
48   *
49   *
50   * @author Marc Hadley
51   * @author Kohsuke Kawaguchi
52   * @author Joseph Fialli
53   * @since JAXB 2.0
54   *
55   * @see Marshaller#setAttachmentMarshaller(AttachmentMarshaller)
56   *
57   * @see <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/">XML-binary Optimized Packaging</a>
58   * @see <a href="http://www.ws-i.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html">WS-I Attachments Profile Version 1.0.</a>
59   */
60  public abstract class AttachmentMarshaller {
61  
62      /**
63       * <p>Consider MIME content <code>data</code> for optimized binary storage as an attachment.
64       *
65       * <p>
66       * This method is called by JAXB marshal process when {@link #isXOPPackage()} is
67       * <code>true</code>, for each element whose datatype is "base64Binary", as described in
68       * Step 3 in
69       * <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/#creating_xop_packages">Creating XOP Packages</a>.
70       *
71       * <p>
72       * The method implementor determines whether <code>data</code> shall be attached separately
73       * or inlined as base64Binary data. If the implementation chooses to optimize the storage
74       * of the binary data as a MIME part, it is responsible for attaching <code>data</code> to the
75       * MIME-based package, and then assigning an unique content-id, cid, that identifies
76       * the MIME part within the MIME message. This method returns the cid,
77       * which enables the JAXB marshaller to marshal a XOP element that refers to that cid in place
78       * of marshalling the binary data. When the method returns null, the JAXB marshaller
79       * inlines <code>data</code> as base64binary data.
80       *
81       * <p>
82       * The caller of this method is required to meet the following constraint.
83       * If the element infoset item containing <code>data</code> has the attribute
84       * <code>xmime:contentType</code> or if the JAXB property/field representing
85       * <code>data</code>is annotated with a known MIME type,
86       * <code>data.getContentType()</code> should be set to that MIME type.
87       *
88       * <p>
89       * The <code>elementNamespace</code> and <code>elementLocalName</code>
90       * parameters provide the
91       * context that contains the binary data. This information could
92       * be used by the MIME-based package processor to determine if the
93       * binary data should be inlined or optimized as an attachment.
94       *
95       * @param data
96       *       represents the data to be attached. Must be non-null.
97       * @param elementNamespace
98       *      the namespace URI of the element that encloses the base64Binary data.
99       *      Can be empty but never null.
100      * @param elementLocalName
101      *      The local name of the element. Always a non-null valid string.
102      *
103      * @return
104      *     a valid content-id URI (see <a href="http://www.w3.org/TR/xop10/#RFC2387">RFC 2387</a>) that identifies the attachment containing <code>data</code>.
105      *     Otherwise, null if the attachment was not added and should instead be inlined in the message.
106      *
107      * @see <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/">XML-binary Optimized Packaging</a>
108      * @see <a href="http://www.w3.org/TR/xml-media-types/">Describing Media Content of Binary Data in XML</a>
109      */
110     public abstract String addMtomAttachment(DataHandler data, String elementNamespace, String elementLocalName);
111 
112     /**
113      * <p>Consider binary <code>data</code> for optimized binary storage as an attachment.
114      *
115      * <p>Since content type is not known, the attachment's MIME content type must be set to "application/octet-stream".</p>
116      *
117      * <p>
118      * The <code>elementNamespace</code> and <code>elementLocalName</code>
119      * parameters provide the
120      * context that contains the binary data. This information could
121      * be used by the MIME-based package processor to determine if the
122      * binary data should be inlined or optimized as an attachment.
123      *
124      * @param data
125      *      represents the data to be attached. Must be non-null. The actual data region is
126      *      specified by <tt>(data,offset,length)</tt> tuple.
127      *
128      * @param offset
129      *       The offset within the array of the first byte to be read;
130      *       must be non-negative and no larger than array.length
131      *
132      * @param length
133      *       The number of bytes to be read from the given array;
134      *       must be non-negative and no larger than array.length
135      *
136      * @param mimeType
137      *      If the data has an associated MIME type known to JAXB, that is passed
138      *      as this parameter. If none is known, "application/octet-stream".
139      *      This parameter may never be null.
140      *
141      * @param elementNamespace
142      *      the namespace URI of the element that encloses the base64Binary data.
143      *      Can be empty but never null.
144      *
145      * @param elementLocalName
146      *      The local name of the element. Always a non-null valid string.
147      *
148      * @return content-id URI, cid, to the attachment containing
149      *         <code>data</code> or null if data should be inlined.
150      *
151      * @see #addMtomAttachment(DataHandler, String, String)
152      */
153     public abstract String addMtomAttachment(byte[] data, int offset, int length, String mimeType, String elementNamespace, String elementLocalName);
154 
155     /**
156      * <p>Read-only property that returns true if JAXB marshaller should enable XOP creation.</p>
157      *
158      * <p>This value must not change during the marshalling process. When this
159      * value is true, the <code>addMtomAttachment(...)</code> method
160      * is invoked when the appropriate binary datatypes are encountered by
161      * the marshal process.</p>
162      *
163      * <p>Marshaller.marshal() must throw IllegalStateException if this value is <code>true</code>
164      * and the XML content to be marshalled violates Step 1 in
165      * <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/#creating_xop_packages">Creating XOP Pacakges</a>
166      * http://www.w3.org/TR/2005/REC-xop10-20050125/#creating_xop_packages.
167      * <i>"Ensure the Original XML Infoset contains no element information item with a
168      * [namespace name] of "http://www.w3.org/2004/08/xop/include" and a [local name] of Include"</i>
169      *
170      * <p>When this method returns true and during the marshal process
171      * at least one call to <code>addMtomAttachment(...)</code> returns
172      * a content-id, the MIME-based package processor must label the
173      * root part with the application/xop+xml media type as described in
174      * Step 5 of
175      * <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/#creating_xop_packages">Creating XOP Pacakges</a>.<p>
176      *
177      * @return true when MIME context is a XOP Package.
178      */
179     public boolean isXOPPackage() { return false; }
180 
181    /**
182     * <p>Add MIME <code>data</code> as an attachment and return attachment's content-id, cid.</p>
183     *
184     * <p>
185     * This method is called by JAXB marshal process for each element/attribute typed as
186     * {http://ws-i.org/profiles/basic/1.1/xsd}swaRef. The MIME-based package processor
187     * implementing this method is responsible for attaching the specified data to a
188     * MIME attachment, and generating a content-id, cid, that uniquely identifies the attachment
189     * within the MIME-based package.
190     *
191     * <p>Caller inserts the returned content-id, cid, into the XML content being marshalled.</p>
192     *
193     * @param data
194     *       represents the data to be attached. Must be non-null.
195     * @return
196     *       must be a valid URI used as cid. Must satisfy Conformance Requirement R2928 from
197     *       <a href="http://www.ws-i.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html#Referencing_Attachments_from_the_SOAP_Envelope">WS-I Attachments Profile Version 1.0.</a>
198     */
199     public abstract String addSwaRefAttachment(DataHandler data);
200 }