software.amazon.jdbc.plugin.readwritesplitting

Class UnifiedReadWriteSplittingPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.readwritesplitting.UnifiedReadWriteSplittingPlugin

All Implemented Interfaces:

CanReleaseResources, ConnectionPlugin, RwSplitContext, StateSnapshotProvider

Direct Known Subclasses:

ReadWriteSplittingPlugin, SimpleReadWriteSplittingPlugin

public abstract class UnifiedReadWriteSplittingPlugin
extends AbstractConnectionPlugin
implements CanReleaseResources, StateSnapshotProvider, RwSplitContext

Unified read/write splitting plugin. Owns the shared connection state and orchestration formerly in AbstractReadWriteSplittingPlugin, delegating every variable decision to injected helpers (RwSplitHelpers). The existing plugin codes are reconstructed as helper assemblies by their factories.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
UnifiedReadWriteSplittingPlugin(PluginService pluginService, java.util.Properties properties, RwSplitHelpers helpers)

Method Summary

Modifier and Type	Method and Description
void	bindReader(java.sql.Connection conn, HostSpec host) Records (caches) the reader connection and host, preserving the legacy setReaderConnection log.
void	bindWriter(java.sql.Connection conn, HostSpec host) Records the writer connection and host, preserving the legacy setWriterConnection log.
void	closeReaderConnectionIfIdle()
void	closeWriterConnectionIfIdle()
java.sql.Connection	connect(HostSpec host, java.util.Properties props) Opens a connection to the given host via the plugin service (using this plugin as the caller).
java.sql.Connection	connect(java.lang.String driverProtocol, HostSpec hostSpec, java.util.Properties props, boolean isInitialConnection, @NonNull JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc) Establishes a connection to the given host using the given driver protocol and properties.
@Nullable java.sql.Connection	currentConnection()
@Nullable HostSpec	currentHostSpec()
void	enterReadWriteSplit() Marks that the plugin is actively read/write splitting (sets inReadWriteSplit).
<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, @Nullable java.lang.Object[] args)
@Nullable java.sql.Connection	getReaderConnection()
java.util.List<Pair<java.lang.String,java.lang.Object>>	getSnapshotState()
java.util.Set<java.lang.String>	getSubscribedMethods()
@Nullable java.sql.Connection	getWriterConnection()
@Nullable HostListProviderService	hostListProviderService()
void	initHostProvider(java.lang.String driverProtocol, java.lang.String initialUrl, java.util.Properties props, HostListProviderService hostListProviderService, JdbcCallable<java.lang.Void,java.sql.SQLException> initHostProviderFunc)
boolean	isConnectionUsable(@Nullable java.sql.Connection connection)
boolean	isInReadWriteSplit()
boolean	isReaderFromPool()
boolean	isWriterFromPool()
void	logAndThrow(java.lang.String logMessage) Logs the message at SEVERE and throws a ReadWriteSplittingSQLException.
void	logAndThrow(java.lang.String logMessage, SqlState sqlState) Logs the message at SEVERE and throws a ReadWriteSplittingSQLException with the SQL state.
void	markReaderFromPool(boolean fromPool)
void	markWriterFromPool(boolean fromPool)
OldConnectionSuggestedAction	notifyConnectionChanged(java.util.EnumSet<NodeChangeOptions> changes)
PluginService	pluginService()
java.util.Properties	properties()
@Nullable java.sql.Connection	readerConnection()
@Nullable HostSpec	readerHostSpec()
protected static LoadBalancingPolicy	readerLoadBalancer(java.util.Properties props, java.lang.String strategy) Builds the reader load-balancing policy for an assembly: PerQueryBalancedReaderPolicy when queryLevelLoadBalancing is enabled (honoring loadBalancingIncludeWriter), otherwise a StickyReaderPolicy.
void	releaseResources() An object that implements this interface should release all acquired resources assuming it may be disposed at any time.
void	setWriterHostSpec(HostSpec host) Records the resolved writer host (without a connection), e.g.
void	switchCurrentConnectionTo(java.sql.Connection newConnection, HostSpec newConnectionHost) Switches the wrapper's current connection to the given connection/host.
@Nullable java.sql.Connection	writerConnection()
@Nullable HostSpec	writerHostSpec()

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

acceptsStrategy, forceConnect, getHostSpecByStrategy, getHostSpecByStrategy, notifyNodeListChanged

