Package org.pjdbc.drivers

Class TimeoutDriver

java.lang.Object

org.pjdbc.sql.AbstractDriver

org.pjdbc.sql.AbstractProxyDriver

org.pjdbc.drivers.TimeoutDriver

All Implemented Interfaces:

Driver

@DriverCapability(prefix="timeout",
                  description="Enforces query timeout limits on all statements",
                  capabilities="resilience")
@DriverParameter(name="queryTimeout",type=INTEGER,description="Query timeout in seconds (0 = no timeout)",defaultValue="30",min=0L) @DriverParameter(name="cancelOnTimeout",type=BOOLEAN,description="Whether to attempt cancellation on timeout",defaultValue="true")
public class TimeoutDriver
extends AbstractProxyDriver

TimeoutDriver enforces query timeout limits on all statements.

This driver wraps statements and applies a configurable query timeout using JDBC's Statement.setQueryTimeout() method. When a query exceeds the timeout, the database driver throws a SQLException.

URL format: jdbc:timeout[param=value,...]:jdbc:target:...

Example URLs:

 jdbc:timeout:jdbc:postgresql://localhost/mydb
 jdbc:timeout[queryTimeout=60]:jdbc:postgresql://localhost/mydb
 jdbc:timeout[queryTimeout=10,cancelOnTimeout=false]:jdbc:mysql://localhost/db
 

Notes:

• Timeout of 0 means no timeout (unlimited)
• The actual timeout behavior depends on the underlying JDBC driver
• Some databases may not support query cancellation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeoutDriver.TimeoutConfig	Configuration holder for timeout parameters.

Driver Parameters

URL format: jdbc:timeout[param=value,...]:<target-url>

Parameter	Type	Default	Constraints	Description
queryTimeout	integer	30	≥ 0	Query timeout in seconds (0 = no timeout)
cancelOnTimeout	boolean	true	-	Whether to attempt cancellation on timeout

Constructor Summary

Constructors

Constructor	Description
TimeoutDriver()

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptsSubName(String subname)
protected boolean	acceptsSubProtocol(String subprotocol)
Connection	connect(String url, Properties info)
static TimeoutDriver.TimeoutConfig	getTimeoutConfig(Connection conn)	Get the timeout configuration for a connection.
protected CallableStatement	proxyCallableStatement(CallableStatement delegate, Connection conn)
protected Connection	proxyConnection(Connection delegate, String url, Properties info, Driver driver)
protected PreparedStatement	proxyPreparedStatement(PreparedStatement delegate, Connection conn)
protected Statement	proxyStatement(Statement delegate, Connection conn)

Methods inherited from class org.pjdbc.sql.AbstractProxyDriver

getPropertyInfo, isCompositionValidationEnabled, isValidateParametersEnabled, proxyCallableStatement, proxyConnection, proxyConnection, proxyPreparedStatement, proxyResultSet

Methods inherited from class org.pjdbc.sql.AbstractDriver

acceptsProtocol, 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

TimeoutDriver

public TimeoutDriver()

Method Details

acceptsSubProtocol

protected boolean acceptsSubProtocol(String subprotocol)

Specified by:

acceptsSubProtocol in class AbstractDriver

acceptsSubName

protected boolean acceptsSubName(String subname)

Overrides:

acceptsSubName in class AbstractProxyDriver

connect

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

Specified by:

connect in interface Driver

Overrides:

connect in class AbstractProxyDriver

Throws:

SQLException

proxyConnection

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

Overrides:

proxyConnection in class AbstractProxyDriver

Throws:

SQLException

proxyStatement

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

Overrides:

proxyStatement in class AbstractProxyDriver

Throws:

SQLException

proxyPreparedStatement

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

Overrides:

proxyPreparedStatement in class AbstractProxyDriver

Throws:

SQLException

proxyCallableStatement

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

Overrides:

proxyCallableStatement in class AbstractProxyDriver

Throws:

SQLException

getTimeoutConfig

public static TimeoutDriver.TimeoutConfig getTimeoutConfig(Connection conn)

Get the timeout configuration for a connection. Returns null if connection is not a TimeoutDriver connection.