software.amazon.jdbc.plugin.efm

Class HostMonitoringConnectionPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.efm.HostMonitoringConnectionPlugin

All Implemented Interfaces:

CanReleaseResources, ConnectionPlugin

public class HostMonitoringConnectionPlugin
extends AbstractConnectionPlugin
implements CanReleaseResources

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

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	FAILURE_DETECTION_COUNT
static AwsWrapperProperty	FAILURE_DETECTION_ENABLED
static AwsWrapperProperty	FAILURE_DETECTION_INTERVAL
static AwsWrapperProperty	FAILURE_DETECTION_TIME
protected @NonNull java.util.Properties	properties

Constructor Summary

Constructors

Constructor and Description
HostMonitoringConnectionPlugin(@NonNull PluginService pluginService, @NonNull java.util.Properties properties) Initialize the node monitoring plugin.

Method Summary

Modifier and Type	Method and Description
java.sql.Connection	connect(@NonNull java.lang.String driverProtocol, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props, boolean isInitialConnection, @NonNull JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc)
protected boolean	doesNeedMonitoring(java.lang.String methodName) Checks whether the JDBC method passed to this connection plugin requires monitoring.
<T,E extends java.lang.Exception> T	execute(java.lang.Class<T> resultClass, java.lang.Class<E> exceptionClass, java.lang.Object methodInvokeOn, java.lang.String methodName, JdbcCallable<T,E> jdbcMethodFunc, java.lang.Object[] jdbcMethodArgs) Executes the given SQL function with MonitorImpl if connection monitoring is enabled.
java.util.Set<java.lang.String>	getSubscribedMethods()
OldConnectionSuggestedAction	notifyConnectionChanged(java.util.EnumSet<NodeChangeOptions> changes)
void	releaseResources() Call this plugin's monitor service to release all resources associated with this plugin.

Methods inherited from class software.amazon.jdbc.plugin.AbstractConnectionPlugin

initHostProvider, notifyNodeListChanged

Methods inherited from class java.lang.Object

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

Field Detail

FAILURE_DETECTION_ENABLED

public static final AwsWrapperProperty FAILURE_DETECTION_ENABLED

FAILURE_DETECTION_TIME

public static final AwsWrapperProperty FAILURE_DETECTION_TIME

FAILURE_DETECTION_INTERVAL

public static final AwsWrapperProperty FAILURE_DETECTION_INTERVAL

FAILURE_DETECTION_COUNT

public static final AwsWrapperProperty FAILURE_DETECTION_COUNT

properties

protected @NonNull java.util.Properties properties

Constructor Detail

HostMonitoringConnectionPlugin

public HostMonitoringConnectionPlugin(@NonNull PluginService pluginService,
                                      @NonNull java.util.Properties properties)

Initialize the node monitoring plugin.

Parameters:

pluginService - A service allowing the plugin to retrieve the current active connection and its connection settings.

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

Method Detail

getSubscribedMethods

public java.util.Set<java.lang.String> getSubscribedMethods()

Specified by:

getSubscribedMethods in interface ConnectionPlugin

Specified by:

getSubscribedMethods in class AbstractConnectionPlugin

execute

public <T,E extends java.lang.Exception> T execute(java.lang.Class<T> resultClass,
                                                   java.lang.Class<E> exceptionClass,
                                                   java.lang.Object methodInvokeOn,
                                                   java.lang.String methodName,
                                                   JdbcCallable<T,E> jdbcMethodFunc,
                                                   java.lang.Object[] jdbcMethodArgs)
                                            throws E extends java.lang.Exception

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

Specified by:

execute in interface ConnectionPlugin

Overrides:

execute in class AbstractConnectionPlugin

Throws:

E extends java.lang.Exception

doesNeedMonitoring

protected boolean doesNeedMonitoring(java.lang.String methodName)

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

Parameters:

methodName - Name of the JDBC method.

Returns:

true if the method requires monitoring; false otherwise.

releaseResources

public void releaseResources()

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

Specified by:

releaseResources in interface CanReleaseResources

notifyConnectionChanged

public OldConnectionSuggestedAction notifyConnectionChanged(java.util.EnumSet<NodeChangeOptions> changes)

Specified by:

notifyConnectionChanged in interface ConnectionPlugin

Overrides:

notifyConnectionChanged in class AbstractConnectionPlugin

connect

public java.sql.Connection connect(@NonNull java.lang.String driverProtocol,
                                   @NonNull HostSpec hostSpec,
                                   @NonNull java.util.Properties props,
                                   boolean isInitialConnection,
                                   @NonNull JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc)
                            throws java.sql.SQLException

Specified by:

connect in interface ConnectionPlugin

Overrides:

connect in class AbstractConnectionPlugin

Throws:

java.sql.SQLException