software.amazon.jdbc.plugin.readwritesplitting.signal

Interface RoutingSignal

All Known Implementing Classes:

CompositeSignal, ReadOnlyFlagSignal, SqlRoutingSignal

public interface RoutingSignal

Determines the desired connection role for a given JDBC call ("what is the signal to switch?"). Implementations cover the setReadOnly signal, SQL-based routing, and their composition.

Method Summary

Modifier and Type	Method and Description
default java.util.Set<java.lang.String>	extraSubscribedMethods() Extra JDBC method names this signal needs subscribed beyond the plugin's defaults (e.g.
TargetRole	resolve(RwSplitContext ctx, java.lang.String methodName, @Nullable java.lang.Object[] args) Resolves the desired role for this call.
default TargetRole	resolveForBoundStatement(RwSplitContext ctx) Resolves the desired role for an already-bound plain Statement from the parsed SQL, used only for the optional statement-rebinding path.

Method Detail

extraSubscribedMethods

default java.util.Set<java.lang.String> extraSubscribedMethods()

Extra JDBC method names this signal needs subscribed beyond the plugin's defaults (e.g. the statement-creation and execute methods for SQL routing).

Returns:

an unmodifiable set of method names; empty by default

resolve

TargetRole resolve(RwSplitContext ctx,
                   java.lang.String methodName,
                   @Nullable java.lang.Object[] args)
            throws java.sql.SQLException

Resolves the desired role for this call. TargetRole.NO_DECISION means the method is not a routing trigger for this signal (the signal abstains).

Parameters:

ctx - the read/write splitting context

methodName - the JDBC method being invoked

args - the method arguments (may be null)

Returns:

the desired target role

Throws:

java.sql.SQLException

resolveForBoundStatement

default TargetRole resolveForBoundStatement(RwSplitContext ctx)
                                     throws java.sql.SQLException

Resolves the desired role for an already-bound plain Statement from the parsed SQL, used only for the optional statement-rebinding path. Returns TargetRole.NO_DECISION by default (signals that do not route on SQL do not reroute bound statements).

Parameters:

ctx - the read/write splitting context

Returns:

the desired role, or TargetRole.NO_DECISION if this signal does not apply

Throws:

java.sql.SQLException