software.amazon.jdbc.plugin.customendpoint

Class CustomEndpointPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.customendpoint.CustomEndpointPlugin

All Implemented Interfaces:

ConnectionPlugin

public class CustomEndpointPlugin
extends AbstractConnectionPlugin

A plugin that analyzes custom endpoints for custom endpoint information and custom endpoint changes, such as adding or removing an instance in the custom endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	CACHE_CLEANUP_RATE_NANO
static AwsWrapperProperty	CUSTOM_ENDPOINT_INFO_REFRESH_RATE_MS
static AwsWrapperProperty	CUSTOM_ENDPOINT_MONITOR_IDLE_EXPIRATION_MS
protected HostSpec	customEndpointHostSpec
protected java.lang.String	customEndpointId
protected int	idleMonitorExpirationMs
protected static SlidingExpirationCacheWithCleanupThread<java.lang.String,CustomEndpointMonitor>	monitors
protected PluginService	pluginService
protected java.util.Properties	props
protected java.util.function.BiFunction<HostSpec,software.amazon.awssdk.regions.Region,software.amazon.awssdk.services.rds.RdsClient>	rdsClientFunc
protected RdsUtils	rdsUtils
protected software.amazon.awssdk.regions.Region	region
static AwsWrapperProperty	REGION_PROPERTY
protected static RegionUtils	regionUtils
protected boolean	shouldWaitForInfo
static AwsWrapperProperty	WAIT_FOR_CUSTOM_ENDPOINT_INFO
static AwsWrapperProperty	WAIT_FOR_CUSTOM_ENDPOINT_INFO_TIMEOUT_MS
protected TelemetryCounter	waitForInfoCounter
protected int	waitOnCachedInfoDurationMs

Constructor Summary

Constructors

Constructor and Description
CustomEndpointPlugin(PluginService pluginService, java.util.Properties props) Constructs a new CustomEndpointPlugin instance.
CustomEndpointPlugin(PluginService pluginService, java.util.Properties props, java.util.function.BiFunction<HostSpec,software.amazon.awssdk.regions.Region,software.amazon.awssdk.services.rds.RdsClient> rdsClientFunc) Constructs a new CustomEndpointPlugin instance.

Method Summary

Modifier and Type	Method and Description
static void	closeMonitors() Closes all active custom endpoint monitors.
java.sql.Connection	connect(java.lang.String driverProtocol, HostSpec hostSpec, java.util.Properties props, boolean isInitialConnection, JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc) Establishes a connection to the given host using the given driver protocol and properties.
protected CustomEndpointMonitor	createMonitorIfAbsent(java.util.Properties props) Creates a monitor for the custom endpoint if it does not already exist.
<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 method via a pipeline of plugins.
java.util.Set<java.lang.String>	getSubscribedMethods()
protected void	waitForCustomEndpointInfo(CustomEndpointMonitor monitor) If custom endpoint info does not exist for the current custom endpoint, waits a short time for the info to be made available by the custom endpoint monitor.

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

acceptsStrategy, forceConnect, getHostSpecByStrategy, getHostSpecByStrategy, initHostProvider, notifyConnectionChanged, notifyNodeListChanged

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_CLEANUP_RATE_NANO

protected static final long CACHE_CLEANUP_RATE_NANO

regionUtils

protected static final RegionUtils regionUtils

monitors

protected static final SlidingExpirationCacheWithCleanupThread<java.lang.String,CustomEndpointMonitor> monitors

CUSTOM_ENDPOINT_INFO_REFRESH_RATE_MS

public static final AwsWrapperProperty CUSTOM_ENDPOINT_INFO_REFRESH_RATE_MS

WAIT_FOR_CUSTOM_ENDPOINT_INFO

public static final AwsWrapperProperty WAIT_FOR_CUSTOM_ENDPOINT_INFO

WAIT_FOR_CUSTOM_ENDPOINT_INFO_TIMEOUT_MS

public static final AwsWrapperProperty WAIT_FOR_CUSTOM_ENDPOINT_INFO_TIMEOUT_MS

CUSTOM_ENDPOINT_MONITOR_IDLE_EXPIRATION_MS

