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 source, and another to one or more replicas, and decides to use source when the connection is not read-only, and use replica(s) when the connection is read-only.

Nested Class Summary

Nested classes/interfaces inherited from class com.mysql.cj.jdbc.ha.MultiHostConnectionProxy

MultiHostConnectionProxy.JdbcInterfaceProxy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowReplicaDownConnections
protected boolean	allowSourceDownConnections
(package private) ReplicationConnectionGroup	connectionGroup
private long	connectionGroupID
protected boolean	enableJMX
protected boolean	readFromSourceWhenNoReplicas
protected boolean	readFromSourceWhenNoReplicasOriginal
protected boolean	readOnly
private java.util.List<HostInfo>	replicaHosts
protected LoadBalancedConnection	replicasConnection
protected LoadBalancedConnection	sourceConnection
private java.util.List<HostInfo>	sourceHosts
private ReplicationConnection	thisAsReplicationConnection

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ReplicationConnectionProxy(ConnectionUrl connectionUrl) Creates a proxy for java.sql.Connection that routes requests to a load-balanced connection of source servers or a load-balanced connection of replica servers.

Method Summary

Modifier and Type	Method and Description
void	addReplicaHost(java.lang.String hostPortPair)
void	addSlaveHost(java.lang.String hostPortPair) Deprecated.
private void	checkConnectionCapabilityForMethod(java.lang.reflect.Method method) Checks if this connection is in a state capable to invoke the provided method.
static ReplicationConnection	createProxyInstance(ConnectionUrl connectionUrl) Static factory to create ReplicationConnection instances.
(package private) void	doAbort(java.util.concurrent.Executor executor) Executes a abort() invocation;
(package private) void	doAbortInternal() Executes a abortInternal() invocation;
(package private) void	doClose() Executes a close() invocation;
void	doPing() Pings both l/b connections.
long	getConnectionGroupId()
private ReplicationConnectionUrl	getConnectionUrl()
JdbcConnection	getCurrentConnection()
JdbcConnection	getMasterConnection() Deprecated.
(package private) JdbcConnection	getNewWrapperForThisAsConnection() Wraps this object with a new replication Connection instance.
private HostInfo	getReplicaHost(java.lang.String hostPortPair)
JdbcConnection	getReplicasConnection()
JdbcConnection	getSlavesConnection() Deprecated.
JdbcConnection	getSourceConnection()
private HostInfo	getSourceHost(java.lang.String hostPortPair)
private JdbcConnection	initializeReplicasConnection()
private JdbcConnection	initializeSourceConnection()
(package private) 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) Deprecated.
boolean	isHostReplica(java.lang.String hostPortPair)
boolean	isHostSlave(java.lang.String hostPortPair) Deprecated.
boolean	isHostSource(java.lang.String hostPortPair)
boolean	isReadOnly()
boolean	isReplicasConnection() Checks if current connection is the replicas l/b connection.
boolean	isSlavesConnection() Deprecated.
boolean	isSourceConnection() Checks if current connection is the sources l/b connection.
(package private) void	pickNewConnection() Picks the "best" connection to use from now on.
void	promoteReplicaToSource(java.lang.String hostPortPair)
void	promoteSlaveToMaster(java.lang.String hostPortPair) Deprecated.
protected void	propagateProxyDown(JdbcConnection proxyConn) Propagates the connection proxy down through all live connections.
void	removeMasterHost(java.lang.String hostPortPair) Deprecated.
void	removeMasterHost(java.lang.String hostPortPair, boolean waitUntilNotInUse) Deprecated.
void	removeMasterHost(java.lang.String hostPortPair, boolean waitUntilNotInUse, boolean isNowReplica) Deprecated.
void	removeReplica(java.lang.String hostPortPair)
void	removeReplica(java.lang.String hostPortPair, boolean closeGently)
void	removeSlave(java.lang.String hostPortPair) Deprecated.
void	removeSlave(java.lang.String hostPortPair, boolean closeGently) Deprecated.
void	removeSourceHost(java.lang.String hostPortPair)
void	removeSourceHost(java.lang.String hostPortPair, boolean waitUntilNotInUse)
void	removeSourceHost(java.lang.String hostPortPair, boolean waitUntilNotInUse, boolean isNowReplica)
private void	resetReadFromSourceWhenNoReplicas()
void	setReadOnly(boolean readOnly)
(package private) boolean	shouldExceptionTriggerConnectionSwitch(java.lang.Throwable t) Has no use in replication connections.
private boolean	switchToReplicasConnection()
private boolean	switchToReplicasConnectionIfNecessary()
private boolean	switchToSourceConnection()
(package private) 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, initializeHostsSpecs, invalidateConnection, invalidateCurrentConnection, invoke, isMasterConnection, proxyIfReturnTypeIsJdbcInterface, setProxy, syncSessionState

