Class ReplicationConnectionProxy

java.lang.Object

com.mysql.jdbc.MultiHostConnectionProxy

com.mysql.jdbc.ReplicationConnectionProxy

All Implemented Interfaces:

PingTarget, 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.

Nested Class Summary

Nested classes/interfaces inherited from class MultiHostConnectionProxy

MultiHostConnectionProxy.JdbcInterfaceProxy

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowMasterDownConnections
protected boolean	allowSlaveDownConnections
(package private) ReplicationConnectionGroup	connectionGroup
protected boolean	enableJMX
protected LoadBalancedConnection	masterConnection
protected boolean	readFromMasterWhenNoSlaves
protected boolean	readFromMasterWhenNoSlavesOriginal
protected boolean	readOnly
protected LoadBalancedConnection	slavesConnection

Fields inherited from class MultiHostConnectionProxy

autoReconnect, closedExplicitly, closedReason, currentConnection, hostList, isClosed, lastExceptionDealtWith, localProps, proxyConnection, thisAsConnection

Method Summary

Modifier and Type	Method	Description
void	addSlaveHost(String hostPortPair)
static ReplicationConnection	createProxyInstance(List<String> masterHostList, Properties masterProperties, List<String> slaveHostList, Properties slaveProperties)
(package private) void	doAbort(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()
Connection	getCurrentConnection()
Connection	getMasterConnection()
(package private) MySQLConnection	getNewWrapperForThisAsConnection()	Wraps this object with a new replication Connection instance.
Connection	getSlavesConnection()
(package private) Object	invokeMore(Object proxy, Method method, Object[] args)	Proxies method invocation on the java.sql.Connection interface.
boolean	isHostMaster(String hostPortPair)
boolean	isHostSlave(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.
(package private) void	pickNewConnection()	Picks the "best" connection to use from now on.
void	promoteSlaveToMaster(String hostPortPair)
protected void	propagateProxyDown(MySQLConnection proxyConn)	Propagates the connection proxy down through all live connections.
void	removeMasterHost(String hostPortPair)
void	removeMasterHost(String hostPortPair, boolean waitUntilNotInUse)
void	removeMasterHost(String hostPortPair, boolean waitUntilNotInUse, boolean isNowSlave)
void	removeSlave(String hostPortPair)
void	removeSlave(String hostPortPair, boolean closeGently)
void	setReadOnly(boolean readOnly)
(package private) boolean	shouldExceptionTriggerConnectionSwitch(Throwable t)	Has no use in replication connections.
(package private) void	syncSessionState(Connection source, Connection target, boolean readOnlyStatus)	Synchronizes session state between two connections, allowing to override the read-only status.

Methods inherited from class MultiHostConnectionProxy

allowedOnClosedConnection, createConnectionForHost, dealWithInvocationException, getNewJdbcInterfaceProxy, getProxy, initializeHostsSpecs, invalidateConnection, invalidateCurrentConnection, invoke, proxyIfReturnTypeIsJdbcInterface, setProxy, syncSessionState

Methods inherited from class Object

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

Field Details

enableJMX

protected boolean enableJMX

allowMasterDownConnections

protected boolean allowMasterDownConnections

allowSlaveDownConnections

protected boolean allowSlaveDownConnections

readFromMasterWhenNoSlaves

protected boolean readFromMasterWhenNoSlaves

readFromMasterWhenNoSlavesOriginal

protected boolean readFromMasterWhenNoSlavesOriginal

readOnly

protected boolean readOnly

connectionGroup

ReplicationConnectionGroup connectionGroup

masterConnection

protected LoadBalancedConnection masterConnection

slavesConnection

protected LoadBalancedConnection slavesConnection

Method Details

createProxyInstance

public static ReplicationConnection createProxyInstance(List<String> masterHostList,
 Properties masterProperties,
 List<String> slaveHostList,
 Properties slaveProperties)
                                                 throws SQLException

Throws:

SQLException

getNewWrapperForThisAsConnection

MySQLConnection getNewWrapperForThisAsConnection()
                                          throws SQLException

Wraps this object with a new replication Connection instance.

Overrides:

getNewWrapperForThisAsConnection in class MultiHostConnectionProxy

Returns:

The connection object instance that wraps 'this'.

Throws:

SQLException

propagateProxyDown

protected void propagateProxyDown(MySQLConnection 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(Throwable t)

Has no use in replication connections. Always return false.

Specified by:

shouldExceptionTriggerConnectionSwitch in class MultiHostConnectionProxy

Parameters:

t - The Throwable instance to analyze.

ex - The Exception instance to check.

isMasterConnection

public boolean isMasterConnection()

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

Specified by:

isMasterConnection in class MultiHostConnectionProxy

isSlavesConnection

public boolean isSlavesConnection()

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

pickNewConnection

void pickNewConnection()
                throws 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:

SQLException

syncSessionState

void syncSessionState(Connection source,
 Connection target,
 boolean readOnlyStatus)
               throws 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.

readOnlyStatus - The new read-only status.

Throws:

SQLException

doClose

void doClose()
      throws SQLException

Description copied from class: MultiHostConnectionProxy

Executes a close() invocation;

Specified by:

doClose in class MultiHostConnectionProxy

Throws:

SQLException

doAbortInternal

void doAbortInternal()
              throws SQLException

Description copied from class: MultiHostConnectionProxy

Executes a abortInternal() invocation;

Specified by:

doAbortInternal in class MultiHostConnectionProxy

Throws:

SQLException

doAbort

void doAbort(Executor executor)
      throws SQLException

Description copied from class: MultiHostConnectionProxy

Executes a abort() invocation;

Specified by:

doAbort in class MultiHostConnectionProxy

Throws:

SQLException

invokeMore

Object invokeMore(Object proxy,
 Method method,
 Object[] args)
           throws 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

Throws:

Throwable

doPing

public void doPing()
            throws SQLException

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

Specified by:

doPing in interface PingTarget

Throws:

SQLException

getCurrentConnection

public Connection getCurrentConnection()

getConnectionGroupId

public long getConnectionGroupId()

getMasterConnection

public Connection getMasterConnection()

promoteSlaveToMaster

public void promoteSlaveToMaster(String hostPortPair)
                          throws SQLException

Throws:

SQLException

removeMasterHost

public void removeMasterHost(String hostPortPair)
                      throws SQLException

Throws:

SQLException

removeMasterHost

public void removeMasterHost(String hostPortPair,
 boolean waitUntilNotInUse)
                      throws SQLException

Throws:

SQLException

removeMasterHost

public void removeMasterHost(String hostPortPair,
 boolean waitUntilNotInUse,
 boolean isNowSlave)
                      throws SQLException

Throws:

SQLException

isHostMaster

public boolean isHostMaster(String hostPortPair)

getSlavesConnection

public Connection getSlavesConnection()

addSlaveHost

public void addSlaveHost(String hostPortPair)
                  throws SQLException

Throws:

SQLException

removeSlave

public void removeSlave(String hostPortPair)
                 throws SQLException

Throws:

SQLException

removeSlave

public void removeSlave(String hostPortPair,
 boolean closeGently)
                 throws SQLException

Throws:

SQLException

isHostSlave

public boolean isHostSlave(String hostPortPair)

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException

Throws:

SQLException

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Throws:

SQLException