software.amazon.jdbc.plugin

Class AuroraInitialConnectionStrategyPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.AuroraInitialConnectionStrategyPlugin

All Implemented Interfaces:

ConnectionPlugin

public class AuroraInitialConnectionStrategyPlugin
extends AbstractConnectionPlugin

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	OPEN_CONNECTION_RETRY_INTERVAL_MS
static AwsWrapperProperty	OPEN_CONNECTION_RETRY_TIMEOUT_MS
static AwsWrapperProperty	READER_HOST_SELECTOR_STRATEGY

Constructor Summary

Constructors

Constructor and Description
AuroraInitialConnectionStrategyPlugin(PluginService pluginService, 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, JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc) Establishes a connection to the given host using the given driver protocol and properties.
java.sql.Connection	forceConnect(java.lang.String driverProtocol, HostSpec hostSpec, java.util.Properties props, boolean isInitialConnection, JdbcCallable<java.sql.Connection,java.sql.SQLException> forceConnectFunc) Establishes a connection to the given host using the given driver protocol and properties.
java.util.Set<java.lang.String>	getSubscribedMethods()
protected long	getTime()
void	initHostProvider(java.lang.String driverProtocol, java.lang.String initialUrl, java.util.Properties props, HostListProviderService hostListProviderService, JdbcCallable<java.lang.Void,java.sql.SQLException> initHostProviderFunc)

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

acceptsStrategy, execute, getHostSpecByStrategy, getHostSpecByStrategy, notifyConnectionChanged, notifyNodeListChanged

Methods inherited from class java.lang.Object

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

Field Detail

READER_HOST_SELECTOR_STRATEGY

public static final AwsWrapperProperty READER_HOST_SELECTOR_STRATEGY

OPEN_CONNECTION_RETRY_TIMEOUT_MS

public static final AwsWrapperProperty OPEN_CONNECTION_RETRY_TIMEOUT_MS

OPEN_CONNECTION_RETRY_INTERVAL_MS

public static final AwsWrapperProperty OPEN_CONNECTION_RETRY_INTERVAL_MS

Constructor Detail

AuroraInitialConnectionStrategyPlugin

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

Method Detail

getSubscribedMethods

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

Specified by:

getSubscribedMethods in interface ConnectionPlugin

Specified by:

getSubscribedMethods in class AbstractConnectionPlugin

initHostProvider

public void initHostProvider(java.lang.String driverProtocol,
                             java.lang.String initialUrl,
                             java.util.Properties props,
                             HostListProviderService hostListProviderService,
                             JdbcCallable<java.lang.Void,java.sql.SQLException> initHostProviderFunc)
                      throws java.sql.SQLException

Specified by:

initHostProvider in interface ConnectionPlugin

Overrides:

initHostProvider in class AbstractConnectionPlugin

Throws:

java.sql.SQLException

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 ConnectionProviderManager.setConnectionProvider(software.amazon.jdbc.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

forceConnect

public java.sql.Connection forceConnect(java.lang.String driverProtocol,
                                        HostSpec hostSpec,
                                        java.util.Properties props,
                                        boolean isInitialConnection,
                                        JdbcCallable<java.sql.Connection,java.sql.SQLException> forceConnectFunc)
                                 throws java.sql.SQLException

Description copied from interface: ConnectionPlugin

Establishes a connection to the given host using the given driver protocol and properties. This call differs from ConnectionPlugin.connect(java.lang.String, software.amazon.jdbc.HostSpec, java.util.Properties, boolean, software.amazon.jdbc.JdbcCallable<java.sql.Connection, java.sql.SQLException>) in that the default ConnectionProvider will be used to establish the connection even if a non-default ConnectionProvider has been set via ConnectionProviderManager.setConnectionProvider(software.amazon.jdbc.ConnectionProvider). The default ConnectionProvider will be DriverConnectionProvider for connections requested via the DriverManager and DataSourceConnectionProvider for connections requested via an AwsWrapperDataSource.

Specified by:

forceConnect in interface ConnectionPlugin

Overrides:

forceConnect 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

forceConnectFunc - the function to call to continue the forceConnect request down the forceConnect pipeline

Returns:

a Connection to the requested host

Throws:

java.sql.SQLException - if there was an error establishing a Connection to the requested host

getTime

protected long getTime()