Package io.opentelemetry.instrumentation.jdbc

Class OpenTelemetryDriver

java.lang.Object

io.opentelemetry.instrumentation.jdbc.OpenTelemetryDriver

All Implemented Interfaces:

Driver

public final class OpenTelemetryDriver
extends Object
implements Driver

JDBC driver for OpenTelemetry.

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryDriver()

Method Summary

Modifier and Type	Method	Description
boolean	acceptsURL(String url)
static void	addDriverCandidate(Driver driver)	Add driver candidate that wasn't registered against DriverManager.
Connection	connect(String url, Properties info)
static void	deregister()	According to JDBC specification, this driver is registered against DriverManager when the class is loaded.
int	getMajorVersion()
int	getMinorVersion()
Logger	getParentLogger()
DriverPropertyInfo[]	getPropertyInfo(String url, Properties info)
static boolean	isRegistered()	Returns true if the driver is registered against DriverManager.
boolean	jdbcCompliant()	Returns false because not all delegated drivers are JDBC compliant.
static void	register()	Register the driver against DriverManager.
static boolean	removeDriverCandidate(Driver driver)	Remove driver added via addDriverCandidate(Driver).

Methods inherited from class java.lang.Object

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

Constructor Details

OpenTelemetryDriver

public OpenTelemetryDriver()

Method Details

register

public static void register()
                     throws SQLException

Register the driver against DriverManager. This is done automatically when the class is loaded. Dropping the driver from DriverManager's list is possible using deregister() method.

Throws:

IllegalStateException - if the driver is already registered

SQLException - if registering the driver fails

deregister

public static void deregister()
                       throws SQLException

According to JDBC specification, this driver is registered against DriverManager when the class is loaded. To avoid leaks, this method allow unregistering the driver so that the class can be gc'ed if necessary.

Throws:

IllegalStateException - if the driver is not registered

SQLException - if deregistering the driver fails

isRegistered

public static boolean isRegistered()

Returns true if the driver is registered against DriverManager.

addDriverCandidate

public static void addDriverCandidate(Driver driver)

Add driver candidate that wasn't registered against DriverManager. This is mainly useful when drivers are initialized at native image build time, and you don't want to postpone class initialization, for runtime initialization could make driver incompatible with other systems. Drivers registered with this method have higher priority over those registered against DriverManager.

Parameters:

driver - Driver that should be registered

removeDriverCandidate

public static boolean removeDriverCandidate(Driver driver)

Remove driver added via addDriverCandidate(Driver).

Parameters:

driver - Driver that should be unregistered

Returns:

true if the driver was unregistered

connect

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

Specified by:

connect in interface Driver

Throws:

SQLException

acceptsURL

public boolean acceptsURL(String url)

Specified by:

acceptsURL in interface Driver

getPropertyInfo

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

Specified by:

getPropertyInfo in interface Driver

Throws:

SQLException

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface Driver

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface Driver

jdbcCompliant

public boolean jdbcCompliant()

Returns false because not all delegated drivers are JDBC compliant.

Specified by:

jdbcCompliant in interface Driver

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface Driver

Throws:

SQLFeatureNotSupportedException