software.amazon.jdbc.plugin.failover

Class ReaderFailoverResult

java.lang.Object

software.amazon.jdbc.plugin.failover.ReaderFailoverResult

public class ReaderFailoverResult
extends java.lang.Object

This class holds results of Reader Failover Process.

Constructor Summary

Constructors

Constructor and Description
ReaderFailoverResult(@Nullable java.sql.Connection newConnection, @Nullable HostSpec newHost, boolean isConnected)
ReaderFailoverResult(@Nullable java.sql.Connection newConnection, @Nullable HostSpec newHost, boolean isConnected, @Nullable java.sql.SQLException exception)

Method Summary

Modifier and Type	Method and Description
@Nullable java.sql.Connection	getConnection() Get new connection to a host.
@Nullable java.sql.SQLException	getException() Get the exception raised during failover.
@Nullable HostSpec	getHost() Get newly connected host spec.
boolean	isConnected() Checks if process result is successful and new connection to host is established.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReaderFailoverResult

public ReaderFailoverResult(@Nullable java.sql.Connection newConnection,
                            @Nullable HostSpec newHost,
                            boolean isConnected)

ReaderFailoverResult

public ReaderFailoverResult(@Nullable java.sql.Connection newConnection,
                            @Nullable HostSpec newHost,
                            boolean isConnected,
                            @Nullable java.sql.SQLException exception)

Method Detail

getConnection

public @Nullable java.sql.Connection getConnection()

Get new connection to a host.

Returns:

Connection New connection to a host. Returns null if no connection is established.

getHost

public @Nullable HostSpec getHost()

Get newly connected host spec.

Returns:

Newly connected host. Returns null if no connection is established.

isConnected

public boolean isConnected()

Checks if process result is successful and new connection to host is established.

Returns:

True, if process successfully connected to a host.

getException

public @Nullable java.sql.SQLException getException()

Get the exception raised during failover.

Returns:

a SQLException.