software.amazon.jdbc.plugin.cache

Class CachedSQLXML

java.lang.Object

software.amazon.jdbc.plugin.cache.CachedSQLXML

All Implemented Interfaces:

java.io.Serializable, java.sql.SQLXML

public class CachedSQLXML
extends java.lang.Object
implements java.sql.SQLXML, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CachedSQLXML(java.lang.String data)

Method Summary

Modifier and Type	Method and Description
void	free()
java.io.InputStream	getBinaryStream()
java.io.Reader	getCharacterStream()
<T extends javax.xml.transform.Source> T	getSource(java.lang.Class<T> sourceClass) Returns a Source for reading the XML value represented by this object.
java.lang.String	getString()
java.io.OutputStream	setBinaryStream()
java.io.Writer	setCharacterStream()
<T extends javax.xml.transform.Result> T	setResult(java.lang.Class<T> resultClass)
void	setString(java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CachedSQLXML

public CachedSQLXML(java.lang.String data)

Method Detail

free

public void free()
          throws java.sql.SQLException

Specified by:

free in interface java.sql.SQLXML

Throws:

java.sql.SQLException

getBinaryStream

public java.io.InputStream getBinaryStream()
                                    throws java.sql.SQLException

Specified by:

getBinaryStream in interface java.sql.SQLXML

Throws:

java.sql.SQLException

setBinaryStream

public java.io.OutputStream setBinaryStream()
                                     throws java.sql.SQLException

Specified by:

setBinaryStream in interface java.sql.SQLXML

Throws:

java.sql.SQLException

getCharacterStream

public java.io.Reader getCharacterStream()
                                  throws java.sql.SQLException

Specified by:

getCharacterStream in interface java.sql.SQLXML

Throws:

java.sql.SQLException

setCharacterStream

public java.io.Writer setCharacterStream()
                                  throws java.sql.SQLException

Specified by:

setCharacterStream in interface java.sql.SQLXML

Throws:

java.sql.SQLException

getString

public java.lang.String getString()
                           throws java.sql.SQLException

Specified by:

getString in interface java.sql.SQLXML

Throws:

java.sql.SQLException

setString

public void setString(java.lang.String value)
               throws java.sql.SQLException

Specified by:

setString in interface java.sql.SQLXML

Throws:

java.sql.SQLException

getSource

public <T extends javax.xml.transform.Source> T getSource(java.lang.Class<T> sourceClass)
                                                   throws java.sql.SQLException

Returns a Source for reading the XML value represented by this object.

For DOMSource, SAXSource, and StAXSource, the XML is parsed by this method using a parser configured to disable DTDs and external entity resolution, following the OWASP XML External Entity Prevention Cheat Sheet.

StreamSource is disabled by default. Because a StreamSource returns the XML unparsed and the driver cannot control how the caller subsequently parses it, requesting one from a cached SQLXML throws SQLException. Callers that require this behavior can opt in by setting the plugin property cacheAllowStreamSource=true, in which case the consumer of the returned StreamSource is responsible for configuring its own parser or transformer securely (for example, by disabling DTDs and external entities).

Specified by:

getSource in interface java.sql.SQLXML

Type Parameters:

T - the type of Source

Parameters:

sourceClass - the class of the Source to return, or null for the default (DOMSource)

Returns:

a Source for reading the XML value, or null if the value has been freed

Throws:

java.sql.SQLException - if the value has been freed, the XML cannot be decoded, or the requested source class is unsupported

setResult

public <T extends javax.xml.transform.Result> T setResult(java.lang.Class<T> resultClass)
                                                   throws java.sql.SQLException

Specified by:

setResult in interface java.sql.SQLXML

Throws:

java.sql.SQLException