com.mysql.cj.jdbc.ha.plugins

Class NodeMonitoringConnectionPlugin

java.lang.Object

com.mysql.cj.jdbc.ha.plugins.NodeMonitoringConnectionPlugin

All Implemented Interfaces:

IConnectionPlugin, ITransactionContextHandler

public class NodeMonitoringConnectionPlugin
extends java.lang.Object
implements IConnectionPlugin

Monitor the server while the connection is executing methods for more sophisticated failure detection.

Field Summary

Fields

Modifier and Type	Field and Description
protected Log	logger
protected IConnectionPlugin	nextPlugin
protected PropertySet	propertySet

Constructor Summary

Constructors

Constructor and Description
NodeMonitoringConnectionPlugin(ICurrentConnectionProvider currentConnectionProvider, PropertySet propertySet, IConnectionPlugin nextPlugin, Log logger) Initialize the node monitoring plugin.

Method Summary

Modifier and Type	Method and Description
protected boolean	doesNeedMonitoring(java.lang.Class<?> methodInvokeOn, java.lang.String methodName) Checks whether the JDBC method passed to this connection plugin requires monitoring.
java.lang.Object	execute(java.lang.Class<?> methodInvokeOn, java.lang.String methodName, java.util.concurrent.Callable<?> executeSqlFunc, java.lang.Object[] args) Executes the given SQL function with Monitor if connection monitoring is enabled.
void	openInitialConnection(ConnectionUrl connectionUrl)
void	releaseResources() Call this plugin's monitor service to release all resources associated with this plugin.
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

nextPlugin

protected IConnectionPlugin nextPlugin

logger

protected Log logger

propertySet

protected PropertySet propertySet

Constructor Detail

NodeMonitoringConnectionPlugin

public NodeMonitoringConnectionPlugin(ICurrentConnectionProvider currentConnectionProvider,
                                      PropertySet propertySet,
                                      IConnectionPlugin nextPlugin,
                                      Log logger)

Initialize the node monitoring plugin.

Parameters:

currentConnectionProvider - A provider allowing the plugin to retrieve the current active connection and its connection settings.

propertySet - The property set used to initialize the active connection.

nextPlugin - The next connection plugin in the chain.

logger - An implementation of Log.

Method Detail

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

Executes the given SQL function with Monitor if connection monitoring is enabled. Otherwise, executes the SQL function directly.

Specified by:

execute in interface IConnectionPlugin

Parameters:

methodInvokeOn - Class of an object that method to monitor to be invoked on.

methodName - Name of the method to monitor.

executeSqlFunc - Callable SQL function.

args - Arguments used to execute the given method.

Returns:

Results of the Callable SQL function.

Throws:

java.lang.Exception - if an error occurs.

doesNeedMonitoring

protected boolean doesNeedMonitoring(java.lang.Class<?> methodInvokeOn,
                                     java.lang.String methodName)

Checks whether the JDBC method passed to this connection plugin requires monitoring.

Parameters:

methodInvokeOn - The class of the JDBC method.

methodName - Name of the JDBC method.

Returns:

true if the method requires monitoring; false otherwise.

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

openInitialConnection

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

Specified by:

openInitialConnection in interface IConnectionPlugin

Throws:

java.sql.SQLException

releaseResources

public void releaseResources()

Call this plugin's monitor service to release all resources associated with this plugin.

Specified by:

releaseResources in interface IConnectionPlugin