com.sun.xml.ws.streaming.XMLStreamWriterUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of webservices-rt Show documentation
Show all versions of webservices-rt Show documentation
This module contains the Metro runtime code.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.streaming;
import com.sun.istack.Nullable;
import com.sun.xml.ws.api.streaming.XMLStreamWriterFactory;
import com.sun.xml.ws.encoding.HasEncoding;
import com.sun.xml.ws.encoding.SOAPBindingCodec;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.stream.XMLStreamException;
import java.util.Map;
import java.io.OutputStream;
/**
* XMLStreamWriterUtil provides some utility methods intended to be used
* in conjunction with a StAX XMLStreamWriter.
*
* @author [email protected]
*/
public class XMLStreamWriterUtil {
private XMLStreamWriterUtil() {
}
/**
* Gives the underlying stream for XMLStreamWriter. It closes any start elements, and returns the stream so
* that JAXB can write infoset directly to the stream.
*
* @param writer XMLStreamWriter for which stream is required
* @return underlying OutputStream, null if writer doesn't provide a way to get it
* @throws XMLStreamException if any of writer operations throw the exception
*/
public static @Nullable OutputStream getOutputStream(XMLStreamWriter writer) throws XMLStreamException {
Object obj = null;
XMLStreamWriter xmlStreamWriter =
writer instanceof XMLStreamWriterFactory.HasEncodingWriter ?
((XMLStreamWriterFactory.HasEncodingWriter) writer).getWriter()
: writer;
// Hack for JDK6's SJSXP
if (xmlStreamWriter instanceof Map) {
obj = ((Map) xmlStreamWriter).get("sjsxp-outputstream");
}
// woodstox
if (obj == null) {
try {
obj = writer.getProperty("com.ctc.wstx.outputUnderlyingStream");
} catch(Exception ie) {
// Catch all exceptions. SJSXP in JDK throws NPE
// nothing to do here
}
}
// SJSXP
if (obj == null) {
try {
obj = writer.getProperty("http://java.sun.com/xml/stream/properties/outputstream");
} catch(Exception ie) {
// Catch all exceptions. SJSXP in JDK throws NPE
// nothing to do here
}
}
if (obj != null) {
writer.writeCharacters(""); // Force completion of open elems
writer.flush();
return (OutputStream)obj;
}
return null;
}
/**
* Gives the encoding with which XMLStreamWriter is created.
*
* @param writer XMLStreamWriter for which encoding is required
* @return null if cannot be found, else the encoding
*/
public static @Nullable String getEncoding(XMLStreamWriter writer) {
/*
* TODO Add reflection logic to handle woodstox writer
* as it implements XMLStreamWriter2#getEncoding()
* It's not that important since woodstox writer is typically wrapped
* in a writer with HasEncoding
*/
return (writer instanceof HasEncoding)
? ((HasEncoding)writer).getEncoding()
: null;
}
public static String encodeQName(XMLStreamWriter writer, QName qname,
PrefixFactory prefixFactory)
{
// NOTE: Here it is assumed that we do not serialize using default
// namespace declarations and therefore that writer.getPrefix will
// never return ""
try {
String namespaceURI = qname.getNamespaceURI();
String localPart = qname.getLocalPart();
if (namespaceURI == null || namespaceURI.equals("")) {
return localPart;
}
else {
String prefix = writer.getPrefix(namespaceURI);
if (prefix == null) {
prefix = prefixFactory.getPrefix(namespaceURI);
writer.writeNamespace(prefix, namespaceURI);
}
return prefix + ":" + localPart;
}
}
catch (XMLStreamException e) {
throw new RuntimeException(e);
}
}
}