software.amazon.jdbc.plugin.readwritesplitting

Class GdbReadWriteSplittingPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.readwritesplitting.AbstractReadWriteSplittingPlugin

software.amazon.jdbc.plugin.readwritesplitting.ReadWriteSplittingPlugin

software.amazon.jdbc.plugin.readwritesplitting.GdbReadWriteSplittingPlugin

All Implemented Interfaces:

CanReleaseResources, ConnectionPlugin, StateSnapshotProvider

public class GdbReadWriteSplittingPlugin
extends ReadWriteSplittingPlugin
implements StateSnapshotProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.String>	accessibleRegions
static AwsWrapperProperty	ENABLE_GWF
protected boolean	enableGwf
protected java.lang.String	homeRegion
protected boolean	isInit
protected RdsUtils	rdsHelper
static AwsWrapperProperty	RESTRICT_READER_TO_HOME_REGION
static AwsWrapperProperty	RESTRICT_WRITER_TO_HOME_REGION
protected boolean	restrictReaderToHomeRegion
protected boolean	restrictWriterToHomeRegion
static AwsWrapperProperty	RW_HOME_REGION

Fields inherited from class software.amazon.jdbc.plugin.readwritesplitting.ReadWriteSplittingPlugin

hosts, READER_HOST_SELECTOR_STRATEGY, readerSelectorStrategy, VERIFY_INITIAL_CONNECTION_ROLE, verifyInitialConnectionRole

Fields inherited from class software.amazon.jdbc.plugin.readwritesplitting.AbstractReadWriteSplittingPlugin

CACHED_READER_KEEP_ALIVE_TIMEOUT, hostListProviderService, inReadWriteSplit, isReaderConnFromInternalPool, isWriterConnFromInternalPool, pluginService, properties, readerCacheItem, readerHostSpec, writerConnection, writerHostSpec

Constructor Summary

Constructors

Constructor and Description
GdbReadWriteSplittingPlugin(PluginService pluginService, @NonNull java.util.Properties properties)

Method Summary

Modifier and Type	Method and Description
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.
protected java.util.List<HostSpec>	getReaderHostCandidates()
java.util.List<Pair<java.lang.String,java.lang.Object>>	getSnapshotState()
protected void	initializeWriterConnection()
protected void	initSettings(HostSpec initHostSpec, java.util.Properties props)
protected boolean	isInAccessibleRegion(HostSpec host)
protected void	setWriterConnection(java.sql.Connection conn, HostSpec host)

Methods inherited from class software.amazon.jdbc.plugin.readwritesplitting.ReadWriteSplittingPlugin

closeReaderIfNecessary, initializeReaderConnection, isReader, isWriter, openNewReaderConnection, refreshAndStoreTopology, shouldUpdateReaderConnection, shouldUpdateWriterConnection

Methods inherited from class software.amazon.jdbc.plugin.readwritesplitting.AbstractReadWriteSplittingPlugin

closeReaderConnectionIfIdle, closeWriterConnectionIfIdle, execute, getKeepAliveTimeout, getReaderConnection, getReaderHostSpec, getSubscribedMethods, getWriterConnection, getWriterHostSpec, initHostProvider, isConnectionUsable, logAndThrowException, logAndThrowException, notifyConnectionChanged, releaseResources, setReaderConnection, switchConnectionIfRequired, switchCurrentConnectionTo

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

Methods inherited from interface software.amazon.jdbc.cleanup.CanReleaseResources

releaseResources

Field Detail

RW_HOME_REGION

public static final AwsWrapperProperty RW_HOME_REGION

RESTRICT_WRITER_TO_HOME_REGION

public static final AwsWrapperProperty RESTRICT_WRITER_TO_HOME_REGION

RESTRICT_READER_TO_HOME_REGION

public static final AwsWrapperProperty RESTRICT_READER_TO_HOME_REGION

ENABLE_GWF

public static final AwsWrapperProperty ENABLE_GWF

isInit

protected boolean isInit

rdsHelper

protected final RdsUtils rdsHelper

homeRegion

protected java.lang.String homeRegion

restrictWriterToHomeRegion

protected final boolean restrictWriterToHomeRegion

restrictReaderToHomeRegion

protected final boolean restrictReaderToHomeRegion

enableGwf

protected final boolean enableGwf

accessibleRegions

protected java.util.Set<java.lang.String> accessibleRegions

Constructor Detail

GdbReadWriteSplittingPlugin

public GdbReadWriteSplittingPlugin(PluginService pluginService,
                                   @NonNull java.util.Properties properties)

Method Detail

initSettings

protected void initSettings(HostSpec initHostSpec,
                            java.util.Properties props)
                     throws java.sql.SQLException

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 ReadWriteSplittingPlugin

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

initializeWriterConnection

protected void initializeWriterConnection()
                                   throws java.sql.SQLException

Overrides:

initializeWriterConnection in class ReadWriteSplittingPlugin

Throws:

java.sql.SQLException

setWriterConnection

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

Overrides:

setWriterConnection in class AbstractReadWriteSplittingPlugin

Throws:

java.sql.SQLException

getReaderHostCandidates

protected java.util.List<HostSpec> getReaderHostCandidates()
                                                    throws java.sql.SQLException

Overrides:

getReaderHostCandidates in class ReadWriteSplittingPlugin

Throws:

java.sql.SQLException

isInAccessibleRegion

protected boolean isInAccessibleRegion(HostSpec host)

getSnapshotState

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

Specified by:

getSnapshotState in interface StateSnapshotProvider

Overrides:

getSnapshotState in class ReadWriteSplittingPlugin