diff -r 88b85470e72c -r f50545b5e2f1 src/share/jaxws_classes/com/sun/xml/internal/org/jvnet/staxex/XMLStreamWriterEx.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/jaxws_classes/com/sun/xml/internal/org/jvnet/staxex/XMLStreamWriterEx.java Tue Mar 06 16:09:35 2012 -0800 @@ -0,0 +1,154 @@ +/* + * Copyright (c) 1997, 2010, 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 com.sun.xml.internal.org.jvnet.staxex; + +import javax.activation.DataHandler; +import javax.xml.stream.XMLStreamException; +import javax.xml.stream.XMLStreamWriter; +import java.io.OutputStream; + +/** + * {@link XMLStreamWriter} extended to support XOP. + * + *

+ * Some infoset serializer (such as XOP encoder, FastInfoset) uses a format + * that can represent binary data more efficiently than base64 encoding. + * Such infoset serializer may choose to implement this interface, to allow + * the caller to pass in binary data more efficiently without first converting + * it to binary data. + * + *

+ * Callers capable of using this interface can see if the serializer supports + * it by simply downcasting {@link XMLStreamWriter} to {@link XMLStreamWriterEx}. + * + *

TODO

+ *
    + *
  1. + * Add methods to write other primitive types, such as hex and integers + * (and arrays of). + * A textual implementation would write characters in accordance + * to the canonical lexical definitions specified in W3C XML Schema: datatypes. + * A MTOM implementation would write characters except for the case where octets + * that would otherwise be base64 encoded when using the textual implementation. + * A Fast Infoset implementation would encoded binary data the primitive types in + * binary form. + *
  2. + * Consider renaming writeBinary to writeBytesAsBase64 to be consistent with + * infoset abstraction. + *
  3. + * Add the ability to writeStart and writeEnd on attributes so that the same + * methods for writing primitive types (and characters, which will require new methods) + * can be used for writing attribute values as well as element content. + *
+ * + * @see XMLStreamReaderEx + * @author Kohsuke Kawaguchi + * @author Paul Sandoz + */ +public interface XMLStreamWriterEx extends XMLStreamWriter { + + /** + * Write the binary data. + * + *

+ * Conceptually (infoset-wise), this produces the base64-encoded binary data on the + * output. But this allows implementations like FastInfoset or XOP to do the smart + * thing. + * + *

+ * The use of this method has some restriction to support XOP. Namely, this method + * must be invoked as a sole content of an element. + * + *

+ * (data,start,len) triplet identifies the binary data to be written. + * After the method invocation, the callee owns the buffer. + * + * @param contentType + * this mandatory parameter identifies the MIME type of the binary data. + * If the MIME type isn't known by the caller, "application/octet-stream" can + * be always used to indicate "I don't know." Never null. + */ + void writeBinary(byte[] data, int start, int len, String contentType) throws XMLStreamException; + + /** + * Writes the binary data. + * + *

+ * This method works like the {@link #writeBinary(byte[], int, int, String)} method, + * except that it takes the binary data in the form of {@link DataHandler}, which + * contains a MIME type ({@link DataHandler#getContentType()} as well as the payload + * {@link DataHandler#getInputStream()}. + * + * @param data + * always non-null. After this method call, the callee owns the data handler. + */ + void writeBinary(DataHandler data) throws XMLStreamException; + + /** + * Writes the binary data. + * + *

+ * This version of the writeBinary method allows the caller to produce + * the binary data by writing it to {@link OutputStream}. + * + *

+ * It is the caller's responsibility to write and close + * a stream before it invokes any other methods on {@link XMLStreamWriter}. + * + * TODO: experimental. appreciate feedback + * @param contentType + * See the content-type parameter of + * {@link #writeBinary(byte[], int, int, String)}. Must not be null. + * + * @return + * always return a non-null {@link OutputStream}. + */ + OutputStream writeBinary(String contentType) throws XMLStreamException; + + /** + * Writes like {@link #writeCharacters(String)} but hides + * actual data format. + * + * @param data + * The {@link CharSequence} that represents the + * character infoset items to be written. + * + *

+ * The {@link CharSequence} is normally a {@link String}, + * but can be any other {@link CharSequence} implementation. + * For binary data, however, use of {@link Base64Data} is + * recommended (so that the consumer interested in seeing it + * as binary data may take advantage of mor efficient + * data representation.) + * + */ + void writePCDATA(CharSequence data) throws XMLStreamException; + + /** + * {@inheritDoc} + */ + NamespaceContextEx getNamespaceContext(); +}