Methods inherited from class java.lang.Object

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

Field Detail

thisAsReplicationConnection

private ReplicationConnection thisAsReplicationConnection

enableJMX

protected boolean enableJMX

allowSourceDownConnections

protected boolean allowSourceDownConnections

allowReplicaDownConnections

protected boolean allowReplicaDownConnections

readFromSourceWhenNoReplicas

protected boolean readFromSourceWhenNoReplicas

readFromSourceWhenNoReplicasOriginal

protected boolean readFromSourceWhenNoReplicasOriginal

readOnly

protected boolean readOnly

connectionGroup

ReplicationConnectionGroup connectionGroup

connectionGroupID

private long connectionGroupID

sourceHosts

private java.util.List<HostInfo> sourceHosts

sourceConnection

protected LoadBalancedConnection sourceConnection

replicaHosts

private java.util.List<HostInfo> replicaHosts

replicasConnection

protected LoadBalancedConnection replicasConnection

Constructor Detail

ReplicationConnectionProxy

private ReplicationConnectionProxy(ConnectionUrl connectionUrl)
                            throws java.sql.SQLException

Creates a proxy for java.sql.Connection that routes requests to a load-balanced connection of source servers or a load-balanced connection of replica servers. Each sub-connection is created with its own set of independent properties.

Parameters:

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

Throws:

java.sql.SQLException - if an error occurs

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

getNewWrapperForThisAsConnection

JdbcConnection getNewWrapperForThisAsConnection()
                                         throws java.sql.SQLException

Wraps this object with a new replication Connection instance.

Overrides:

getNewWrapperForThisAsConnection in class MultiHostConnectionProxy

Returns:

The connection object instance that wraps 'this'.

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

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

isSourceConnection

public boolean isSourceConnection()

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

Specified by:

isSourceConnection in class MultiHostConnectionProxy

Returns:

true if current connection is to a source host

isReplicasConnection

public boolean isReplicasConnection()

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

Returns:

true if current connection is the replicas l/b connection

isSlavesConnection

@Deprecated
public boolean isSlavesConnection()

Deprecated.

Use isReplicasConnection() instead.

Returns:

true if it's a replicas connection

pickNewConnection

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

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

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

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

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

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

checkConnectionCapabilityForMethod

private void checkConnectionCapabilityForMethod(java.lang.reflect.Method method)
                                         throws java.lang.Throwable

Checks if this connection is in a state capable to invoke the provided method. If the connection is in an inconsistent state, i.e. it has no hosts for both sub-connections, then throw an invalid transaction state exception. Nevertheless, the methods defined in the ReplicationConnection interface will be allowed as they are the only way to leave from an empty hosts lists situation.

Parameters:

method - method

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

initializeSourceConnection

private JdbcConnection initializeSourceConnection()
                                           throws java.sql.SQLException

Throws:

java.sql.SQLException

initializeReplicasConnection

private JdbcConnection initializeReplicasConnection()
                                             throws java.sql.SQLException

