Mon, 23 Apr 2018 13:24:44 +0100
8196491: Newlines in JAXB string values of SOAP-requests are escaped to "
"
Reviewed-by: lancea, rgrigoriadi
ohair@286 | 1 | /* |
aefimov@1609 | 2 | * Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved. |
ohair@286 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
ohair@286 | 4 | * |
ohair@286 | 5 | * This code is free software; you can redistribute it and/or modify it |
ohair@286 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@286 | 7 | * published by the Free Software Foundation. Oracle designates this |
ohair@286 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@286 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
ohair@286 | 10 | * |
ohair@286 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
ohair@286 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
ohair@286 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
ohair@286 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
ohair@286 | 15 | * accompanied this code). |
ohair@286 | 16 | * |
ohair@286 | 17 | * You should have received a copy of the GNU General Public License version |
ohair@286 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
ohair@286 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
ohair@286 | 20 | * |
ohair@286 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@286 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@286 | 23 | * questions. |
ohair@286 | 24 | */ |
ohair@286 | 25 | |
ohair@286 | 26 | package com.sun.xml.internal.ws.streaming; |
ohair@286 | 27 | |
ohair@286 | 28 | import com.sun.istack.internal.Nullable; |
aefimov@1609 | 29 | import com.sun.xml.internal.ws.api.streaming.XMLStreamWriterFactory; |
ohair@286 | 30 | import com.sun.xml.internal.ws.encoding.HasEncoding; |
ohair@286 | 31 | import com.sun.xml.internal.ws.encoding.SOAPBindingCodec; |
ohair@286 | 32 | |
ohair@286 | 33 | import javax.xml.namespace.QName; |
ohair@286 | 34 | import javax.xml.stream.XMLStreamWriter; |
ohair@286 | 35 | import javax.xml.stream.XMLStreamException; |
ohair@286 | 36 | import java.util.Map; |
ohair@286 | 37 | import java.io.OutputStream; |
ohair@286 | 38 | |
ohair@286 | 39 | /** |
ohair@286 | 40 | * <p>XMLStreamWriterUtil provides some utility methods intended to be used |
ohair@286 | 41 | * in conjunction with a StAX XMLStreamWriter. </p> |
ohair@286 | 42 | * |
ohair@286 | 43 | * @author Santiago.PericasGeertsen@sun.com |
ohair@286 | 44 | */ |
ohair@286 | 45 | public class XMLStreamWriterUtil { |
ohair@286 | 46 | |
ohair@286 | 47 | private XMLStreamWriterUtil() { |
ohair@286 | 48 | } |
ohair@286 | 49 | |
ohair@286 | 50 | /** |
ohair@286 | 51 | * Gives the underlying stream for XMLStreamWriter. It closes any start elements, and returns the stream so |
ohair@286 | 52 | * that JAXB can write infoset directly to the stream. |
ohair@286 | 53 | * |
ohair@286 | 54 | * @param writer XMLStreamWriter for which stream is required |
ohair@286 | 55 | * @return underlying OutputStream, null if writer doesn't provide a way to get it |
ohair@286 | 56 | * @throws XMLStreamException if any of writer operations throw the exception |
ohair@286 | 57 | */ |
ohair@286 | 58 | public static @Nullable OutputStream getOutputStream(XMLStreamWriter writer) throws XMLStreamException { |
ohair@286 | 59 | Object obj = null; |
ohair@286 | 60 | |
aefimov@1609 | 61 | XMLStreamWriter xmlStreamWriter = |
aefimov@1609 | 62 | writer instanceof XMLStreamWriterFactory.HasEncodingWriter ? |
aefimov@1609 | 63 | ((XMLStreamWriterFactory.HasEncodingWriter) writer).getWriter() |
aefimov@1609 | 64 | : writer; |
aefimov@1609 | 65 | |
aefimov@1609 | 66 | |
ohair@286 | 67 | // Hack for JDK6's SJSXP |
aefimov@1609 | 68 | if (xmlStreamWriter instanceof Map) { |
aefimov@1609 | 69 | obj = ((Map) xmlStreamWriter).get("sjsxp-outputstream"); |
ohair@286 | 70 | } |
ohair@286 | 71 | |
ohair@286 | 72 | // woodstox |
ohair@286 | 73 | if (obj == null) { |
ohair@286 | 74 | try { |
ohair@286 | 75 | obj = writer.getProperty("com.ctc.wstx.outputUnderlyingStream"); |
ohair@286 | 76 | } catch(Exception ie) { |
ohair@286 | 77 | // Catch all exceptions. SJSXP in JDK throws NPE |
ohair@286 | 78 | // nothing to do here |
ohair@286 | 79 | } |
ohair@286 | 80 | } |
ohair@286 | 81 | |
ohair@286 | 82 | // SJSXP |
ohair@286 | 83 | if (obj == null) { |
ohair@286 | 84 | try { |
ohair@286 | 85 | obj = writer.getProperty("http://java.sun.com/xml/stream/properties/outputstream"); |
ohair@286 | 86 | } catch(Exception ie) { |
ohair@286 | 87 | // Catch all exceptions. SJSXP in JDK throws NPE |
ohair@286 | 88 | // nothing to do here |
ohair@286 | 89 | } |
ohair@286 | 90 | } |
ohair@286 | 91 | |
ohair@286 | 92 | |
ohair@286 | 93 | if (obj != null) { |
ohair@286 | 94 | writer.writeCharacters(""); // Force completion of open elems |
ohair@286 | 95 | writer.flush(); |
ohair@286 | 96 | return (OutputStream)obj; |
ohair@286 | 97 | } |
ohair@286 | 98 | return null; |
ohair@286 | 99 | } |
ohair@286 | 100 | |
ohair@286 | 101 | /** |
ohair@286 | 102 | * Gives the encoding with which XMLStreamWriter is created. |
ohair@286 | 103 | * |
ohair@286 | 104 | * @param writer XMLStreamWriter for which encoding is required |
ohair@286 | 105 | * @return null if cannot be found, else the encoding |
ohair@286 | 106 | */ |
ohair@286 | 107 | public static @Nullable String getEncoding(XMLStreamWriter writer) { |
ohair@286 | 108 | /* |
ohair@286 | 109 | * TODO Add reflection logic to handle woodstox writer |
ohair@286 | 110 | * as it implements XMLStreamWriter2#getEncoding() |
ohair@286 | 111 | * It's not that important since woodstox writer is typically wrapped |
ohair@286 | 112 | * in a writer with HasEncoding |
ohair@286 | 113 | */ |
ohair@286 | 114 | return (writer instanceof HasEncoding) |
ohair@286 | 115 | ? ((HasEncoding)writer).getEncoding() |
ohair@286 | 116 | : null; |
ohair@286 | 117 | } |
ohair@286 | 118 | |
ohair@286 | 119 | public static String encodeQName(XMLStreamWriter writer, QName qname, |
ohair@286 | 120 | PrefixFactory prefixFactory) |
ohair@286 | 121 | { |
ohair@286 | 122 | // NOTE: Here it is assumed that we do not serialize using default |
ohair@286 | 123 | // namespace declarations and therefore that writer.getPrefix will |
ohair@286 | 124 | // never return "" |
ohair@286 | 125 | |
ohair@286 | 126 | try { |
ohair@286 | 127 | String namespaceURI = qname.getNamespaceURI(); |
ohair@286 | 128 | String localPart = qname.getLocalPart(); |
ohair@286 | 129 | |
ohair@286 | 130 | if (namespaceURI == null || namespaceURI.equals("")) { |
ohair@286 | 131 | return localPart; |
ohair@286 | 132 | } |
ohair@286 | 133 | else { |
ohair@286 | 134 | String prefix = writer.getPrefix(namespaceURI); |
ohair@286 | 135 | if (prefix == null) { |
ohair@286 | 136 | prefix = prefixFactory.getPrefix(namespaceURI); |
ohair@286 | 137 | writer.writeNamespace(prefix, namespaceURI); |
ohair@286 | 138 | } |
ohair@286 | 139 | return prefix + ":" + localPart; |
ohair@286 | 140 | } |
ohair@286 | 141 | } |
ohair@286 | 142 | catch (XMLStreamException e) { |
ohair@286 | 143 | throw new RuntimeException(e); |
ohair@286 | 144 | } |
ohair@286 | 145 | } |
ohair@286 | 146 | } |