public static final AwsWrapperProperty CUSTOM_ENDPOINT_MONITOR_IDLE_EXPIRATION_MS

REGION_PROPERTY

public static final AwsWrapperProperty REGION_PROPERTY

pluginService

protected final PluginService pluginService

props

protected final java.util.Properties props

rdsUtils

protected final RdsUtils rdsUtils

rdsClientFunc

protected final java.util.function.BiFunction<HostSpec,software.amazon.awssdk.regions.Region,software.amazon.awssdk.services.rds.RdsClient> rdsClientFunc

waitForInfoCounter

protected final TelemetryCounter waitForInfoCounter

shouldWaitForInfo

protected final boolean shouldWaitForInfo

waitOnCachedInfoDurationMs

protected final int waitOnCachedInfoDurationMs

idleMonitorExpirationMs

protected final int idleMonitorExpirationMs

customEndpointHostSpec

protected HostSpec customEndpointHostSpec

customEndpointId

protected java.lang.String customEndpointId

region

protected software.amazon.awssdk.regions.Region region

Constructor Detail

CustomEndpointPlugin

public CustomEndpointPlugin(PluginService pluginService,
                            java.util.Properties props)

Constructs a new CustomEndpointPlugin instance.

Parameters:

pluginService - The plugin service that the custom endpoint plugin should use.

props - The properties that the custom endpoint plugin should use.

CustomEndpointPlugin

public CustomEndpointPlugin(PluginService pluginService,
                            java.util.Properties props,
                            java.util.function.BiFunction<HostSpec,software.amazon.awssdk.regions.Region,software.amazon.awssdk.services.rds.RdsClient> rdsClientFunc)

Constructs a new CustomEndpointPlugin instance.

Parameters:

pluginService - The plugin service that the custom endpoint plugin should use.

props - The properties that the custom endpoint plugin should use.

rdsClientFunc - The function to call to obtain an RdsClient instance.

Method Detail

getSubscribedMethods

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

Specified by:

getSubscribedMethods in interface ConnectionPlugin

Specified by:

getSubscribedMethods in class AbstractConnectionPlugin

connect

public java.sql.Connection connect(java.lang.String driverProtocol,
                                   HostSpec hostSpec,
                                   java.util.Properties props,
                                   boolean isInitialConnection,
                                   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 ConnectionProviderManager.setConnectionProvider(software.amazon.jdbc.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

createMonitorIfAbsent

protected CustomEndpointMonitor createMonitorIfAbsent(java.util.Properties props)

Creates a monitor for the custom endpoint if it does not already exist.

Parameters:

props - The connection properties.

waitForCustomEndpointInfo

protected void waitForCustomEndpointInfo(CustomEndpointMonitor monitor)
                                  throws java.sql.SQLException

If custom endpoint info does not exist for the current custom endpoint, waits a short time for the info to be made available by the custom endpoint monitor. This is necessary so that other plugins can rely on accurate custom endpoint info. Since custom endpoint monitors and information are shared, we should not have to wait often.

Throws:

java.sql.SQLException

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 method via a pipeline of plugins. If a custom endpoint is being used, a monitor for that custom endpoint will be created if it does not already exist.

Specified by:

execute in interface ConnectionPlugin

Overrides:

execute in class AbstractConnectionPlugin

Type Parameters:

T - The type of the result returned by the method.

E - The desired type for any exceptions that occur while executing the jdbcMethodFunc.

Parameters:

resultClass - The class of the object returned by the jdbcMethodFunc.

exceptionClass - The desired exception class for any exceptions that occur while executing the jdbcMethodFunc.

methodInvokeOn - The object that the jdbcMethodFunc is being invoked on.

methodName - The name of the method being invoked.

jdbcMethodFunc - The execute pipeline to call to invoke the method.

jdbcMethodArgs - The arguments to the method being invoked.

Returns:

The result of the method invocation.

Throws:

E - If an exception occurs, either directly in this method, or while executing the jdbcMethodFunc.

E extends java.lang.Exception

closeMonitors

public static void closeMonitors()

Closes all active custom endpoint monitors.