com.mysql.cj.jdbc.ha.plugins.failover

Class WriterFailoverResult

java.lang.Object

com.mysql.cj.jdbc.ha.plugins.failover.WriterFailoverResult

public class WriterFailoverResult
extends java.lang.Object

This class holds results of Writer Failover Process.

Constructor Summary

Constructors

Constructor and Description
WriterFailoverResult(boolean isConnected, boolean isNewHost, java.util.List<HostInfo> topology, JdbcConnection newConnection, java.lang.String taskName) WriterFailoverResult constructor.
WriterFailoverResult(boolean isConnected, boolean isNewHost, java.util.List<HostInfo> topology, JdbcConnection newConnection, java.lang.String taskName, java.sql.SQLException exception)

Method Summary

Modifier and Type	Method and Description
java.sql.SQLException	getException() Get the exception raised during failover.
JdbcConnection	getNewConnection() Get the new connection established by the failover procedure if successful.
java.lang.String	getTaskName() Get the name of the writer failover task that created this result.
java.util.List<HostInfo>	getTopology() Get the latest topology.
boolean	isConnected() Checks if process result is successful and new connection to host is established.
boolean	isNewHost() Checks if process successfully connected to a new host.

Methods inherited from class java.lang.Object

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

Constructor Detail

WriterFailoverResult

public WriterFailoverResult(boolean isConnected,
                            boolean isNewHost,
                            java.util.List<HostInfo> topology,
                            JdbcConnection newConnection,
                            java.lang.String taskName)

WriterFailoverResult constructor.

WriterFailoverResult

public WriterFailoverResult(boolean isConnected,
                            boolean isNewHost,
                            java.util.List<HostInfo> topology,
                            JdbcConnection newConnection,
                            java.lang.String taskName,
                            java.sql.SQLException exception)

Method Detail

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.

isNewHost

public boolean isNewHost()

Checks if process successfully connected to a new host.

Returns:

True, if process successfully connected to a new host. False, if process successfully re-connected to the same host.

getTopology

public java.util.List<HostInfo> getTopology()

Get the latest topology.

Returns:

List of hosts that represent the latest topology. Returns null if no connection is established.

getNewConnection

public JdbcConnection getNewConnection()

Get the new connection established by the failover procedure if successful.

Returns:

JdbcConnection New connection to a host. Returns null if the failover procedure was unsuccessful.

getTaskName

public java.lang.String getTaskName()

Get the name of the writer failover task that created this result.

Returns:

The name of the writer failover task that created this result.

getException

public java.sql.SQLException getException()

Get the exception raised during failover.

Returns:

a SQLException.