software.amazon.jdbc.plugin.failover

Interface ReaderFailoverHandler

All Known Implementing Classes:

ClusterAwareReaderFailoverHandler

public interface ReaderFailoverHandler

Interface for Reader Failover Process handler. This handler implements all necessary logic to try to reconnect to another reader host.

Method Summary

Modifier and Type	Method and Description
ReaderFailoverResult	failover(java.util.List<HostSpec> hosts, HostSpec currentHost) Called to start Reader Failover Process.
ReaderFailoverResult	getReaderConnection(java.util.List<HostSpec> hostList) Called to get any available reader connection.

Method Detail

failover

ReaderFailoverResult failover(java.util.List<HostSpec> hosts,
                              HostSpec currentHost)
                       throws java.sql.SQLException

Called to start Reader Failover Process. This process tries to connect to any reader. If no reader is available then driver may also try to connect to a writer host, down hosts, and the current reader host.

Parameters:

hosts - Cluster current topology.

currentHost - The currently connected host that has failed.

Returns:

ReaderFailoverResult The results of this process.

Throws:

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

getReaderConnection

ReaderFailoverResult getReaderConnection(java.util.List<HostSpec> hostList)
                                  throws java.sql.SQLException

Called to get any available reader connection. If no reader is available then result of process is unsuccessful. This process will not attempt to connect to the writer host.

Parameters:

hostList - Cluster current topology.

Returns:

ReaderFailoverResult The results of this process.

Throws:

java.sql.SQLException - if any error occurred while attempting a reader connection.