software.aws.rds.jdbc.postgresql.ca

Class ClusterAwareWriterFailoverHandler

java.lang.Object

software.aws.rds.jdbc.postgresql.ca.ClusterAwareWriterFailoverHandler

All Implemented Interfaces:

WriterFailoverHandler

public class ClusterAwareWriterFailoverHandler
extends 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 Properties	connectionProps
protected ConnectionProvider	connectionProvider
protected int	maxFailoverTimeoutMs
protected ReaderFailoverHandler	readerFailoverHandler
protected int	readTopologyIntervalMs
protected int	reconnectWriterIntervalMs
protected TopologyService	topologyService

Constructor Summary

Constructors

Constructor and Description
ClusterAwareWriterFailoverHandler(TopologyService topologyService, ConnectionProvider connectionProvider, Properties connectionProps, ReaderFailoverHandler readerFailoverHandler) ClusterAwareWriterFailoverHandler constructor
ClusterAwareWriterFailoverHandler(TopologyService topologyService, ConnectionProvider connectionProvider, Properties connectionProps, ReaderFailoverHandler readerFailoverHandler, int failoverTimeoutMs, int readTopologyIntervalMs, int reconnectWriterIntervalMs) ClusterAwareWriterFailoverHandler constructor.

Method Summary

Modifier and Type	Method and Description
WriterFailoverResult	failover(List<HostInfo> currentTopology) Called to start Writer Failover Process.

Methods inherited from class java.lang.Object

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

Field Detail

maxFailoverTimeoutMs

protected int maxFailoverTimeoutMs

readTopologyIntervalMs

protected int readTopologyIntervalMs

reconnectWriterIntervalMs

protected int reconnectWriterIntervalMs

topologyService

protected TopologyService topologyService

connectionProvider

protected ConnectionProvider connectionProvider

readerFailoverHandler

protected ReaderFailoverHandler readerFailoverHandler

connectionProps

protected Properties connectionProps

Constructor Detail

ClusterAwareWriterFailoverHandler

public ClusterAwareWriterFailoverHandler(TopologyService topologyService,
                                         ConnectionProvider connectionProvider,
                                         Properties connectionProps,
                                         ReaderFailoverHandler readerFailoverHandler)

ClusterAwareWriterFailoverHandler constructor

Parameters:

topologyService - The topology service used to update and query the cluster topology

connectionProvider - The connection provider used to establish the database connection

connectionProps - a set of properties for a new connections

readerFailoverHandler - The reader failover handler used with this connection

ClusterAwareWriterFailoverHandler

public ClusterAwareWriterFailoverHandler(TopologyService topologyService,
                                         ConnectionProvider connectionProvider,
                                         Properties connectionProps,
                                         ReaderFailoverHandler readerFailoverHandler,
                                         int failoverTimeoutMs,
                                         int readTopologyIntervalMs,
                                         int reconnectWriterIntervalMs)

ClusterAwareWriterFailoverHandler constructor.

Parameters:

topologyService - The topology service used to update and query the cluster topology

connectionProvider - The connection provider used to establish the database connection

connectionProps - a set of properties for a new connections

readerFailoverHandler - The reader failover handler used with this connection

failoverTimeoutMs - The maximum allowable time for failover in ms

readTopologyIntervalMs - The refresh rate of the cluster topology in ms

reconnectWriterIntervalMs - The time in ms to wait before re-attempting to reconnect to the writer

Method Detail

failover

public WriterFailoverResult failover(List<HostInfo> currentTopology)
                              throws SQLException

Called to start Writer Failover Process.

Specified by:

failover in interface WriterFailoverHandler

Parameters:

currentTopology - Current topology for the cluster.

Returns:

WriterFailoverResult The results of this process.

Throws:

SQLException - if failover fails