software.amazon.jdbc.plugin.failover2

Class FailoverConnectionPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin

All Implemented Interfaces:

ConnectionPlugin

public class FailoverConnectionPlugin
extends AbstractConnectionPlugin

Failover Plugin v.2 This plugin provides cluster-aware failover features. The plugin switches connections upon detecting communication related exceptions and/or cluster topology changes.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closedExplicitly
static AwsWrapperProperty	ENABLE_CONNECT_FAILOVER
static AwsWrapperProperty	FAILOVER_MODE
static AwsWrapperProperty	FAILOVER_READER_HOST_SELECTOR_STRATEGY
static AwsWrapperProperty	FAILOVER_TIMEOUT_MS
protected FailoverMode	failoverMode
protected TelemetryCounter	failoverReaderFailedCounter
protected java.lang.String	failoverReaderHostSelectorStrategySetting
protected TelemetryCounter	failoverReaderSuccessCounter
protected TelemetryCounter	failoverReaderTriggeredCounter
protected int	failoverTimeoutMsSetting
protected TelemetryCounter	failoverWriterFailedCounter
protected TelemetryCounter	failoverWriterSuccessCounter
protected TelemetryCounter	failoverWriterTriggeredCounter
protected HostListProviderService	hostListProviderService
protected boolean	isClosed
protected boolean	isInTransaction
protected java.lang.Throwable	lastExceptionDealtWith
protected PluginManagerService	pluginManagerService
protected PluginService	pluginService
protected java.util.Properties	properties
protected RdsUtils	rdsHelper
protected RdsUrlType	rdsUrlType
static AwsWrapperProperty	SKIP_FAILOVER_ON_INTERRUPTED_THREAD
protected boolean	skipFailoverOnInterruptedThread
protected AuroraStaleDnsHelper	staleDnsHelper
static AwsWrapperProperty	TELEMETRY_FAILOVER_ADDITIONAL_TOP_TRACE
protected boolean	telemetryFailoverAdditionalTopTraceSetting

Constructor Summary

Constructors

Constructor and Description
FailoverConnectionPlugin(PluginService pluginService, java.util.Properties properties)

Method Summary

Modifier and Type	Method and Description
protected boolean	allowedOnClosedConnection(java.lang.String methodName) Checks if the given method is allowed on closed connections.
protected boolean	canDirectExecute(java.lang.String methodName) Check whether the method provided can be executed directly without the failover functionality.
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 <E extends java.lang.Exception> void	dealWithIllegalStateException(java.lang.IllegalStateException e, java.lang.Class<E> exceptionClass)
protected <E extends java.lang.Exception> void	dealWithOriginalException(java.lang.Throwable originalException, java.lang.Throwable wrapperException, java.lang.Class<E> exceptionClass)
<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)
protected void	failover() Initiates the failover procedure.
protected void	failoverReader()
protected void	failoverWriter()
protected ReaderFailoverResult	getReaderFailoverConnection(long failoverEndTimeNano)
java.util.Set<java.lang.String>	getSubscribedMethods()
protected void	initFailoverMode()
void	initHostProvider(java.lang.String driverProtocol, java.lang.String initialUrl, java.util.Properties properties, HostListProviderService hostListProviderService, JdbcCallable<java.lang.Void,java.sql.SQLException> initHostProviderFunc)
protected void	invalidateCurrentConnection()
protected void	invalidInvocationOnClosedConnection()
protected boolean	isFailoverEnabled()
protected void	pickNewConnection()
protected boolean	shouldExceptionTriggerConnectionSwitch(java.lang.Throwable t)
protected void	throwFailoverSuccessException()

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

acceptsStrategy, forceConnect, getHostSpecByStrategy, getHostSpecByStrategy, notifyConnectionChanged, notifyNodeListChanged

Methods inherited from class java.lang.Object

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

Field Detail

FAILOVER_TIMEOUT_MS

public static final AwsWrapperProperty FAILOVER_TIMEOUT_MS

FAILOVER_MODE

public static final AwsWrapperProperty FAILOVER_MODE

TELEMETRY_FAILOVER_ADDITIONAL_TOP_TRACE

public static final AwsWrapperProperty TELEMETRY_FAILOVER_ADDITIONAL_TOP_TRACE

FAILOVER_READER_HOST_SELECTOR_STRATEGY

public static final AwsWrapperProperty FAILOVER_READER_HOST_SELECTOR_STRATEGY

ENABLE_CONNECT_FAILOVER

public static final AwsWrapperProperty ENABLE_CONNECT_FAILOVER

SKIP_FAILOVER_ON_INTERRUPTED_THREAD

public static final AwsWrapperProperty SKIP_FAILOVER_ON_INTERRUPTED_THREAD

pluginService

protected final PluginService pluginService

properties

protected final java.util.Properties properties

