Sun, 18 Jun 2017 23:18:45 +0100
8172297: In java 8, the marshalling with JAX-WS does not escape carriage return
Reviewed-by: lancea
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.bind.v2.runtime.output; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.io.IOException; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import javax.xml.bind.JAXBContext; |
aoqi@0 | 31 | import javax.xml.stream.XMLStreamException; |
aoqi@0 | 32 | |
aoqi@0 | 33 | import com.sun.xml.internal.bind.v2.runtime.Name; |
aoqi@0 | 34 | import com.sun.xml.internal.bind.v2.runtime.NameList; |
aoqi@0 | 35 | import com.sun.xml.internal.bind.v2.runtime.XMLSerializer; |
aoqi@0 | 36 | |
aoqi@0 | 37 | import org.xml.sax.SAXException; |
aoqi@0 | 38 | |
aoqi@0 | 39 | /** |
aoqi@0 | 40 | * Well-formed XML writer. |
aoqi@0 | 41 | * |
aoqi@0 | 42 | * <p> |
aoqi@0 | 43 | * Implementations of this interface is used to connect {@link XMLSerializer} |
aoqi@0 | 44 | * to the actual target. This allows {@link XMLSerializer} to be API agnostic. |
aoqi@0 | 45 | * |
aoqi@0 | 46 | * |
aoqi@0 | 47 | * <h2>Notes</h2> |
aoqi@0 | 48 | * <p> |
aoqi@0 | 49 | * {@link JAXBContext} assigns indices to URIs and local names |
aoqi@0 | 50 | * that are statically known by using {@link NameList}. |
aoqi@0 | 51 | * {@link XmlOutput} implementation can use these indices to improve |
aoqi@0 | 52 | * the performance. For example, those namespace URI indices can be |
aoqi@0 | 53 | * turned into prefixes quickly. |
aoqi@0 | 54 | * |
aoqi@0 | 55 | * <p> |
aoqi@0 | 56 | * {@link XmlOutput} still allows arbitrary namepsace URIs / local names |
aoqi@0 | 57 | * to be written. |
aoqi@0 | 58 | * |
aoqi@0 | 59 | * <p> |
aoqi@0 | 60 | * The {@link NamespaceContextImpl} object, which is shared between {@link XmlOutput} and |
aoqi@0 | 61 | * {@link XMLSerializer}, keeps track of the in-scope namespace bindings. By the time |
aoqi@0 | 62 | * the {@link #beginStartTag} method is called, all the namespace bindings for the new |
aoqi@0 | 63 | * element is already declared. Similarly, after the {@link #endTag} method is called, |
aoqi@0 | 64 | * in-scope bindings will be removed. This book keeping is all done outside {@link XmlOutput}. |
aoqi@0 | 65 | * |
aoqi@0 | 66 | * <p> |
aoqi@0 | 67 | * {@link XmlOutput} and {@link XMLSerializer} uses indices to |
aoqi@0 | 68 | * reference prefixes/URIs to be written. {@link NamespaceContextImpl} can |
aoqi@0 | 69 | * convert prefix indices to URIs and the string representations of prefixes. |
aoqi@0 | 70 | * Binding from indices to URIs and prefixes do not change while indices |
aoqi@0 | 71 | * are "in scope", so {@link XmlOutput} is again expected to take advantage of |
aoqi@0 | 72 | * this to improve the perofmrnace. |
aoqi@0 | 73 | * |
aoqi@0 | 74 | * <p> |
aoqi@0 | 75 | * prefix index 0 is reserved for "xml", and this binding is assumed to be always there. |
aoqi@0 | 76 | * {@link NamespaceContextImpl} can handle this index correctly, but this binding will never |
aoqi@0 | 77 | * be reported to {@link XmlOutput} through {@link #beginStartTag}. |
aoqi@0 | 78 | * |
aoqi@0 | 79 | * <p> |
aoqi@0 | 80 | * One pecurilar behavior of a {@link NamespaceContextImpl} object is that it tries |
aoqi@0 | 81 | * to define redundant xmlns="" on the root element. Implementations of {@link XmlOutput} |
aoqi@0 | 82 | * is encouraged to check for this and avoid generating redundant namespace declarations. |
aoqi@0 | 83 | * |
aoqi@0 | 84 | * |
aoqi@0 | 85 | * |
aoqi@0 | 86 | * <h2>Call Sequence</h2> |
aoqi@0 | 87 | * <p> |
aoqi@0 | 88 | * {@link XMLSerializer} calls the writer methods in the following order: |
aoqi@0 | 89 | * |
aoqi@0 | 90 | * <pre> |
aoqi@0 | 91 | * CALLSEQUENCE := {@link #startDocument startDocument} ELEMENT {@link #endDocument endDocument} |
aoqi@0 | 92 | * | ELEMENT // for fragment |
aoqi@0 | 93 | * |
aoqi@0 | 94 | * ELEMENT := {@link #beginStartTag beginStartTag} {@link #attribute attribute}* {@link #endStartTag endStartTag} CONTENTS {@link #endTag endTag} |
aoqi@0 | 95 | * |
aoqi@0 | 96 | * CONTENTS := (ELEMENT | {@link #text text})* |
aoqi@0 | 97 | * </pre> |
aoqi@0 | 98 | * |
aoqi@0 | 99 | * TODO: for FI, consider making attribute values from Strings to CharSequences. |
aoqi@0 | 100 | * |
aoqi@0 | 101 | * @author Kohsuke Kawaguchi |
aoqi@0 | 102 | */ |
aoqi@0 | 103 | public interface XmlOutput { |
aoqi@0 | 104 | // |
aoqi@0 | 105 | // |
aoqi@0 | 106 | // Contracts |
aoqi@0 | 107 | // |
aoqi@0 | 108 | // |
aoqi@0 | 109 | /** |
aoqi@0 | 110 | * Called at the very beginning. |
aoqi@0 | 111 | * |
aoqi@0 | 112 | * @param serializer |
aoqi@0 | 113 | * the {@link XMLSerializer} that coordinates this whole marshalling episode. |
aoqi@0 | 114 | * @param fragment |
aoqi@0 | 115 | * true if we are marshalling a fragment. |
aoqi@0 | 116 | */ |
aoqi@0 | 117 | public void startDocument(XMLSerializer serializer, boolean fragment, int[] nsUriIndex2prefixIndex, NamespaceContextImpl nsContext) throws IOException, SAXException, XMLStreamException; |
aoqi@0 | 118 | |
aoqi@0 | 119 | /** |
aoqi@0 | 120 | * Called at the very end. This is the last method to be invoked. |
aoqi@0 | 121 | * |
aoqi@0 | 122 | * @param fragment |
aoqi@0 | 123 | * false if we are writing the whole document. |
aoqi@0 | 124 | */ |
aoqi@0 | 125 | public void endDocument(boolean fragment) throws IOException, SAXException, XMLStreamException; |
aoqi@0 | 126 | |
aoqi@0 | 127 | /** |
aoqi@0 | 128 | * Writes a start tag. |
aoqi@0 | 129 | * |
aoqi@0 | 130 | * <p> |
aoqi@0 | 131 | * At this point {@link NamespaceContextImpl} holds namespace declarations needed for this |
aoqi@0 | 132 | * new element. |
aoqi@0 | 133 | * |
aoqi@0 | 134 | * <p> |
aoqi@0 | 135 | * This method is used for writing tags that are indexed. |
aoqi@0 | 136 | */ |
aoqi@0 | 137 | public void beginStartTag(Name name) throws IOException, XMLStreamException; |
aoqi@0 | 138 | |
aoqi@0 | 139 | public void beginStartTag(int prefix, String localName) throws IOException, XMLStreamException; |
aoqi@0 | 140 | |
aoqi@0 | 141 | public void attribute( Name name, String value ) throws IOException, XMLStreamException; |
aoqi@0 | 142 | |
aoqi@0 | 143 | /** |
aoqi@0 | 144 | * @param prefix |
aoqi@0 | 145 | * -1 if this attribute does not have a prefix |
aoqi@0 | 146 | * (this handling differs from that of elements.) |
aoqi@0 | 147 | */ |
aoqi@0 | 148 | public void attribute( int prefix, String localName, String value ) throws IOException, XMLStreamException; |
aoqi@0 | 149 | |
aoqi@0 | 150 | public void endStartTag() throws IOException, SAXException; |
aoqi@0 | 151 | |
aoqi@0 | 152 | public void endTag(Name name) throws IOException, SAXException, XMLStreamException; |
aoqi@0 | 153 | |
aoqi@0 | 154 | public void endTag(int prefix, String localName) throws IOException, SAXException, XMLStreamException; |
aoqi@0 | 155 | |
aoqi@0 | 156 | /** |
aoqi@0 | 157 | * Writes XML text with character escaping, if necessary. |
aoqi@0 | 158 | * |
aoqi@0 | 159 | * @param value |
aoqi@0 | 160 | * this string can contain characters that might need escaping |
aoqi@0 | 161 | * (such as '&' or '>') |
aoqi@0 | 162 | * @param needsSeparatingWhitespace |
aoqi@0 | 163 | */ |
aoqi@0 | 164 | public void text( String value, boolean needsSeparatingWhitespace ) throws IOException, SAXException, XMLStreamException; |
aoqi@0 | 165 | |
aoqi@0 | 166 | /** |
aoqi@0 | 167 | * Writes XML text with character escaping, if necessary. |
aoqi@0 | 168 | * |
aoqi@0 | 169 | * @param value |
aoqi@0 | 170 | * this string can contain characters that might need escaping |
aoqi@0 | 171 | * (such as '&' or '>') |
aoqi@0 | 172 | * @param needsSeparatingWhitespace |
aoqi@0 | 173 | */ |
aoqi@0 | 174 | public void text( Pcdata value, boolean needsSeparatingWhitespace ) throws IOException, SAXException, XMLStreamException; |
aoqi@0 | 175 | } |