com.mysql.cj.jdbc.ha

Class ReplicationConnectionProxy

java.lang.Object

com.mysql.cj.jdbc.ha.MultiHostConnectionProxy

com.mysql.cj.jdbc.ha.ReplicationConnectionProxy

All Implemented Interfaces:

PingTarget, java.lang.reflect.InvocationHandler

public class ReplicationConnectionProxy
extends MultiHostConnectionProxy
implements PingTarget

Connection that opens two connections, one two a replication master, and another to one or more slaves, and decides to use master when the connection is not read-only, and use slave(s) when the connection is read-only.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowMasterDownConnections
protected boolean	allowSlaveDownConnections
protected boolean	enableJMX
protected LoadBalancedConnection	masterConnection
protected boolean	readFromMasterWhenNoSlaves
protected boolean	readFromMasterWhenNoSlavesOriginal
protected boolean	readOnly
protected LoadBalancedConnection	slavesConnection

Fields inherited from class com.mysql.cj.jdbc.ha.MultiHostConnectionProxy

autoReconnect, closedExplicitly, closedReason, connectionUrl, currentConnection, hostsList, isClosed, lastExceptionDealtWith, thisAsConnection

Method Summary

Modifier and Type	Method and Description
void	addSlaveHost(java.lang.String hostPortPair)
static ReplicationConnection	createProxyInstance(ConnectionUrl connectionUrl) Static factory to create ReplicationConnection instances.
protected void	doAbort(java.util.concurrent.Executor executor) Executes a abort() invocation;
protected void	doAbortInternal() Executes a abortInternal() invocation;
protected void	doClose() Executes a close() invocation;
void	doPing() Pings both l/b connections.
long	getConnectionGroupId()
JdbcConnection	getCurrentConnection()
JdbcConnection	getMasterConnection()
JdbcConnection	getSlavesConnection()
protected java.lang.Object	invokeMore(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args) Proxies method invocation on the java.sql.Connection interface.
boolean	isHostMaster(java.lang.String hostPortPair)
boolean	isHostSlave(java.lang.String hostPortPair)
boolean	isMasterConnection() Checks if current connection is the masters l/b connection.
boolean	isReadOnly()
boolean	isSlavesConnection() Checks if current connection is the slaves l/b connection.
protected void	pickNewConnection() Picks the "best" connection to use from now on.
void	promoteSlaveToMaster(java.lang.String hostPortPair)
protected void	propagateProxyDown(JdbcConnection proxyConn) Propagates the connection proxy down through all live connections.
void	removeMasterHost(java.lang.String hostPortPair)
void	removeMasterHost(java.lang.String hostPortPair, boolean waitUntilNotInUse)
void	removeMasterHost(java.lang.String hostPortPair, boolean waitUntilNotInUse, boolean isNowSlave)
void	removeSlave(java.lang.String hostPortPair)
void	removeSlave(java.lang.String hostPortPair, boolean closeGently)
void	setReadOnly(boolean readOnly)
protected boolean	shouldExceptionTriggerConnectionSwitch(java.lang.Throwable t) Has no use in replication connections.
protected void	syncSessionState(JdbcConnection source, JdbcConnection target, boolean readonly) Synchronizes session state between two connections, allowing to override the read-only status.

Methods inherited from class com.mysql.cj.jdbc.ha.MultiHostConnectionProxy

allowedOnClosedConnection, createConnectionForHost, dealWithInvocationException, getNewJdbcInterfaceProxy, getParentProxy, getProxy, invalidateConnection, invalidateCurrentConnection, invoke, proxyIfReturnTypeIsJdbcInterface, setProxy

Methods inherited from class java.lang.Object

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

Field Detail

enableJMX

protected boolean enableJMX

allowMasterDownConnections

protected boolean allowMasterDownConnections

allowSlaveDownConnections

protected boolean allowSlaveDownConnections

readFromMasterWhenNoSlaves

protected boolean readFromMasterWhenNoSlaves

readFromMasterWhenNoSlavesOriginal

protected boolean readFromMasterWhenNoSlavesOriginal

readOnly

protected boolean readOnly

masterConnection

protected LoadBalancedConnection masterConnection

slavesConnection

protected LoadBalancedConnection slavesConnection

Method Detail

createProxyInstance

public static ReplicationConnection createProxyInstance(ConnectionUrl connectionUrl)
                                                 throws java.sql.SQLException

Static factory to create ReplicationConnection instances.

Parameters:

connectionUrl - The connection URL containing the hosts in a replication setup.

Returns:

A ReplicationConnection proxy.

Throws:

java.sql.SQLException - if an error occurs

propagateProxyDown

protected void propagateProxyDown(JdbcConnection proxyConn)

Propagates the connection proxy down through all live connections.

Overrides:

propagateProxyDown in class MultiHostConnectionProxy

Parameters:

proxyConn - The top level connection in the multi-host connections chain.

shouldExceptionTriggerConnectionSwitch

