software.amazon.jdbc.plugin.gdbfailover

Class GlobalDbFailoverConnectionPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin

software.amazon.jdbc.plugin.gdbfailover.GlobalDbFailoverConnectionPlugin

All Implemented Interfaces:

ConnectionPlugin, StateSnapshotProvider

public class GlobalDbFailoverConnectionPlugin
extends FailoverConnectionPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable java.util.Set<java.lang.String>	accessibleRegions
static AwsWrapperProperty	ACTIVE_HOME_FAILOVER_MODE
protected GlobalDbFailoverMode	activeHomeFailoverMode
static AwsWrapperProperty	FAILOVER_HOME_REGION
protected java.lang.String	homeRegion
static AwsWrapperProperty	INACTIVE_HOME_FAILOVER_MODE
protected GlobalDbFailoverMode	inactiveHomeFailoverMode
protected RetryUtil	retryUtil

Fields inherited from class software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin

closedExplicitly, ENABLE_CONNECT_FAILOVER, FAILOVER_MODE, FAILOVER_READER_HOST_SELECTOR_STRATEGY, FAILOVER_TIMEOUT_MS, failoverMode, failoverReaderFailedCounter, failoverReaderHostSelectorStrategySetting, failoverReaderSuccessCounter, failoverReaderTriggeredCounter, failoverTimeoutMsSetting, failoverWriterFailedCounter, failoverWriterSuccessCounter, failoverWriterTriggeredCounter, hostListProviderService, isClosed, isInTransaction, lastExceptionDealtWith, pluginManagerService, pluginService, properties, rdsHelper, rdsUrlType, servicesContainer, SKIP_FAILOVER_ON_INTERRUPTED_THREAD, skipFailoverOnInterruptedThread, staleDnsHelper, subscribedMethods, TELEMETRY_FAILOVER_ADDITIONAL_TOP_TRACE, telemetryFailoverAdditionalTopTraceSetting

Constructor Summary

Constructors

Constructor and Description
GlobalDbFailoverConnectionPlugin(FullServicesContainer servicesContainer, java.util.Properties properties)

Method Summary

Modifier and Type	Method and Description
protected void	failover() Initiates the failover procedure.
protected void	failoverReader()
protected void	failoverToAllowedHost(@NonNull java.util.function.Supplier<java.util.Set<HostSpec>> allowedHosts, @Nullable HostRole verifyRole, long failoverEndNano)
protected void	failoverToWriter(HostSpec writerCandidate, long failoverEndNano)
protected void	failoverWriter()
protected void	initFailoverMode()
protected boolean	isInAccessibleRegion(HostSpec host) Checks if a host is in one of the accessible regions.
protected boolean	isStrictWriterFailoverMode()

Methods inherited from class software.amazon.jdbc.plugin.failover2.FailoverConnectionPlugin

allowedOnClosedConnection, canDirectExecute, connect, dealWithIllegalStateException, dealWithOriginalException, execute, getReaderFailoverConnection, getSnapshotState, getSubscribedMethodNames, getSubscribedMethods, initHostProvider, invalidateCurrentConnection, invalidInvocationOnClosedConnection, isFailoverEnabled, notifyNodeListChanged, pickNewConnection, shouldExceptionTriggerConnectionSwitch, throwFailoverSuccessException

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

acceptsStrategy, forceConnect, getHostSpecByStrategy, getHostSpecByStrategy, notifyConnectionChanged

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVE_HOME_FAILOVER_MODE

public static final AwsWrapperProperty ACTIVE_HOME_FAILOVER_MODE

INACTIVE_HOME_FAILOVER_MODE

public static final AwsWrapperProperty INACTIVE_HOME_FAILOVER_MODE

FAILOVER_HOME_REGION

public static final AwsWrapperProperty FAILOVER_HOME_REGION

retryUtil

protected final RetryUtil retryUtil

activeHomeFailoverMode

protected GlobalDbFailoverMode activeHomeFailoverMode

inactiveHomeFailoverMode

protected GlobalDbFailoverMode inactiveHomeFailoverMode

homeRegion

protected java.lang.String homeRegion

accessibleRegions

protected @Nullable java.util.Set<java.lang.String> accessibleRegions

Constructor Detail

GlobalDbFailoverConnectionPlugin

public GlobalDbFailoverConnectionPlugin(FullServicesContainer servicesContainer,
                                        java.util.Properties properties)

Method Detail

initFailoverMode

protected void initFailoverMode()
                         throws java.sql.SQLException

Overrides:

initFailoverMode in class FailoverConnectionPlugin

Throws:

java.sql.SQLException

isStrictWriterFailoverMode

protected boolean isStrictWriterFailoverMode()

Overrides:

isStrictWriterFailoverMode in class FailoverConnectionPlugin

failover

protected void failover()
                 throws java.sql.SQLException

Description copied from class: FailoverConnectionPlugin

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

Overrides:

failover in class FailoverConnectionPlugin

Throws:

java.sql.SQLException - if an error occurs

isInAccessibleRegion

protected boolean isInAccessibleRegion(HostSpec host)

Checks if a host is in one of the accessible regions. If accessibleRegions is null (no restriction), all hosts are considered accessible.

Parameters:

host - the host to check

Returns:

true if the host is in an accessible region or if no region restriction is set

failoverToWriter

protected void failoverToWriter(HostSpec writerCandidate,
                                long failoverEndNano)
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

failoverToAllowedHost

protected void failoverToAllowedHost(@NonNull java.util.function.Supplier<java.util.Set<HostSpec>> allowedHosts,
                                     @Nullable HostRole verifyRole,
                                     long failoverEndNano)
                              throws java.sql.SQLException

Throws:

java.sql.SQLException

failoverReader

protected void failoverReader()
                       throws java.sql.SQLException

Overrides:

failoverReader in class FailoverConnectionPlugin

Throws:

java.sql.SQLException

failoverWriter

protected void failoverWriter()
                       throws java.sql.SQLException

Overrides:

failoverWriter in class FailoverConnectionPlugin

Throws:

java.sql.SQLException