failoverTimeoutMsSetting

protected int failoverTimeoutMsSetting

failoverMode

protected FailoverMode failoverMode

telemetryFailoverAdditionalTopTraceSetting

protected boolean telemetryFailoverAdditionalTopTraceSetting

failoverReaderHostSelectorStrategySetting

protected java.lang.String failoverReaderHostSelectorStrategySetting

closedExplicitly

protected boolean closedExplicitly

isClosed

protected boolean isClosed

rdsHelper

protected final RdsUtils rdsHelper

lastExceptionDealtWith

protected java.lang.Throwable lastExceptionDealtWith

pluginManagerService

protected PluginManagerService pluginManagerService

isInTransaction

protected boolean isInTransaction

rdsUrlType

protected RdsUrlType rdsUrlType

hostListProviderService

protected HostListProviderService hostListProviderService

staleDnsHelper

protected final AuroraStaleDnsHelper staleDnsHelper

failoverWriterTriggeredCounter

protected final TelemetryCounter failoverWriterTriggeredCounter

failoverWriterSuccessCounter

protected final TelemetryCounter failoverWriterSuccessCounter

failoverWriterFailedCounter

protected final TelemetryCounter failoverWriterFailedCounter

failoverReaderTriggeredCounter

protected final TelemetryCounter failoverReaderTriggeredCounter

failoverReaderSuccessCounter

protected final TelemetryCounter failoverReaderSuccessCounter

failoverReaderFailedCounter

protected final TelemetryCounter failoverReaderFailedCounter

skipFailoverOnInterruptedThread

protected final boolean skipFailoverOnInterruptedThread

Constructor Detail

FailoverConnectionPlugin

public FailoverConnectionPlugin(PluginService pluginService,
                                java.util.Properties properties)

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

Specified by:

execute in interface ConnectionPlugin

Overrides:

execute in class AbstractConnectionPlugin

Throws:

E extends java.lang.Exception

initHostProvider

public void initHostProvider(java.lang.String driverProtocol,
                             java.lang.String initialUrl,
                             java.util.Properties properties,
                             HostListProviderService hostListProviderService,
                             JdbcCallable<java.lang.Void,java.sql.SQLException> initHostProviderFunc)
                      throws java.sql.SQLException

Specified by:

initHostProvider in interface ConnectionPlugin

Overrides:

initHostProvider in class AbstractConnectionPlugin

Throws:

java.sql.SQLException

isFailoverEnabled

protected boolean isFailoverEnabled()

invalidInvocationOnClosedConnection

protected void invalidInvocationOnClosedConnection()
                                            throws java.sql.SQLException

Throws:

java.sql.SQLException

allowedOnClosedConnection

protected boolean allowedOnClosedConnection(java.lang.String methodName)

Checks if the given method is allowed on closed connections.

Parameters:

methodName - A method name to check.

Returns:

true if the given method is allowed on closed connections

dealWithOriginalException

protected <E extends java.lang.Exception> void dealWithOriginalException(java.lang.Throwable originalException,
                                                                         java.lang.Throwable wrapperException,
                                                                         java.lang.Class<E> exceptionClass)
                                                                  throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

dealWithIllegalStateException

protected <E extends java.lang.Exception> void dealWithIllegalStateException(java.lang.IllegalStateException e,
                                                                             java.lang.Class<E> exceptionClass)
                                                                      throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

failover

protected void failover()
                 throws java.sql.SQLException

Initiates the failover procedure. This process tries to establish a new connection to an instance in the topology.

Throws:

java.sql.SQLException - if an error occurs

failoverReader

protected void failoverReader()
                       throws java.sql.SQLException

Throws:

java.sql.SQLException

getReaderFailoverConnection

protected ReaderFailoverResult getReaderFailoverConnection(long failoverEndTimeNano)
                                                    throws java.util.concurrent.TimeoutException

Throws:

java.util.concurrent.TimeoutException

throwFailoverSuccessException

protected void throwFailoverSuccessException()
                                      throws java.sql.SQLException

Throws:

java.sql.SQLException

failoverWriter

protected void failoverWriter()
                       throws java.sql.SQLException

Throws:

java.sql.SQLException

invalidateCurrentConnection

protected void invalidateCurrentConnection()

pickNewConnection

protected void pickNewConnection()
                          throws java.sql.SQLException

Throws:

java.sql.SQLException

shouldExceptionTriggerConnectionSwitch

protected boolean shouldExceptionTriggerConnectionSwitch(java.lang.Throwable t)

canDirectExecute

protected boolean canDirectExecute(java.lang.String methodName)

Check whether the method provided can be executed directly without the failover functionality.

Parameters:

methodName - The name of the method that is being called

Returns:

true if the method can be executed directly; false otherwise.

initFailoverMode

protected void initFailoverMode()

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 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