protected boolean shouldExceptionTriggerConnectionSwitch(java.lang.Throwable t)

Has no use in replication connections. Always return false.

Specified by:

shouldExceptionTriggerConnectionSwitch in class MultiHostConnectionProxy

Parameters:

t - The Exception instance to check.

Returns:

true if the given throwable should trigger a connection switch

isMasterConnection

public boolean isMasterConnection()

Checks if current connection is the masters l/b connection.

Specified by:

isMasterConnection in class MultiHostConnectionProxy

Returns:

true if current connection is to a master host

isSlavesConnection

public boolean isSlavesConnection()

Checks if current connection is the slaves l/b connection.

Returns:

true if current connection is the slaves l/b connection

pickNewConnection

protected void pickNewConnection()
                          throws java.sql.SQLException

Description copied from class: MultiHostConnectionProxy

Picks the "best" connection to use from now on. Each subclass needs to implement its connection switch strategy on it.

Specified by:

pickNewConnection in class MultiHostConnectionProxy

Throws:

java.sql.SQLException - if an error occurs

syncSessionState

protected void syncSessionState(JdbcConnection source,
                                JdbcConnection target,
                                boolean readonly)
                         throws java.sql.SQLException

Description copied from class: MultiHostConnectionProxy

Synchronizes session state between two connections, allowing to override the read-only status.

Overrides:

syncSessionState in class MultiHostConnectionProxy

Parameters:

source - The connection where to get state from.

target - The connection where to set state.

readonly - The new read-only status.

Throws:

java.sql.SQLException - if an error occurs

doClose

protected void doClose()
                throws java.sql.SQLException

Description copied from class: MultiHostConnectionProxy

Executes a close() invocation;

Specified by:

doClose in class MultiHostConnectionProxy

Throws:

java.sql.SQLException - if an error occurs

doAbortInternal

protected void doAbortInternal()
                        throws java.sql.SQLException

Description copied from class: MultiHostConnectionProxy

Executes a abortInternal() invocation;

Specified by:

doAbortInternal in class MultiHostConnectionProxy

Throws:

java.sql.SQLException - if an error occurs

doAbort

protected void doAbort(java.util.concurrent.Executor executor)
                throws java.sql.SQLException

Description copied from class: MultiHostConnectionProxy

Executes a abort() invocation;

Specified by:

doAbort in class MultiHostConnectionProxy

Parameters:

executor - executor

Throws:

java.sql.SQLException - if an error occurs

invokeMore

protected java.lang.Object invokeMore(java.lang.Object proxy,
                                      java.lang.reflect.Method method,
                                      java.lang.Object[] args)
                               throws java.lang.Throwable

Proxies method invocation on the java.sql.Connection interface. This is the continuation of MultiHostConnectionProxy#invoke(Object, Method, Object[]).

Specified by:

invokeMore in class MultiHostConnectionProxy

Parameters:

proxy - proxy object

method - method to invoke

args - method parameters

Returns:

method result

Throws:

java.lang.Throwable - if an error occurs

doPing

public void doPing()
            throws java.sql.SQLException

Pings both l/b connections. Switch to another connection in case of failure.

Specified by:

doPing in interface PingTarget

Throws:

java.sql.SQLException

getCurrentConnection

public JdbcConnection getCurrentConnection()

getConnectionGroupId

public long getConnectionGroupId()

getMasterConnection

public JdbcConnection getMasterConnection()

promoteSlaveToMaster

public void promoteSlaveToMaster(java.lang.String hostPortPair)
                          throws java.sql.SQLException

Throws:

java.sql.SQLException

removeMasterHost

public void removeMasterHost(java.lang.String hostPortPair)
                      throws java.sql.SQLException

Throws:

java.sql.SQLException

removeMasterHost

public void removeMasterHost(java.lang.String hostPortPair,
                             boolean waitUntilNotInUse)
                      throws java.sql.SQLException

Throws:

java.sql.SQLException

removeMasterHost

public void removeMasterHost(java.lang.String hostPortPair,
                             boolean waitUntilNotInUse,
                             boolean isNowSlave)
                      throws java.sql.SQLException

Throws:

java.sql.SQLException

isHostMaster

public boolean isHostMaster(java.lang.String hostPortPair)

getSlavesConnection

public JdbcConnection getSlavesConnection()

addSlaveHost

public void addSlaveHost(java.lang.String hostPortPair)
                  throws java.sql.SQLException

Throws:

java.sql.SQLException

removeSlave

public void removeSlave(java.lang.String hostPortPair)
                 throws java.sql.SQLException

Throws:

java.sql.SQLException

removeSlave

public void removeSlave(java.lang.String hostPortPair,
                        boolean closeGently)
                 throws java.sql.SQLException

Throws:

java.sql.SQLException

isHostSlave

public boolean isHostSlave(java.lang.String hostPortPair)

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws java.sql.SQLException

Throws:

java.sql.SQLException

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException

Throws:

java.sql.SQLException