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.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowReplicaDownConnections
protected boolean	allowSourceDownConnections
protected boolean	enableJMX
protected boolean	readFromSourceWhenNoReplicas
protected boolean	readFromSourceWhenNoReplicasOriginal
protected boolean	readOnly
protected LoadBalancedConnection	replicasConnection
protected LoadBalancedConnection	sourceConnection

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

connectionUrl, lastExceptionDealtWith

Method Summary

Modifier and Type	Method and Description
void	addReplicaHost(java.lang.String hostPortPair)
void	addSlaveHost(java.lang.String hostPortPair) Deprecated.
static ReplicationConnection	createProxyInstance(ConnectionUrl connectionUrl) Static factory to create ReplicationConnection instances.
void	doPing() Pings both l/b connections.
long	getConnectionGroupId()
JdbcConnection	getCurrentConnection()
JdbcConnection	getMasterConnection() Deprecated.
JdbcConnection	getReplicasConnection()
JdbcConnection	getSlavesConnection() Deprecated.
JdbcConnection	getSourceConnection()
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.
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)
void	setReadOnly(boolean readOnly)

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

allowedOnClosedConnection, getParentProxy, getProxy, invoke, 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

allowSourceDownConnections

protected boolean allowSourceDownConnections

allowReplicaDownConnections

protected boolean allowReplicaDownConnections

readFromSourceWhenNoReplicas

protected boolean readFromSourceWhenNoReplicas

readFromSourceWhenNoReplicasOriginal

protected boolean readFromSourceWhenNoReplicasOriginal

readOnly

protected boolean readOnly

sourceConnection

protected LoadBalancedConnection sourceConnection

replicasConnection

protected LoadBalancedConnection replicasConnection

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.

isSourceConnection

public boolean isSourceConnection()

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

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

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()

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