001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package org.jvnet.staxex;
038:
039: import javax.activation.DataHandler;
040: import javax.xml.stream.XMLStreamException;
041: import javax.xml.stream.XMLStreamWriter;
042: import java.io.OutputStream;
043:
044: /**
045: * {@link XMLStreamWriter} extended to support XOP.
046: *
047: * <p>
048: * Some infoset serializer (such as XOP encoder, FastInfoset) uses a format
049: * that can represent binary data more efficiently than base64 encoding.
050: * Such infoset serializer may choose to implement this interface, to allow
051: * the caller to pass in binary data more efficiently without first converting
052: * it to binary data.
053: *
054: * <p>
055: * Callers capable of using this interface can see if the serializer supports
056: * it by simply downcasting {@link XMLStreamWriter} to {@link XMLStreamWriterEx}.
057: *
058: * <h2>TODO</h2>
059: * <ol>
060: * <li>
061: * Add methods to write other primitive types, such as hex and integers
062: * (and arrays of).
063: * A textual implementation would write characters in accordance
064: * to the canonical lexical definitions specified in W3C XML Schema: datatypes.
065: * A MTOM implementation would write characters except for the case where octets
066: * that would otherwise be base64 encoded when using the textual implementation.
067: * A Fast Infoset implementation would encoded binary data the primitive types in
068: * binary form.
069: * <li>
070: * Consider renaming writeBinary to writeBytesAsBase64 to be consistent with
071: * infoset abstraction.
072: * <li>
073: * Add the ability to writeStart and writeEnd on attributes so that the same
074: * methods for writing primitive types (and characters, which will require new methods)
075: * can be used for writing attribute values as well as element content.
076: * </ol>
077: *
078: * @see XMLStreamReaderEx
079: * @author Kohsuke Kawaguchi
080: * @author Paul Sandoz
081: */
082: public interface XMLStreamWriterEx extends XMLStreamWriter {
083:
084: /**
085: * Write the binary data.
086: *
087: * <p>
088: * Conceptually (infoset-wise), this produces the base64-encoded binary data on the
089: * output. But this allows implementations like FastInfoset or XOP to do the smart
090: * thing.
091: *
092: * <p>
093: * The use of this method has some restriction to support XOP. Namely, this method
094: * must be invoked as a sole content of an element.
095: *
096: * <p>
097: * (data,start,len) triplet identifies the binary data to be written.
098: * After the method invocation, the callee owns the buffer.
099: *
100: * @param contentType
101: * this mandatory parameter identifies the MIME type of the binary data.
102: * If the MIME type isn't known by the caller, "application/octet-stream" can
103: * be always used to indicate "I don't know." Never null.
104: */
105: void writeBinary(byte[] data, int start, int len, String contentType)
106: throws XMLStreamException;
107:
108: /**
109: * Writes the binary data.
110: *
111: * <p>
112: * This method works like the {@link #writeBinary(byte[], int, int, String)} method,
113: * except that it takes the binary data in the form of {@link DataHandler}, which
114: * contains a MIME type ({@link DataHandler#getContentType()} as well as the payload
115: * {@link DataHandler#getInputStream()}.
116: *
117: * @param data
118: * always non-null. After this method call, the callee owns the data handler.
119: */
120: void writeBinary(DataHandler data) throws XMLStreamException;
121:
122: /**
123: * Writes the binary data.
124: *
125: * <p>
126: * This version of the writeBinary method allows the caller to produce
127: * the binary data by writing it to {@link OutputStream}.
128: *
129: * <p>
130: * It is the caller's responsibility to write and close
131: * a stream before it invokes any other methods on {@link XMLStreamWriter}.
132: *
133: * TODO: experimental. appreciate feedback
134: * @param contentType
135: * See the content-type parameter of
136: * {@link #writeBinary(byte[], int, int, String)}. Must not be null.
137: *
138: * @return
139: * always return a non-null {@link OutputStream}.
140: */
141: OutputStream writeBinary(String contentType)
142: throws XMLStreamException;
143:
144: /**
145: * Writes like {@link #writeCharacters(String)} but hides
146: * actual data format.
147: *
148: * @param data
149: * The {@link CharSequence} that represents the
150: * character infoset items to be written.
151: *
152: * <p>
153: * The {@link CharSequence} is normally a {@link String},
154: * but can be any other {@link CharSequence} implementation.
155: * For binary data, however, use of {@link Base64Data} is
156: * recommended (so that the consumer interested in seeing it
157: * as binary data may take advantage of mor efficient
158: * data representation.)
159: *
160: */
161: void writePCDATA(CharSequence data) throws XMLStreamException;
162:
163: /**
164: * {@inheritDoc}
165: */
166: NamespaceContextEx getNamespaceContext();
167: }
|