Package org.pjdbc.sql

Class AbstractProxyDriver

java.lang.Object

org.pjdbc.sql.AbstractDriver

org.pjdbc.sql.AbstractProxyDriver

All Implemented Interfaces:

Driver

Direct Known Subclasses:

CatDriver, ChaosDriver, CircuitBreakerDriver, DataMaskingDriver, FilterDriver, ReadonlyDriver, RetryDriver, SchemaValidationDriver, SinkDriver, TeeDriver, TimeoutDriver, UserMapDriver

public abstract class AbstractProxyDriver
extends AbstractDriver

Base class for PJDBC proxy drivers that wrap and delegate to other JDBC drivers.

This class provides the core infrastructure for creating proxy drivers that can intercept and modify JDBC operations. Subclasses override specific methods to implement custom behavior such as SQL transformation, connection routing, or operation logging.

Key extension points:

• AbstractDriver.acceptsSubProtocol(String) - Define which URL prefix this driver handles
• proxyConnection(Connection, String, Properties, Driver) - Customize connection wrapping
• proxyStatement(Statement, Connection) - Customize statement wrapping
• proxyPreparedStatement(PreparedStatement, Connection) - Customize prepared statement wrapping

Constructor Summary

Constructors

Constructor	Description
AbstractProxyDriver()

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptsSubName(String subname)
Connection	connect(String url, Properties info)
DriverPropertyInfo[]	getPropertyInfo(String url, Properties info)
protected boolean	isCompositionValidationEnabled()	Whether to automatically validate driver composition on connect.
protected boolean	isValidateParametersEnabled()	Whether to automatically validate parameters on connect.
protected CallableStatement	proxyCallableStatement(CallableStatement delegate, Connection conn)
protected CallableStatement	proxyCallableStatement(CallableStatement delegate, Connection conn, String sql)	Proxy a CallableStatement with access to the original SQL.
protected Connection	proxyConnection(String url, Properties info, Connection[] delegates)
protected Connection	proxyConnection(Connection conn, String url, Properties info, Driver driver)
protected Connection	proxyConnection(Connection delegate, String url, Properties info, List<Connection> delegates)
protected PreparedStatement	proxyPreparedStatement(PreparedStatement delegate, Connection conn)
protected PreparedStatement	proxyPreparedStatement(PreparedStatement delegate, Connection conn, String sql)	Proxy a PreparedStatement with access to the original SQL.
ResultSet	proxyResultSet(Statement stmt, ResultSet delegate)
protected Statement	proxyStatement(Statement delegate, Connection conn)

Methods inherited from class org.pjdbc.sql.AbstractDriver

acceptsProtocol, acceptsSubProtocol, acceptsURL, getMajorVersion, getMinorVersion, getParentLogger, getUrlParameter, getUrlParameter, getUrlParameters, jdbcCompliant, parseUrl, protocol, subname, subprotocol, validateParameters

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractProxyDriver

public AbstractProxyDriver()

Method Details

acceptsSubName

protected boolean acceptsSubName(String subname)

Specified by:

acceptsSubName in class AbstractDriver

proxyConnection

protected Connection proxyConnection(Connection conn,
 String url,
 Properties info,
 Driver driver)
                              throws SQLException

Throws:

SQLException

proxyConnection

protected Connection proxyConnection(Connection delegate,
 String url,
 Properties info,
 List<Connection> delegates)
                              throws SQLException

Throws:

SQLException

proxyConnection

protected Connection proxyConnection(String url,
 Properties info,
 Connection[] delegates)
                              throws SQLException

Throws:

SQLException

proxyStatement

protected Statement proxyStatement(Statement delegate,
 Connection conn)
                            throws SQLException

Throws:

SQLException

proxyCallableStatement

protected CallableStatement proxyCallableStatement(CallableStatement delegate,
 Connection conn)
                                            throws SQLException

Throws:

SQLException

proxyPreparedStatement

protected PreparedStatement proxyPreparedStatement(PreparedStatement delegate,
 Connection conn)
                                            throws SQLException

Throws:

SQLException

proxyPreparedStatement

protected PreparedStatement proxyPreparedStatement(PreparedStatement delegate,
 Connection conn,
 String sql)
                                            throws SQLException

Proxy a PreparedStatement with access to the original SQL. Override this method when you need to recreate the statement (e.g., on connection failure). The default implementation ignores the SQL and delegates to proxyPreparedStatement(PreparedStatement, Connection).

Parameters:

delegate - the delegate PreparedStatement

conn - the connection

sql - the SQL used to prepare the statement

Returns:

the proxied PreparedStatement

Throws:

SQLException - if an error occurs

proxyCallableStatement

protected CallableStatement proxyCallableStatement(CallableStatement delegate,
 Connection conn,
 String sql)
                                            throws SQLException

Proxy a CallableStatement with access to the original SQL. Override this method when you need to recreate the statement (e.g., on connection failure). The default implementation ignores the SQL and delegates to proxyCallableStatement(CallableStatement, Connection).

Parameters:

delegate - the delegate CallableStatement

conn - the connection

sql - the SQL used to prepare the statement

Returns:

the proxied CallableStatement

Throws:

SQLException - if an error occurs

proxyResultSet

public ResultSet proxyResultSet(Statement stmt,
 ResultSet delegate)
                         throws SQLException

Throws:

SQLException

isValidateParametersEnabled

protected boolean isValidateParametersEnabled()

Whether to automatically validate parameters on connect. Subclasses can override to enable/disable validation.

Returns:

true to validate parameters, false to skip validation

isCompositionValidationEnabled

protected boolean isCompositionValidationEnabled()

Whether to automatically validate driver composition on connect. Subclasses can override to enable/disable validation. Can also be disabled via system property: -Dpjdbc.validation.composition=false

Returns:

true to validate composition, false to skip validation

connect

public Connection connect(String url,
 Properties info)
                   throws SQLException

Throws:

SQLException

getPropertyInfo

public DriverPropertyInfo[] getPropertyInfo(String url,
 Properties info)
                                     throws SQLException

Specified by:

getPropertyInfo in interface Driver

Overrides:

getPropertyInfo in class AbstractDriver

Throws:

SQLException