software.amazon.jdbc.plugin.readwritesplitting

Interface RwSplitContext

All Known Implementing Classes:

AutoReadWriteSplittingPlugin, AutoSimpleReadWriteSplittingPlugin, GdbAutoReadWriteSplittingPlugin, GdbAutoSimpleReadWriteSplittingPlugin, GdbReadWriteSplittingPlugin, GdbSimpleReadWriteSplittingPlugin, ReadWriteSplittingPlugin, SimpleReadWriteSplittingPlugin, UnifiedReadWriteSplittingPlugin

public interface RwSplitContext

Narrow interface through which read/write splitting helpers read and drive the unified plugin's connection state. Helpers never touch the plugin's private fields directly; all state transitions and logging/exception helpers are funneled through this context so that behavior (and message keys) stay consistent with the legacy plugins.

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).
@Nullable java.sql.Connection	currentConnection()
@Nullable HostSpec	currentHostSpec()
void	enterReadWriteSplit() Marks that the plugin is actively read/write splitting (sets inReadWriteSplit).
@Nullable HostListProviderService	hostListProviderService()
boolean	isConnectionUsable(@Nullable java.sql.Connection conn)
boolean	isInReadWriteSplit()
boolean	isReaderFromPool()
boolean	isWriterFromPool()
void	logAndThrow(java.lang.String message) Logs the message at SEVERE and throws a ReadWriteSplittingSQLException.
void	logAndThrow(java.lang.String message, SqlState sqlState) Logs the message at SEVERE and throws a ReadWriteSplittingSQLException with the SQL state.
void	markReaderFromPool(boolean fromPool)
void	markWriterFromPool(boolean fromPool)
PluginService	pluginService()
java.util.Properties	properties()
@Nullable java.sql.Connection	readerConnection()
@Nullable HostSpec	readerHostSpec()
void	setWriterHostSpec(HostSpec host) Records the resolved writer host (without a connection), e.g.
void	switchCurrentConnectionTo(java.sql.Connection conn, HostSpec host) Switches the wrapper's current connection to the given connection/host.
@Nullable java.sql.Connection	writerConnection()
@Nullable HostSpec	writerHostSpec()

Method Detail

pluginService

PluginService pluginService()

hostListProviderService

@Nullable HostListProviderService hostListProviderService()

properties

java.util.Properties properties()

currentConnection

@Nullable java.sql.Connection currentConnection()

currentHostSpec

@Nullable HostSpec currentHostSpec()

writerConnection

@Nullable java.sql.Connection writerConnection()

readerConnection

@Nullable java.sql.Connection readerConnection()

writerHostSpec

@Nullable HostSpec writerHostSpec()

readerHostSpec

@Nullable HostSpec readerHostSpec()

bindWriter

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

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

Throws:

java.sql.SQLException

setWriterHostSpec

void setWriterHostSpec(HostSpec host)

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

bindReader

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

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

switchCurrentConnectionTo

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

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

Throws:

java.sql.SQLException

connect

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

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

Throws:

java.sql.SQLException

enterReadWriteSplit

void enterReadWriteSplit()

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

isInReadWriteSplit

boolean isInReadWriteSplit()

isConnectionUsable

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

Throws:

java.sql.SQLException

closeReaderConnectionIfIdle

void closeReaderConnectionIfIdle()

closeWriterConnectionIfIdle

void closeWriterConnectionIfIdle()

markReaderFromPool

void markReaderFromPool(boolean fromPool)

markWriterFromPool

void markWriterFromPool(boolean fromPool)

isReaderFromPool

boolean isReaderFromPool()

isWriterFromPool

boolean isWriterFromPool()

logAndThrow

void logAndThrow(java.lang.String message)
          throws java.sql.SQLException

Logs the message at SEVERE and throws a ReadWriteSplittingSQLException.

Throws:

java.sql.SQLException

logAndThrow

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

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

Throws:

java.sql.SQLException