Class V1toV2StatementInterceptorAdapter

java.lang.Object

com.mysql.jdbc.V1toV2StatementInterceptorAdapter

All Implemented Interfaces:

Extension, StatementInterceptorV2

public class V1toV2StatementInterceptorAdapter
extends Object
implements StatementInterceptorV2

Constructor Summary

Constructors

Constructor	Description
V1toV2StatementInterceptorAdapter(StatementInterceptor toProxy)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Called by the driver when this extension should release any resources it is holding and cleanup internally before the connection is closed.
boolean	executeTopLevelOnly()	Should the driver execute this interceptor only for the "original" top-level query, and not put it in the execution path for queries that may be executed from other interceptors?
void	init(Connection conn, Properties props)	Called once per connection that wants to use the interceptor The properties are the same ones passed in in the URL or arguments to Driver.connect() or DriverManager.getConnection().
ResultSetInternalMethods	postProcess(String sql, Statement interceptedStatement, ResultSetInternalMethods originalResultSet, Connection connection, int warningCount, boolean noIndexUsed, boolean noGoodIndexUsed, SQLException statementException)	Called after the given statement has been sent to the server for processing, instead of the StatementAware postProcess() of the earlier api.
ResultSetInternalMethods	preProcess(String sql, Statement interceptedStatement, Connection connection)	Called before the given statement is going to be sent to the server for processing.

Methods inherited from class Object

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

Constructor Details

V1toV2StatementInterceptorAdapter

public V1toV2StatementInterceptorAdapter(StatementInterceptor toProxy)

Method Details

postProcess

public ResultSetInternalMethods postProcess(String sql,
 Statement interceptedStatement,
 ResultSetInternalMethods originalResultSet,
 Connection connection,
 int warningCount,
 boolean noIndexUsed,
 boolean noGoodIndexUsed,
 SQLException statementException)
                                     throws SQLException

Description copied from interface: StatementInterceptorV2

Called after the given statement has been sent to the server for processing, instead of the StatementAware postProcess() of the earlier api. Interceptors are free to inspect the "original" result set, and if a different result set is returned by the interceptor, it is used in place of the "original" result set. (the result set returned by the interceptor must implement the interface com.mysql.jdbc.ResultSetInternalMethods). This method will be called while the connection-level mutex is held, so it will only be called from one thread at a time.

Specified by:

postProcess in interface StatementInterceptorV2

Parameters:

sql - the SQL representation of the statement

interceptedStatement - the actual statement instance being intercepted

connection - the connection the statement is using (passed in to make thread-safe implementations straightforward)

Returns:

a result set that should be returned to the application instead of results that are created from actual execution of the intercepted statement.

Throws:

SQLException - if an error occurs during execution

See Also:

• ResultSetInternalMethods

destroy

public void destroy()

Description copied from interface: StatementInterceptorV2

Called by the driver when this extension should release any resources it is holding and cleanup internally before the connection is closed.

Specified by:

destroy in interface Extension

Specified by:

destroy in interface StatementInterceptorV2

executeTopLevelOnly

public boolean executeTopLevelOnly()

Description copied from interface: StatementInterceptorV2

Should the driver execute this interceptor only for the "original" top-level query, and not put it in the execution path for queries that may be executed from other interceptors? If an interceptor issues queries using the connection it was created for, and does not return true for this method, it must ensure that it does not cause infinite recursion.

Specified by:

executeTopLevelOnly in interface StatementInterceptorV2

Returns:

true if the driver should ensure that this interceptor is only executed for the top-level "original" query.

init

public void init(Connection conn,
 Properties props)
          throws SQLException

Description copied from interface: StatementInterceptorV2

Called once per connection that wants to use the interceptor The properties are the same ones passed in in the URL or arguments to Driver.connect() or DriverManager.getConnection().

Specified by:

init in interface Extension

Specified by:

init in interface StatementInterceptorV2

Parameters:

conn - the connection for which this interceptor is being created

props - configuration values as passed to the connection. Note that in order to support javax.sql.DataSources, configuration properties specific to an interceptor must be passed via setURL() on the DataSource. StatementInterceptor properties are not exposed via accessor/mutator methods on DataSources.

Throws:

SQLException - should be thrown if the the StatementInterceptor can not initialize itself.

preProcess

public ResultSetInternalMethods preProcess(String sql,
 Statement interceptedStatement,
 Connection connection)
                                    throws SQLException

Description copied from interface: StatementInterceptorV2

Called before the given statement is going to be sent to the server for processing. Interceptors are free to return a result set (which must implement the interface com.mysql.jdbc.ResultSetInternalMethods), and if so, the server will not execute the query, and the given result set will be returned to the application instead. This method will be called while the connection-level mutex is held, so it will only be called from one thread at a time.

Specified by:

preProcess in interface StatementInterceptorV2

Parameters:

sql - the SQL representation of the statement

interceptedStatement - the actual statement instance being intercepted

connection - the connection the statement is using (passed in to make thread-safe implementations straightforward)

Returns:

a result set that should be returned to the application instead of results that are created from actual execution of the intercepted statement.

Throws:

SQLException - if an error occurs during execution

See Also:

• ResultSetInternalMethods