com.mysql.cj.jdbc.ha.plugins

Class ConnectionPluginManager

java.lang.Object

com.mysql.cj.jdbc.ha.plugins.ConnectionPluginManager

All Implemented Interfaces:

ITransactionContextHandler

public class ConnectionPluginManager
extends java.lang.Object
implements ITransactionContextHandler

This class creates and handles a chain of IConnectionPlugin for each connection.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_PLUGIN_FACTORIES
protected IConnectionPlugin	headPlugin
protected Log	logger
protected PropertySet	propertySet

Constructor Summary

Constructors

Constructor and Description
ConnectionPluginManager(Log logger)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	execute(java.lang.Class<?> methodInvokeOn, java.lang.String methodName, java.util.concurrent.Callable<?> executeSqlFunc, java.lang.Object[] args) Execute a JDBC method with the connection plugin chain.
void	init(ICurrentConnectionProvider currentConnectionProvider, PropertySet propertySet) Initialize a chain of IConnectionPlugin using their corresponding IConnectionPluginFactory.
void	openInitialConnection(ConnectionUrl connectionUrl)
void	releaseResources() Release all dangling resources held by the connection plugins associated with a single connection.
void	transactionBegun() Called when the driver has been told by the server that a transaction is now in progress (when one has not been currently in progress).
void	transactionCompleted() Called when the driver has been told by the server that a transaction has completed, and no transaction is currently in progress.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PLUGIN_FACTORIES

protected static final java.lang.String DEFAULT_PLUGIN_FACTORIES

logger

protected Log logger

propertySet

protected PropertySet propertySet

headPlugin

protected IConnectionPlugin headPlugin

Constructor Detail

ConnectionPluginManager

public ConnectionPluginManager(Log logger)

Method Detail

init

public void init(ICurrentConnectionProvider currentConnectionProvider,
                 PropertySet propertySet)
          throws java.sql.SQLException

Initialize a chain of IConnectionPlugin using their corresponding IConnectionPluginFactory. If PropertyKey.connectionPluginFactories is provided by the user, initialize the chain with the given connection plugins in the order they are specified. Otherwise, initialize the NodeMonitoringConnectionPlugin instead.

The DefaultConnectionPlugin will always be initialized and attached as the last connection plugin in the chain.

Parameters:

currentConnectionProvider - The connection the plugins are associated with.

propertySet - The configuration of the connection.

Throws:

java.sql.SQLException

execute

public java.lang.Object execute(java.lang.Class<?> methodInvokeOn,
                                java.lang.String methodName,
                                java.util.concurrent.Callable<?> executeSqlFunc,
                                java.lang.Object[] args)
                         throws java.lang.Exception

Execute a JDBC method with the connection plugin chain.

Parameters:

methodInvokeOn - The Java Class invoking the JDBC method.

methodName - The name of the method being invoked.

executeSqlFunc - A lambda executing the method.

Returns:

the result from the execution.

Throws:

java.lang.Exception - if errors occurred during the execution.

releaseResources

public void releaseResources()

Release all dangling resources held by the connection plugins associated with a single connection.

openInitialConnection

public void openInitialConnection(ConnectionUrl connectionUrl)
                           throws java.sql.SQLException

Throws:

java.sql.SQLException

transactionBegun

public void transactionBegun()

Description copied from interface: ITransactionContextHandler

Called when the driver has been told by the server that a transaction is now in progress (when one has not been currently in progress).

Specified by:

transactionBegun in interface ITransactionContextHandler

transactionCompleted

public void transactionCompleted()

Description copied from interface: ITransactionContextHandler

Called when the driver has been told by the server that a transaction has completed, and no transaction is currently in progress.

Specified by:

transactionCompleted in interface ITransactionContextHandler