Methods inherited from class java.lang.Object

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

Field Detail

CACHED_READER_KEEP_ALIVE_TIMEOUT

public static final AwsWrapperProperty CACHED_READER_KEEP_ALIVE_TIMEOUT

ALLOW_STATEMENT_RECREATION_ON_CONNECTION_SWITCH

public static final AwsWrapperProperty ALLOW_STATEMENT_RECREATION_ON_CONNECTION_SWITCH

QUERY_LEVEL_LOAD_BALANCING

public static final AwsWrapperProperty QUERY_LEVEL_LOAD_BALANCING

LOAD_BALANCING_INCLUDE_WRITER

public static final AwsWrapperProperty LOAD_BALANCING_INCLUDE_WRITER

ASSUME_WRITE_TRANSACTION

public static final AwsWrapperProperty ASSUME_WRITE_TRANSACTION

pluginService

protected final PluginService pluginService

properties

protected final java.util.Properties properties

helpers

protected final RwSplitHelpers helpers

inReadWriteSplit

protected volatile boolean inReadWriteSplit

hostListProviderService

protected @Nullable HostListProviderService hostListProviderService

writerConnection

protected @Nullable java.sql.Connection writerConnection

readerCacheItem

protected @Nullable CacheItem<java.sql.Connection> readerCacheItem

writerHostSpec

protected @Nullable HostSpec writerHostSpec

readerHostSpec

protected @Nullable HostSpec readerHostSpec

isReaderConnFromInternalPool

protected boolean isReaderConnFromInternalPool

isWriterConnFromInternalPool

protected boolean isWriterConnFromInternalPool

Constructor Detail

UnifiedReadWriteSplittingPlugin

public UnifiedReadWriteSplittingPlugin(PluginService pluginService,
                                       java.util.Properties properties,
                                       RwSplitHelpers helpers)

Method Detail

readerLoadBalancer

protected static LoadBalancingPolicy readerLoadBalancer(java.util.Properties props,
                                                        java.lang.String strategy)

Builds the reader load-balancing policy for an assembly: PerQueryBalancedReaderPolicy when queryLevelLoadBalancing is enabled (honoring loadBalancingIncludeWriter), otherwise a StickyReaderPolicy.

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

connect

public java.sql.Connection connect(java.lang.String driverProtocol,
                                   HostSpec hostSpec,
                                   java.util.Properties props,
                                   boolean isInitialConnection,
                                   @NonNull JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc)
                            throws java.sql.SQLException

Description copied from interface: ConnectionPlugin

Establishes a connection to the given host using the given driver protocol and properties. If a non-default ConnectionProvider has been set with Driver.setCustomConnectionProvider(ConnectionProvider) and ConnectionProvider.acceptsUrl(String, HostSpec, Properties) returns true for the given protocol, host, and properties, the connection will be created by the non-default ConnectionProvider. Otherwise, the connection will be created by the default ConnectionProvider. The default ConnectionProvider will be DriverConnectionProvider for connections requested via the DriverManager and DataSourceConnectionProvider for connections requested via an AwsWrapperDataSource.

Specified by:

connect in interface ConnectionPlugin

Overrides:

connect in class AbstractConnectionPlugin

Parameters:

driverProtocol - the driver protocol that should be used to establish the connection

hostSpec - the host details for the desired connection

props - the connection properties

isInitialConnection - a boolean indicating whether the current Connection is establishing an initial physical connection to the database or has already established a physical connection in the past

connectFunc - the function to call to continue the connect request down the connect pipeline

Returns:

a Connection to the requested host

Throws:

java.sql.SQLException - if there was an error establishing a Connection to the requested host

connect

public java.sql.Connection connect(HostSpec host,
                                   java.util.Properties props)
                            throws java.sql.SQLException

Description copied from interface: RwSplitContext

Opens a connection to the given host via the plugin service (using this plugin as the caller).

Specified by:

connect in interface RwSplitContext

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,
                                                   @Nullable 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

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

pluginService

public PluginService pluginService()

Specified by:

pluginService in interface RwSplitContext

hostListProviderService

public @Nullable HostListProviderService hostListProviderService()

Specified by:

hostListProviderService in interface RwSplitContext

properties

public java.util.Properties properties()

Specified by:

properties in interface RwSplitContext

