software.amazon.jdbc.plugin.readwritesplitting

Class AbstractReadWriteSplittingPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.readwritesplitting.AbstractReadWriteSplittingPlugin

All Implemented Interfaces:

CanReleaseResources, ConnectionPlugin, StateSnapshotProvider

Direct Known Subclasses:

ReadWriteSplittingPlugin, SimpleReadWriteSplittingPlugin

public abstract class AbstractReadWriteSplittingPlugin
extends AbstractConnectionPlugin
implements CanReleaseResources

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	CACHED_READER_KEEP_ALIVE_TIMEOUT
protected HostListProviderService	hostListProviderService
protected boolean	inReadWriteSplit
protected boolean	isReaderConnFromInternalPool
protected boolean	isWriterConnFromInternalPool
protected PluginService	pluginService
protected java.util.Properties	properties
protected CacheItem<java.sql.Connection>	readerCacheItem
protected HostSpec	readerHostSpec
protected java.sql.Connection	writerConnection
protected HostSpec	writerHostSpec

Constructor Summary

Constructors

Constructor and Description
AbstractReadWriteSplittingPlugin(PluginService pluginService, java.util.Properties properties)

Method Summary

Modifier and Type	Method and Description
void	closeReaderConnectionIfIdle()
protected abstract void	closeReaderIfNecessary()
void	closeWriterConnectionIfIdle()
<T,E extends java.lang.Exception> T	execute(java.lang.Class<T> resultClass, java.lang.Class<E> exceptionClass, java.lang.Object methodInvokeOn, java.lang.String methodName, JdbcCallable<T,E> jdbcMethodFunc, java.lang.Object[] args)
protected long	getKeepAliveTimeout(boolean isPooledConnection)
java.sql.Connection	getReaderConnection()
HostSpec	getReaderHostSpec()
java.util.Set<java.lang.String>	getSubscribedMethods()
java.sql.Connection	getWriterConnection() Methods for testing purposes only.
HostSpec	getWriterHostSpec()
void	initHostProvider(java.lang.String driverProtocol, java.lang.String initialUrl, java.util.Properties props, HostListProviderService hostListProviderService, JdbcCallable<java.lang.Void,java.sql.SQLException> initHostProviderFunc)
protected abstract void	initializeReaderConnection()
protected abstract void	initializeWriterConnection()
protected boolean	isConnectionUsable(java.sql.Connection connection)
protected abstract boolean	isReader(HostSpec currentHost)
protected abstract boolean	isWriter(HostSpec currentHost)
protected void	logAndThrowException(java.lang.String logMessage)
protected void	logAndThrowException(java.lang.String logMessage, SqlState sqlState)
OldConnectionSuggestedAction	notifyConnectionChanged(java.util.EnumSet<NodeChangeOptions> changes)
protected abstract void	refreshAndStoreTopology(java.sql.Connection currentConnection)
void	releaseResources() An object that implements this interface should release all acquired resources assuming it may be disposed at any time.
protected void	setReaderConnection(java.sql.Connection conn, HostSpec host)
protected void	setWriterConnection(java.sql.Connection conn, HostSpec host)
protected abstract boolean	shouldUpdateReaderConnection(java.sql.Connection currentConnection, HostSpec currentHost)
protected abstract boolean	shouldUpdateWriterConnection(java.sql.Connection currentConnection, HostSpec currentHost)
void	switchConnectionIfRequired(boolean readOnly)
protected void	switchCurrentConnectionTo(java.sql.Connection newConnection, HostSpec newConnectionHost)

Methods inherited from class software.amazon.jdbc.plugin.AbstractConnectionPlugin

acceptsStrategy, connect, forceConnect, getHostSpecByStrategy, getHostSpecByStrategy, getSnapshotState, notifyNodeListChanged

Methods inherited from class java.lang.Object

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

Field Detail

pluginService

protected final PluginService pluginService

properties

protected final java.util.Properties properties

inReadWriteSplit

protected volatile boolean inReadWriteSplit

hostListProviderService

protected HostListProviderService hostListProviderService

writerConnection

protected java.sql.Connection writerConnection

readerCacheItem

protected CacheItem<java.sql.Connection> readerCacheItem

writerHostSpec

protected HostSpec writerHostSpec

readerHostSpec

protected HostSpec readerHostSpec

isReaderConnFromInternalPool

protected boolean isReaderConnFromInternalPool

isWriterConnFromInternalPool

protected boolean isWriterConnFromInternalPool

CACHED_READER_KEEP_ALIVE_TIMEOUT

public static final AwsWrapperProperty CACHED_READER_KEEP_ALIVE_TIMEOUT

Constructor Detail

AbstractReadWriteSplittingPlugin

public AbstractReadWriteSplittingPlugin(PluginService pluginService,
                                        java.util.Properties properties)

