software.amazon.jdbc.plugin.efm.base

Class HostMonitoringConnectionBasePlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.efm.base.HostMonitoringConnectionBasePlugin

All Implemented Interfaces:

CanReleaseResources, ConnectionPlugin, StateSnapshotProvider

Direct Known Subclasses:

HostMonitoringConnectionPluginV1, HostMonitoringConnectionPluginV2

public abstract class HostMonitoringConnectionBasePlugin
extends AbstractConnectionPlugin
implements CanReleaseResources, StateSnapshotProvider

Base plugin class to 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 boolean	isEnabled
protected @Nullable HostSpec	monitoringHostSpec
protected @Nullable HostMonitorService	monitorService
protected @NonNull java.util.function.Supplier<HostMonitorService>	monitorServiceSupplier
protected @NonNull PluginService	pluginService
protected @NonNull java.util.Properties	properties
protected RdsUtils	rdsHelper
protected java.util.Set<java.lang.String>	subscribedMethods

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HostMonitoringConnectionBasePlugin(@NonNull FullServicesContainer servicesContainer, @NonNull java.util.Properties properties, @NonNull java.util.function.Supplier<HostMonitorService> monitorServiceSupplier, RdsUtils rdsHelper) 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) Establishes a connection to the given host using the given driver protocol and properties.
<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, @Nullable java.lang.Object[] jdbcMethodArgs) Executes the given SQL function with HostMonitorV2Impl if connection monitoring is enabled.
HostSpec	getMonitoringHostSpec()
java.util.List<Pair<java.lang.String,java.lang.Object>>	getSnapshotState()
java.util.Set<java.lang.String>	getSubscribedMethods()
protected HostMonitorService	initMonitorService()
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

acceptsStrategy, forceConnect, getHostSpecByStrategy, getHostSpecByStrategy, 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

subscribedMethods

protected final java.util.Set<java.lang.String> subscribedMethods

properties

protected @NonNull java.util.Properties properties

monitorServiceSupplier

protected final @NonNull java.util.function.Supplier<HostMonitorService> monitorServiceSupplier

pluginService

protected final @NonNull PluginService pluginService

monitorService

protected @Nullable HostMonitorService monitorService

rdsHelper

protected final RdsUtils rdsHelper

monitoringHostSpec

protected @Nullable HostSpec monitoringHostSpec

isEnabled

protected final boolean isEnabled

Constructor Detail

HostMonitoringConnectionBasePlugin

protected HostMonitoringConnectionBasePlugin(@NonNull FullServicesContainer servicesContainer,
                                             @NonNull java.util.Properties properties,
                                             @NonNull java.util.function.Supplier<HostMonitorService> monitorServiceSupplier,
                                             RdsUtils rdsHelper)

Initialize the node monitoring plugin.

Parameters:

servicesContainer - The service container for the services required by this class.

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

monitorServiceSupplier - A supplier for creating a HostMonitorService instance.

rdsHelper - The RDS helper class to identify RDS instances.

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,
                                                   @Nullable java.lang.Object[] jdbcMethodArgs)
                                            throws E extends java.lang.Exception

Executes the given SQL function with HostMonitorV2Impl 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

initMonitorService

protected HostMonitorService initMonitorService()

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

Description copied from interface: ConnectionPlugin

Establishes a connection to the given host using the given driver protocol and properties. If a non-default ConnectionProvider has been set with Driver.setCustomConnectionProvider(ConnectionProvider) and ConnectionProvider.acceptsUrl(String, HostSpec, Properties) returns true for the given protocol, host, and properties, the connection will be created by the non-default ConnectionProvider. Otherwise, the connection will be created by the default ConnectionProvider. The default ConnectionProvider will be DriverConnectionProvider for connections requested via the DriverManager and DataSourceConnectionProvider for connections requested via an AwsWrapperDataSource.

Specified by:

connect in interface ConnectionPlugin

Overrides:

connect in class AbstractConnectionPlugin

Parameters:

driverProtocol - the driver protocol that should be used to establish the connection

hostSpec - the host details for the desired connection

props - the connection properties

isInitialConnection - a boolean indicating whether the current Connection is establishing an initial physical connection to the database or has already established a physical connection in the past

connectFunc - the function to call to continue the connect request down the connect pipeline

Returns:

a Connection to the requested host

Throws:

java.sql.SQLException - if there was an error establishing a Connection to the requested host

getMonitoringHostSpec

public HostSpec getMonitoringHostSpec()

getSnapshotState

public java.util.List<Pair<java.lang.String,java.lang.Object>> getSnapshotState()

Specified by:

getSnapshotState in interface StateSnapshotProvider

Overrides:

getSnapshotState in class AbstractConnectionPlugin