software.amazon.jdbc.plugin.failover

Class ClusterAwareWriterFailoverHandler

java.lang.Object

software.amazon.jdbc.plugin.failover.ClusterAwareWriterFailoverHandler

All Implemented Interfaces:

WriterFailoverHandler

public class ClusterAwareWriterFailoverHandler
extends java.lang.Object
implements WriterFailoverHandler

An implementation of WriterFailoverHandler.

Writer Failover Process goal is to re-establish connection to a writer. Connection to a writer may be disrupted either by temporary network issue, or due to writer host unavailability during cluster failover. This handler tries both approaches in parallel: 1) try to re-connect to the same writer host, 2) try to update cluster topology and connect to a newly elected writer.

Field Summary

Fields

Modifier and Type	Field and Description
protected static WriterFailoverResult	DEFAULT_RESULT
protected java.util.Map<java.lang.String,HostAvailability>	hostAvailabilityMap
protected java.util.Properties	initialConnectionProps
protected int	maxFailoverTimeoutMs
protected PluginService	pluginService
protected ReaderFailoverHandler	readerFailoverHandler
protected int	readTopologyIntervalMs
protected int	reconnectWriterIntervalMs
protected FullServicesContainer	servicesContainer

Constructor Summary

Constructors

Constructor and Description
ClusterAwareWriterFailoverHandler(FullServicesContainer servicesContainer, ReaderFailoverHandler readerFailoverHandler, java.util.Properties initialConnectionProps)
ClusterAwareWriterFailoverHandler(FullServicesContainer servicesContainer, ReaderFailoverHandler readerFailoverHandler, java.util.Properties initialConnectionProps, int failoverTimeoutMs, int readTopologyIntervalMs, int reconnectWriterIntervalMs)

Method Summary

Modifier and Type	Method and Description
WriterFailoverResult	failover(java.util.List<HostSpec> currentTopology) Called to start Writer Failover Process.
java.util.Map<java.lang.String,HostAvailability>	getHostAvailabilityMap() Get the host availability map for the failover handler.
protected FullServicesContainer	newServicesContainer()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESULT

protected static final WriterFailoverResult DEFAULT_RESULT

initialConnectionProps

protected final java.util.Properties initialConnectionProps

servicesContainer

protected final FullServicesContainer servicesContainer

pluginService

protected final PluginService pluginService

readerFailoverHandler

protected final ReaderFailoverHandler readerFailoverHandler

hostAvailabilityMap

protected final java.util.Map<java.lang.String,HostAvailability> hostAvailabilityMap

maxFailoverTimeoutMs

protected int maxFailoverTimeoutMs

readTopologyIntervalMs

protected int readTopologyIntervalMs

reconnectWriterIntervalMs

protected int reconnectWriterIntervalMs

Constructor Detail

ClusterAwareWriterFailoverHandler

public ClusterAwareWriterFailoverHandler(FullServicesContainer servicesContainer,
                                         ReaderFailoverHandler readerFailoverHandler,
                                         java.util.Properties initialConnectionProps)

ClusterAwareWriterFailoverHandler

public ClusterAwareWriterFailoverHandler(FullServicesContainer servicesContainer,
                                         ReaderFailoverHandler readerFailoverHandler,
                                         java.util.Properties initialConnectionProps,
                                         int failoverTimeoutMs,
                                         int readTopologyIntervalMs,
                                         int reconnectWriterIntervalMs)

Method Detail

getHostAvailabilityMap

public java.util.Map<java.lang.String,HostAvailability> getHostAvailabilityMap()

Description copied from interface: WriterFailoverHandler

Get the host availability map for the failover handler. This map will be populated with host availability information during the failover process and can be used to determine which hosts are available.

Specified by:

getHostAvailabilityMap in interface WriterFailoverHandler

Returns:

the host availability map for the failover handler.

failover

public WriterFailoverResult failover(java.util.List<HostSpec> currentTopology)
                              throws java.sql.SQLException

Description copied from interface: WriterFailoverHandler

Called to start Writer Failover Process.

Specified by:

failover in interface WriterFailoverHandler

Parameters:

currentTopology - Cluster current topology

Returns:

WriterFailoverResult The results of this process.

Throws:

java.sql.SQLException - indicating whether the failover attempt was successful.

newServicesContainer

protected FullServicesContainer newServicesContainer()
                                              throws java.sql.SQLException

Throws:

java.sql.SQLException