Method Detail

getSubscribedMethods

public java.util.Set<java.lang.String> getSubscribedMethods()

Specified by:

getSubscribedMethods in interface ConnectionPlugin

Specified by:

getSubscribedMethods in class AbstractConnectionPlugin

initHostProvider

public void initHostProvider(java.lang.String driverProtocol,
                             java.lang.String initialUrl,
                             java.util.Properties props,
                             HostListProviderService hostListProviderService,
                             JdbcCallable<java.lang.Void,java.sql.SQLException> initHostProviderFunc)
                      throws java.sql.SQLException

Specified by:

initHostProvider in interface ConnectionPlugin

Overrides:

initHostProvider in class AbstractConnectionPlugin

Throws:

java.sql.SQLException

notifyConnectionChanged

public OldConnectionSuggestedAction notifyConnectionChanged(java.util.EnumSet<NodeChangeOptions> changes)

Specified by:

notifyConnectionChanged in interface ConnectionPlugin

Overrides:

notifyConnectionChanged in class AbstractConnectionPlugin

execute

public <T,E extends java.lang.Exception> T execute(java.lang.Class<T> resultClass,
                                                   java.lang.Class<E> exceptionClass,
                                                   java.lang.Object methodInvokeOn,
                                                   java.lang.String methodName,
                                                   JdbcCallable<T,E> jdbcMethodFunc,
                                                   java.lang.Object[] args)
                                            throws E extends java.lang.Exception

Specified by:

execute in interface ConnectionPlugin

Overrides:

execute in class AbstractConnectionPlugin

Throws:

E extends java.lang.Exception

setWriterConnection

protected void setWriterConnection(java.sql.Connection conn,
                                   HostSpec host)
                            throws java.sql.SQLException

Throws:

java.sql.SQLException

setReaderConnection

protected void setReaderConnection(java.sql.Connection conn,
                                   HostSpec host)

switchConnectionIfRequired

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

Throws:

java.sql.SQLException

logAndThrowException

protected void logAndThrowException(java.lang.String logMessage)
                             throws java.sql.SQLException

Throws:

java.sql.SQLException

logAndThrowException

protected void logAndThrowException(java.lang.String logMessage,
                                    SqlState sqlState)
                             throws java.sql.SQLException

Throws:

java.sql.SQLException

switchCurrentConnectionTo

protected void switchCurrentConnectionTo(java.sql.Connection newConnection,
                                         HostSpec newConnectionHost)
                                  throws java.sql.SQLException

Throws:

java.sql.SQLException

isConnectionUsable

protected boolean isConnectionUsable(java.sql.Connection connection)
                              throws java.sql.SQLException

Throws:

java.sql.SQLException

getKeepAliveTimeout

protected long getKeepAliveTimeout(boolean isPooledConnection)

releaseResources

public void releaseResources()

Description copied from interface: CanReleaseResources

An object that implements this interface should release all acquired resources assuming it may be disposed at any time. This method may be called more than once.

Calling this method does NOT mean that an object is disposing and there won't be any further calls. An object should keep its functional state after calling this method.

Specified by:

releaseResources in interface CanReleaseResources

closeReaderConnectionIfIdle

public void closeReaderConnectionIfIdle()

closeWriterConnectionIfIdle

public void closeWriterConnectionIfIdle()

shouldUpdateReaderConnection

protected abstract boolean shouldUpdateReaderConnection(java.sql.Connection currentConnection,
                                                        HostSpec currentHost)
                                                 throws java.sql.SQLException

Throws:

java.sql.SQLException

shouldUpdateWriterConnection

protected abstract boolean shouldUpdateWriterConnection(java.sql.Connection currentConnection,
                                                        HostSpec currentHost)
                                                 throws java.sql.SQLException

Throws:

java.sql.SQLException

isWriter

protected abstract boolean isWriter(HostSpec currentHost)

isReader

protected abstract boolean isReader(HostSpec currentHost)

refreshAndStoreTopology

protected abstract void refreshAndStoreTopology(java.sql.Connection currentConnection)
                                         throws java.sql.SQLException

Throws:

java.sql.SQLException

initializeWriterConnection

protected abstract void initializeWriterConnection()
                                            throws java.sql.SQLException

Throws:

java.sql.SQLException

initializeReaderConnection

protected abstract void initializeReaderConnection()
                                            throws java.sql.SQLException

Throws:

java.sql.SQLException

closeReaderIfNecessary

protected abstract void closeReaderIfNecessary()

getWriterConnection

public java.sql.Connection getWriterConnection()

Methods for testing purposes only.

Returns:

the writer connection for testing purposes only.

getReaderConnection

public java.sql.Connection getReaderConnection()

getReaderHostSpec

public HostSpec getReaderHostSpec()

getWriterHostSpec

public HostSpec getWriterHostSpec()