com.microsoft.sqlserver.jdbc.SQLServerSQLXML Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mssql-jdbc Show documentation
Show all versions of mssql-jdbc Show documentation
Microsoft JDBC Driver for SQL Server.
/*
* Microsoft JDBC Driver for SQL Server Copyright(c) Microsoft Corporation All rights reserved. This program is made
* available under the terms of the MIT License. See the LICENSE file in the project root for more information.
*/
package com.microsoft.sqlserver.jdbc;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.StringReader;
import java.sql.SQLException;
import java.text.MessageFormat;
import java.util.concurrent.atomic.AtomicInteger;
import javax.xml.XMLConstants;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.sax.TransformerHandler;
import javax.xml.transform.stax.StAXResult;
import javax.xml.transform.stax.StAXSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import org.w3c.dom.Document;
import org.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;
/**
* Represents an XML object and implements a java.sql.SQLXML.
*/
final class SQLServerSQLXML implements java.sql.SQLXML {
// Connection that created this SQLXML only set when created for setting data
private final SQLServerConnection con;
// Contents null means this is a setter.
private final PLPXMLInputStream contents;
private final InputStreamGetterArgs getterArgs;
private final TypeInfo typeInfo;
private boolean isUsed = false;
private boolean isFreed = false;
static private final java.util.logging.Logger logger = java.util.logging.Logger
.getLogger("com.microsoft.sqlserver.jdbc.internals.SQLServerSQLXML");
// Setter values are held in different forms depending on which setter is used only one setter can
// be used at one time.
private ByteArrayOutputStreamToInputStream outputStreamValue;
private Document docValue;
private String strValue;
// End of setter values
static private final AtomicInteger baseID = new AtomicInteger(0); // Unique id generator for each instance (used for
// logging).
final private String traceID;
final public String toString() {
return traceID;
}
/**
* Returns unique id for each instance.
*
* @return
*/
private static int nextInstanceID() {
return baseID.incrementAndGet();
}
// This method is used to get the value the user has set
// This is used at the execution time when sending the data to the server
// possible optimization transform DOM straight to tds
InputStream getValue() throws SQLServerException {
checkClosed();
// the user should have called one of the setter methods, the setter methods "use" the object and write some
// value.
// Note just calling one of the setters is enough.
if (!isUsed)
SQLServerException.makeFromDriverError(con, null, SQLServerException.getErrString("R_noDataXML"), null,
true);
assert null == contents;
ByteArrayInputStream o = null;
if (null != outputStreamValue) {
o = outputStreamValue.getInputStream();
assert null == docValue;
assert null == strValue;
} else if (null != docValue) {
assert null == outputStreamValue;
assert null == strValue;
ByteArrayOutputStreamToInputStream strm = new ByteArrayOutputStreamToInputStream();
// Need to beat a stream out of docValue
TransformerFactory factory;
try {
factory = TransformerFactory.newInstance();
factory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
factory.newTransformer().transform(new DOMSource(docValue), new StreamResult(strm));
} catch (javax.xml.transform.TransformerException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_noParserSupport"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(con, null, form.format(msgArgs), null, true);
}
o = strm.getInputStream();
} else {
assert null == outputStreamValue;
assert null == docValue;
assert null != strValue;
o = new ByteArrayInputStream(strValue.getBytes(Encoding.UNICODE.charset()));
}
assert null != o;
isFreed = true; // we have consumed the data
return o;
}
// To be used in the createSQLXML call
SQLServerSQLXML(SQLServerConnection connection) {
contents = null;
traceID = " SQLServerSQLXML:" + nextInstanceID();
con = connection;
if (logger.isLoggable(java.util.logging.Level.FINE))
logger.fine(toString() + " created by (" + connection.toString() + ")");
getterArgs = null; // make the compiler happy
typeInfo = null;
}
SQLServerSQLXML(InputStream stream, InputStreamGetterArgs getterArgs, TypeInfo typeInfo) throws SQLServerException {
traceID = " SQLServerSQLXML:" + nextInstanceID();
contents = (PLPXMLInputStream) stream;
this.con = null;
this.getterArgs = getterArgs;
this.typeInfo = typeInfo;
if (logger.isLoggable(java.util.logging.Level.FINE))
logger.fine(toString() + " created by (null connection)");
}
InputStream getStream() {
return contents;
}
@Override
public void free() throws SQLException {
if (!isFreed) {
isFreed = true;
if (null != contents) {
try {
contents.close();
} catch (IOException e) {
SQLServerException.makeFromDriverError(null, null, e.getMessage(), null, true);
}
}
}
}
private void checkClosed() throws SQLServerException {
if (isFreed || (null != con && con.isClosed())) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_isFreed"));
SQLServerException.makeFromDriverError(con, null, form.format(new Object[] {"SQLXML"}), null, true);
}
}
private void checkReadXML() throws SQLException {
if (null == contents)
SQLServerException.makeFromDriverError(con, null, SQLServerException.getErrString("R_writeOnlyXML"), null,
true);
if (isUsed)
SQLServerException.makeFromDriverError(con, null, SQLServerException.getErrString("R_dataHasBeenReadXML"),
null, true);
try {
contents.checkClosed();
} catch (IOException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_isFreed"));
SQLServerException.makeFromDriverError(con, null, form.format(new Object[] {"SQLXML"}), null, true);
}
}
void checkWriteXML() throws SQLException {
if (null != contents)
SQLServerException.makeFromDriverError(con, null, SQLServerException.getErrString("R_readOnlyXML"), null,
true);
if (isUsed)
SQLServerException.makeFromDriverError(con, null, SQLServerException.getErrString("R_dataHasBeenSetXML"),
null, true);
}
/**
* Returns an input stream to read data from this SQLXML.
*
* @throws SQLException
* when an error occurs
* @return the input stream to that contains the SQLXML data
*/
@Override
public InputStream getBinaryStream() throws SQLException {
checkClosed();
checkReadXML();
isUsed = true;
return contents;
}
/**
* Sets a stream that can be used to write to the SQLXML value that this SQLXML object represents The user has to
* write the BOM for binary streams.
*
* @throws SQLException
* when an error occurs
* @return OutputStream
*/
@Override
public java.io.OutputStream setBinaryStream() throws SQLException {
checkClosed();
checkWriteXML();
isUsed = true;
outputStreamValue = new ByteArrayOutputStreamToInputStream();
return outputStreamValue;
}
@Override
public java.io.Writer setCharacterStream() throws SQLException {
checkClosed();
checkWriteXML();
isUsed = true;
outputStreamValue = new ByteArrayOutputStreamToInputStream();
return new OutputStreamWriter(outputStreamValue, Encoding.UNICODE.charset());
}
@Override
public Reader getCharacterStream() throws SQLException {
checkClosed();
checkReadXML();
isUsed = true;
StreamType type = StreamType.CHARACTER;
InputStreamGetterArgs newArgs = new InputStreamGetterArgs(type, getterArgs.isAdaptive, getterArgs.isStreaming,
getterArgs.logContext);
// Skip the BOM bytes from the plpinputstream we do not need it for the conversion
assert null != contents;
// Read two bytes to eat BOM
try {
contents.read();
contents.read();
} catch (IOException e) {
SQLServerException.makeFromDriverError(null, null, e.getMessage(), null, true);
}
Reader rd = (Reader) DDC.convertStreamToObject(contents, typeInfo, type.getJDBCType(), newArgs);
return rd;
}
@Override
public String getString() throws SQLException {
checkClosed();
checkReadXML();
isUsed = true;
assert null != contents;
// Read two bytes to eat BOM
try {
contents.read();
contents.read();
} catch (IOException e) {
SQLServerException.makeFromDriverError(null, null, e.getMessage(), null, true);
}
byte byteContents[] = contents.getBytes();
return new String(byteContents, 0, byteContents.length, Encoding.UNICODE.charset());
}
@Override
public void setString(String value) throws SQLException {
checkClosed();
checkWriteXML();
isUsed = true;
if (null == value)
SQLServerException.makeFromDriverError(con, null, SQLServerException.getErrString("R_cantSetNull"), null,
true);
strValue = value;
}
// Support the following DOMSource, SAXSource, StAX and Stream. Also, null means default which is stream source
@Override
public T getSource(Class iface) throws SQLException {
checkClosed();
checkReadXML();
if (null == iface) {
// The compiler does not allow setting the null iface to StreamSource.class hence
// this cast is needed, the cast is safe.
@SuppressWarnings("unchecked")
T src = (T) getSourceInternal(StreamSource.class);
return src;
} else
return getSourceInternal(iface);
}
T getSourceInternal(Class iface) throws SQLException {
isUsed = true;
T src = null;
if (DOMSource.class == iface) {
src = iface.cast(getDOMSource());
} else if (SAXSource.class == iface) {
src = iface.cast(getSAXSource());
} else if (StAXSource.class == iface) {
src = iface.cast(getStAXSource());
} else if (StreamSource.class == iface) {
src = iface.cast(new StreamSource(contents));
} else
// Do not support this type
SQLServerException.makeFromDriverError(con, null, SQLServerException.getErrString("R_notSupported"), null,
true);
return src;
}
@Override
public T setResult(Class resultClass) throws SQLException {
checkClosed();
checkWriteXML();
if (null == resultClass) {
// The compiler does not allow setting the null resultClass to StreamResult.class hence
// this cast is needed, the cast is safe.
@SuppressWarnings("unchecked")
T result = (T) setResultInternal(StreamResult.class);
return result;
} else
return setResultInternal(resultClass);
}
T setResultInternal(Class resultClass) throws SQLException {
isUsed = true;
T result = null;
if (DOMResult.class == resultClass) {
result = resultClass.cast(getDOMResult());
} else if (SAXResult.class == resultClass) {
result = resultClass.cast(getSAXResult());
} else if (StAXResult.class == resultClass) {
result = resultClass.cast(getStAXResult());
} else if (StreamResult.class == resultClass) {
outputStreamValue = new ByteArrayOutputStreamToInputStream();
result = resultClass.cast(new StreamResult(outputStreamValue));
} else
SQLServerException.makeFromDriverError(con, null, SQLServerException.getErrString("R_notSupported"), null,
true);
return result;
}
// Supporting functions
private DOMSource getDOMSource() throws SQLException {
Document document = null;
final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder;
try {
// Secure feature processing is false by default for IBM parser
// For all others, it is true by default.
// So, setting it explicitly for all, irrespective of the JVM.
// This limits the expansion of entities.
// The limit is implementation specific. For IBM it's 100,000
// whereas for oracle it is 64,000.
factory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
builder = factory.newDocumentBuilder();
// set an entity resolver to disable parsing of external entities
builder.setEntityResolver(new SQLServerEntityResolver());
try {
document = builder.parse(contents);
} catch (IOException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_errorReadingStream"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(null, null, form.format(msgArgs), "", true);
}
DOMSource inputSource = new DOMSource(document);
return inputSource;
} catch (ParserConfigurationException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_noParserSupport"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(con, null, form.format(msgArgs), null, true);
} catch (SAXException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_failedToParseXML"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(con, null, form.format(msgArgs), null, true);
}
return null;
}
private SAXSource getSAXSource() throws SQLException {
try {
InputSource src = new InputSource(contents);
SAXParserFactory factory = SAXParserFactory.newInstance();
SAXParser parser = factory.newSAXParser();
XMLReader reader = parser.getXMLReader();
SAXSource saxSource = new SAXSource(reader, src);
return saxSource;
} catch (SAXException | ParserConfigurationException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_failedToParseXML"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(con, null, form.format(msgArgs), null, true);
}
return null;
}
private StAXSource getStAXSource() throws SQLException {
XMLInputFactory factory = XMLInputFactory.newInstance();
try {
XMLStreamReader r = factory.createXMLStreamReader(contents);
StAXSource result = new StAXSource(r);
return result;
} catch (XMLStreamException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_noParserSupport"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(con, null, form.format(msgArgs), null, true);
}
return null;
}
private StAXResult getStAXResult() throws SQLException {
XMLOutputFactory factory = XMLOutputFactory.newInstance();
outputStreamValue = new ByteArrayOutputStreamToInputStream();
try {
XMLStreamWriter r = factory.createXMLStreamWriter(outputStreamValue);
StAXResult result = new StAXResult(r);
return result;
} catch (XMLStreamException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_noParserSupport"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(con, null, form.format(msgArgs), null, true);
}
return null;
}
private SAXResult getSAXResult() throws SQLException {
TransformerHandler handler = null;
try {
SAXTransformerFactory stf = (SAXTransformerFactory) TransformerFactory.newInstance();
stf.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
handler = stf.newTransformerHandler();
} catch (TransformerConfigurationException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_noParserSupport"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(con, null, form.format(msgArgs), null, true);
} catch (ClassCastException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_noParserSupport"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(con, null, form.format(msgArgs), null, true);
}
outputStreamValue = new ByteArrayOutputStreamToInputStream();
handler.setResult(new StreamResult(outputStreamValue));
SAXResult result = new SAXResult(handler);
return result;
}
private DOMResult getDOMResult() throws SQLException {
final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder;
assert null == outputStreamValue;
try {
builder = factory.newDocumentBuilder();
docValue = builder.newDocument();
DOMResult result = new DOMResult(docValue);
return result;
} catch (ParserConfigurationException e) {
MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_noParserSupport"));
Object[] msgArgs = {e.toString()};
SQLServerException.makeFromDriverError(con, null, form.format(msgArgs), null, true);
}
return null;
}
}
/**
* Converts the byte information in the string to an inputstream which is used when sending to the info to the server.
*/
final class ByteArrayOutputStreamToInputStream extends ByteArrayOutputStream {
ByteArrayInputStream getInputStream() throws SQLServerException {
ByteArrayInputStream is = new ByteArrayInputStream(buf, 0, count);
return is;
}
}
/**
* Resolves External entities in an XML with inline DTDs to empty string.
*
*/
final class SQLServerEntityResolver implements EntityResolver {
public InputSource resolveEntity(String publicId, String systemId) {
return new InputSource(new StringReader(""));
}
}