currentConnection

public @Nullable java.sql.Connection currentConnection()

Specified by:

currentConnection in interface RwSplitContext

currentHostSpec

public @Nullable HostSpec currentHostSpec()

Specified by:

currentHostSpec in interface RwSplitContext

writerConnection

public @Nullable java.sql.Connection writerConnection()

Specified by:

writerConnection in interface RwSplitContext

readerConnection

public @Nullable java.sql.Connection readerConnection()

Specified by:

readerConnection in interface RwSplitContext

writerHostSpec

public @Nullable HostSpec writerHostSpec()

Specified by:

writerHostSpec in interface RwSplitContext

readerHostSpec

public @Nullable HostSpec readerHostSpec()

Specified by:

readerHostSpec in interface RwSplitContext

bindWriter

public void bindWriter(java.sql.Connection conn,
                       HostSpec host)

Description copied from interface: RwSplitContext

Records the writer connection and host, preserving the legacy setWriterConnection log.

Specified by:

bindWriter in interface RwSplitContext

setWriterHostSpec

public void setWriterHostSpec(HostSpec host)

Description copied from interface: RwSplitContext

Records the resolved writer host (without a connection), e.g. after a topology refresh.

Specified by:

setWriterHostSpec in interface RwSplitContext

bindReader

public void bindReader(java.sql.Connection conn,
                       HostSpec host)

Description copied from interface: RwSplitContext

Records (caches) the reader connection and host, preserving the legacy setReaderConnection log.

Specified by:

bindReader in interface RwSplitContext

switchCurrentConnectionTo

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

Description copied from interface: RwSplitContext

Switches the wrapper's current connection to the given connection/host.

Specified by:

switchCurrentConnectionTo in interface RwSplitContext

Throws:

java.sql.SQLException

enterReadWriteSplit

public void enterReadWriteSplit()

Description copied from interface: RwSplitContext

Marks that the plugin is actively read/write splitting (sets inReadWriteSplit).

Specified by:

enterReadWriteSplit in interface RwSplitContext

isInReadWriteSplit

public boolean isInReadWriteSplit()

Specified by:

isInReadWriteSplit in interface RwSplitContext

isConnectionUsable

public boolean isConnectionUsable(@Nullable java.sql.Connection connection)
                           throws java.sql.SQLException

Specified by:

isConnectionUsable in interface RwSplitContext

Throws:

java.sql.SQLException

closeReaderConnectionIfIdle

public void closeReaderConnectionIfIdle()

Specified by:

closeReaderConnectionIfIdle in interface RwSplitContext

closeWriterConnectionIfIdle

public void closeWriterConnectionIfIdle()

Specified by:

closeWriterConnectionIfIdle in interface RwSplitContext

markReaderFromPool

public void markReaderFromPool(boolean fromPool)

Specified by:

markReaderFromPool in interface RwSplitContext

markWriterFromPool

public void markWriterFromPool(boolean fromPool)

Specified by:

markWriterFromPool in interface RwSplitContext

isReaderFromPool

public boolean isReaderFromPool()

Specified by:

isReaderFromPool in interface RwSplitContext

isWriterFromPool

public boolean isWriterFromPool()

Specified by:

isWriterFromPool in interface RwSplitContext

logAndThrow

public void logAndThrow(java.lang.String logMessage)
                 throws java.sql.SQLException

Description copied from interface: RwSplitContext

Logs the message at SEVERE and throws a ReadWriteSplittingSQLException.

Specified by:

logAndThrow in interface RwSplitContext

Throws:

java.sql.SQLException

logAndThrow

public void logAndThrow(java.lang.String logMessage,
                        SqlState sqlState)
                 throws java.sql.SQLException

Description copied from interface: RwSplitContext

Logs the message at SEVERE and throws a ReadWriteSplittingSQLException with the SQL state.

Specified by:

logAndThrow in interface RwSplitContext

Throws:

java.sql.SQLException

getSnapshotState

public java.util.List<Pair<java.lang.String,java.lang.Object>> getSnapshotState()

Specified by:

getSnapshotState in interface StateSnapshotProvider

Overrides:

getSnapshotState in class AbstractConnectionPlugin

getWriterConnection

public @Nullable java.sql.Connection getWriterConnection()

getReaderConnection

public @Nullable java.sql.Connection getReaderConnection()