Throws:

java.sql.SQLException

switchToSourceConnection

private boolean switchToSourceConnection()
                                  throws java.sql.SQLException

Throws:

java.sql.SQLException

switchToReplicasConnection

private boolean switchToReplicasConnection()
                                    throws java.sql.SQLException

Throws:

java.sql.SQLException

switchToReplicasConnectionIfNecessary

private boolean switchToReplicasConnectionIfNecessary()
                                               throws java.sql.SQLException

Throws:

java.sql.SQLException

getCurrentConnection

public JdbcConnection getCurrentConnection()

getConnectionGroupId

public long getConnectionGroupId()

getSourceConnection

public JdbcConnection getSourceConnection()

getMasterConnection

@Deprecated
public JdbcConnection getMasterConnection()

Deprecated.

Use getSourceConnection() instead.

Returns:

JdbcConnection

promoteReplicaToSource

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

Throws:

java.sql.SQLException

promoteSlaveToMaster

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

Deprecated.

Use promoteReplicaToSource(String) instead.

Parameters:

hostPortPair - host:port

Throws:

java.sql.SQLException

removeSourceHost

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

Throws:

java.sql.SQLException

removeMasterHost

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

Deprecated.

Use removeSourceHost(String) instead.

Parameters:

hostPortPair - host:port

Throws:

java.sql.SQLException

removeSourceHost

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

Throws:

java.sql.SQLException

removeMasterHost

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

Deprecated.

Use removeSourceHost(String, boolean) instead.

Parameters:

hostPortPair - host:port

waitUntilNotInUse - remove only when not in use

Throws:

java.sql.SQLException

removeSourceHost

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

Throws:

java.sql.SQLException

removeMasterHost

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

Deprecated.

Use removeSourceHost(String, boolean, boolean) instead.

Parameters:

hostPortPair - host:port

waitUntilNotInUse - remove only when not in use

isNowReplica - place to replicas

Throws:

java.sql.SQLException

isHostSource

public boolean isHostSource(java.lang.String hostPortPair)

isHostMaster

@Deprecated
public boolean isHostMaster(java.lang.String hostPortPair)

Deprecated.

Use isHostSource(String) instead.

Parameters:

hostPortPair - host:port

Returns:

true if it's a source host

getReplicasConnection

public JdbcConnection getReplicasConnection()

getSlavesConnection

@Deprecated
public JdbcConnection getSlavesConnection()

Deprecated.

Use getReplicasConnection() instead.

Returns:

JdbcConnection

addReplicaHost

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

Throws:

java.sql.SQLException

addSlaveHost

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

Deprecated.

Use addReplicaHost(String) instead.

Parameters:

hostPortPair - host:port

Throws:

java.sql.SQLException

removeReplica

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

Throws:

java.sql.SQLException

removeSlave

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

Deprecated.

Use removeReplica(String) instead.

Parameters:

hostPortPair - host:port

Throws:

java.sql.SQLException

removeReplica

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

Throws:

java.sql.SQLException

removeSlave

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

Deprecated.

Use removeReplica(String, boolean) instead.

Parameters:

hostPortPair - host:port

closeGently - option

Throws:

java.sql.SQLException

isHostReplica

public boolean isHostReplica(java.lang.String hostPortPair)

isHostSlave

@Deprecated
public boolean isHostSlave(java.lang.String hostPortPair)

Deprecated.

Use isHostReplica(String) instead.

Parameters:

hostPortPair - host:port

Returns:

true if it's a replica

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

resetReadFromSourceWhenNoReplicas

private void resetReadFromSourceWhenNoReplicas()

getSourceHost

private HostInfo getSourceHost(java.lang.String hostPortPair)

getReplicaHost

private HostInfo getReplicaHost(java.lang.String hostPortPair)

getConnectionUrl

private ReplicationConnectionUrl getConnectionUrl()