software.amazon.jdbc.plugin.srw

Class SimpleReadWriteSplittingPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.readwritesplitting.AbstractReadWriteSplittingPlugin

software.amazon.jdbc.plugin.srw.SimpleReadWriteSplittingPlugin

All Implemented Interfaces:

CanReleaseResources, ConnectionPlugin, StateSnapshotProvider

public class SimpleReadWriteSplittingPlugin
extends AbstractReadWriteSplittingPlugin
implements CanReleaseResources, StateSnapshotProvider

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	SRW_CONNECT_RETRY_INTERVAL_MS
static AwsWrapperProperty	SRW_CONNECT_RETRY_TIMEOUT_MS
static AwsWrapperProperty	SRW_READ_ENDPOINT
static AwsWrapperProperty	SRW_WRITE_ENDPOINT
static AwsWrapperProperty	VERIFY_INITIAL_CONNECTION_TYPE
static AwsWrapperProperty	VERIFY_NEW_SRW_CONNECTIONS

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
SimpleReadWriteSplittingPlugin(PluginService pluginService, java.util.Properties properties)
SimpleReadWriteSplittingPlugin(PluginService pluginService, java.util.Properties properties, HostListProviderService hostListProviderService, java.sql.Connection writerConnection, java.sql.Connection readerConnection, HostSpec writeEndpointHostSpec, HostSpec readEndpointHostSpec) For testing purposes only.

Method Summary

Modifier and Type	Method and Description
protected void	closeReaderIfNecessary()
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.
java.util.List<Pair<java.lang.String,java.lang.Object>>	getSnapshotState()
protected void	initializeReaderConnection()
protected void	initializeWriterConnection()
protected boolean	isReader(@NonNull HostSpec hostSpec)
protected boolean	isWriter(@NonNull HostSpec hostSpec)
protected void	refreshAndStoreTopology(java.sql.Connection currentConnection)
protected boolean	shouldUpdateReaderConnection(java.sql.Connection currentConnection, HostSpec currentHost)
protected boolean	shouldUpdateWriterConnection(java.sql.Connection currentConnection, HostSpec currentHost)

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, setWriterConnection, 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

SRW_READ_ENDPOINT

public static final AwsWrapperProperty SRW_READ_ENDPOINT

SRW_WRITE_ENDPOINT

public static final AwsWrapperProperty SRW_WRITE_ENDPOINT

VERIFY_NEW_SRW_CONNECTIONS

public static final AwsWrapperProperty VERIFY_NEW_SRW_CONNECTIONS

SRW_CONNECT_RETRY_TIMEOUT_MS

public static final AwsWrapperProperty SRW_CONNECT_RETRY_TIMEOUT_MS

SRW_CONNECT_RETRY_INTERVAL_MS

public static final AwsWrapperProperty SRW_CONNECT_RETRY_INTERVAL_MS

VERIFY_INITIAL_CONNECTION_TYPE

public static final AwsWrapperProperty VERIFY_INITIAL_CONNECTION_TYPE

Constructor Detail

SimpleReadWriteSplittingPlugin

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

SimpleReadWriteSplittingPlugin

public SimpleReadWriteSplittingPlugin(PluginService pluginService,
                                      java.util.Properties properties,
                                      HostListProviderService hostListProviderService,
                                      java.sql.Connection writerConnection,
                                      java.sql.Connection readerConnection,
                                      HostSpec writeEndpointHostSpec,
                                      HostSpec readEndpointHostSpec)

For testing purposes only.

Parameters:

pluginService - The PluginService implementation.

properties - The properties to be used for this plugin.

hostListProviderService - The HostListProviderService implementation.

writerConnection - The writer connection.

readerConnection - The reader connection.

writeEndpointHostSpec - The writer HostSpec.

readEndpointHostSpec - The reader HostSpec.

Method Detail

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

isWriter

protected boolean isWriter(@NonNull HostSpec hostSpec)

Specified by:

isWriter in class AbstractReadWriteSplittingPlugin

isReader

protected boolean isReader(@NonNull HostSpec hostSpec)

Specified by:

isReader in class AbstractReadWriteSplittingPlugin

refreshAndStoreTopology

protected void refreshAndStoreTopology(java.sql.Connection currentConnection)

Specified by:

refreshAndStoreTopology in class AbstractReadWriteSplittingPlugin

initializeWriterConnection

protected void initializeWriterConnection()
                                   throws java.sql.SQLException

Specified by:

initializeWriterConnection in class AbstractReadWriteSplittingPlugin

Throws:

java.sql.SQLException

initializeReaderConnection

protected void initializeReaderConnection()
                                   throws java.sql.SQLException

Specified by:

initializeReaderConnection in class AbstractReadWriteSplittingPlugin

Throws:

java.sql.SQLException

closeReaderIfNecessary

protected void closeReaderIfNecessary()

Specified by:

closeReaderIfNecessary in class AbstractReadWriteSplittingPlugin

shouldUpdateReaderConnection

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

Specified by:

shouldUpdateReaderConnection in class AbstractReadWriteSplittingPlugin

Throws:

java.sql.SQLException

shouldUpdateWriterConnection

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

Specified by:

shouldUpdateWriterConnection in class AbstractReadWriteSplittingPlugin

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