software.amazon.jdbc.plugin.strategy.fastestresponse

Class FastestResponseStrategyPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.strategy.fastestresponse.FastestResponseStrategyPlugin

All Implemented Interfaces:

ConnectionPlugin

public class FastestResponseStrategyPlugin
extends AbstractConnectionPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected static CacheMap<java.lang.String,HostSpec>	cachedFastestResponseHostByRole
protected long	cacheExpirationNano
static java.lang.String	FASTEST_RESPONSE_STRATEGY_NAME
protected @NonNull HostResponseTimeService	hostResponseTimeService
protected java.util.List<HostSpec>	hosts
protected @NonNull PluginService	pluginService
protected @NonNull java.util.Properties	properties
protected static RandomHostSelector	randomHostSelector
static AwsWrapperProperty	RESPONSE_MEASUREMENT_INTERVAL_MILLIS

Constructor Summary

Constructors

Constructor and Description
FastestResponseStrategyPlugin(FullServicesContainer servicesContainer, @NonNull java.util.Properties properties)
FastestResponseStrategyPlugin(@NonNull PluginService pluginService, @NonNull java.util.Properties properties, @NonNull HostResponseTimeService hostResponseTimeService)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsStrategy(HostRole role, java.lang.String strategy) Returns a boolean indicating if this ConnectionPlugin implements the specified host selection strategy for the given role in ConnectionPlugin.getHostSpecByStrategy(software.amazon.jdbc.HostRole, java.lang.String).
static void	clearCache()
java.sql.Connection	connect(java.lang.String driverProtocol, HostSpec hostSpec, java.util.Properties props, boolean isInitialConnection, JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc) Establishes a connection to the given host using the given driver protocol and properties.
HostSpec	getHostSpecByStrategy(HostRole role, java.lang.String strategy) Selects a HostSpec with the requested role from available hosts using the requested strategy.
java.util.Set<java.lang.String>	getSubscribedMethods()
void	notifyNodeListChanged(java.util.Map<java.lang.String,java.util.EnumSet<NodeChangeOptions>> changes)

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

execute, forceConnect, getHostSpecByStrategy, initHostProvider, notifyConnectionChanged

Methods inherited from class java.lang.Object

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

Field Detail

FASTEST_RESPONSE_STRATEGY_NAME

public static final java.lang.String FASTEST_RESPONSE_STRATEGY_NAME

See Also:

Constant Field Values

RESPONSE_MEASUREMENT_INTERVAL_MILLIS

public static final AwsWrapperProperty RESPONSE_MEASUREMENT_INTERVAL_MILLIS

cachedFastestResponseHostByRole

protected static final CacheMap<java.lang.String,HostSpec> cachedFastestResponseHostByRole

randomHostSelector

protected static final RandomHostSelector randomHostSelector

pluginService

protected final @NonNull PluginService pluginService

properties

protected final @NonNull java.util.Properties properties

hostResponseTimeService

protected final @NonNull HostResponseTimeService hostResponseTimeService

cacheExpirationNano

protected long cacheExpirationNano

hosts

protected java.util.List<HostSpec> hosts

Constructor Detail

FastestResponseStrategyPlugin

public FastestResponseStrategyPlugin(FullServicesContainer servicesContainer,
                                     @NonNull java.util.Properties properties)

FastestResponseStrategyPlugin

public FastestResponseStrategyPlugin(@NonNull PluginService pluginService,
                                     @NonNull java.util.Properties properties,
                                     @NonNull HostResponseTimeService hostResponseTimeService)

Method Detail

getSubscribedMethods

public java.util.Set<java.lang.String> getSubscribedMethods()

Specified by:

getSubscribedMethods in interface ConnectionPlugin

Specified by:

getSubscribedMethods in class AbstractConnectionPlugin

connect

public java.sql.Connection connect(java.lang.String driverProtocol,
                                   HostSpec hostSpec,
                                   java.util.Properties props,
                                   boolean isInitialConnection,
                                   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

acceptsStrategy

public boolean acceptsStrategy(HostRole role,
                               java.lang.String strategy)

Description copied from interface: ConnectionPlugin

Returns a boolean indicating if this ConnectionPlugin implements the specified host selection strategy for the given role in ConnectionPlugin.getHostSpecByStrategy(software.amazon.jdbc.HostRole, java.lang.String).

Specified by:

acceptsStrategy in interface ConnectionPlugin

Overrides:

acceptsStrategy in class AbstractConnectionPlugin

Parameters:

role - the desired host role

strategy - the strategy that should be used to pick a host (eg "random")

Returns:

true if this ConnectionPlugin supports the selection of a host with the requested role and strategy via ConnectionPlugin.getHostSpecByStrategy(software.amazon.jdbc.HostRole, java.lang.String). Otherwise, return false.

getHostSpecByStrategy

public HostSpec getHostSpecByStrategy(HostRole role,
                                      java.lang.String strategy)
                               throws java.sql.SQLException,
                                      java.lang.UnsupportedOperationException

Description copied from interface: ConnectionPlugin

Selects a HostSpec with the requested role from available hosts using the requested strategy. ConnectionPlugin.acceptsStrategy(software.amazon.jdbc.HostRole, java.lang.String) should be called first to evaluate if this ConnectionPlugin supports the selection of a host with the requested role and strategy.

Specified by:

getHostSpecByStrategy in interface ConnectionPlugin

Overrides:

getHostSpecByStrategy in class AbstractConnectionPlugin

Parameters:

role - the desired role of the host - either a writer or a reader

strategy - the strategy that should be used to select a HostSpec from the available hosts (eg "random")

Returns:

a HostSpec with the requested role

Throws:

java.sql.SQLException - if the available hosts do not contain any hosts matching the requested role or an error occurs while selecting a host

java.lang.UnsupportedOperationException - if this ConnectionPlugin does not support the requested strategy

notifyNodeListChanged

public void notifyNodeListChanged(java.util.Map<java.lang.String,java.util.EnumSet<NodeChangeOptions>> changes)

Specified by:

notifyNodeListChanged in interface ConnectionPlugin

Overrides:

notifyNodeListChanged in class AbstractConnectionPlugin

clearCache

public static void clearCache()