software.amazon.jdbc

Class ConnectionProviderManager

java.lang.Object

software.amazon.jdbc.ConnectionProviderManager

public class ConnectionProviderManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConnectionProviderManager.ConnectionInitFunc

Constructor Summary

Constructors

Constructor and Description
ConnectionProviderManager(ConnectionProvider defaultProvider, @Nullable ConnectionProvider effectiveConnProvider) ConnectionProviderManager constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsStrategy(HostRole role, java.lang.String strategy) Returns a boolean indicating if the available ConnectionProvider instances support the selection of a host with the requested role and strategy via getHostSpecByStrategy(java.util.List<software.amazon.jdbc.HostSpec>, software.amazon.jdbc.HostRole, java.lang.String, java.util.Properties).
ConnectionProvider	getConnectionProvider(java.lang.String driverProtocol, HostSpec host, java.util.Properties props) Get the ConnectionProvider to use to establish a connection using the given driver protocol, host details, and properties.
ConnectionProvider	getDefaultProvider() Get the default ConnectionProvider.
HostSpec	getHostSpecByStrategy(java.util.List<HostSpec> hosts, HostRole role, java.lang.String strategy, java.util.Properties props) Select a HostSpec with the desired role from the given hosts using the requested strategy.
void	initConnection(@Nullable java.sql.Connection connection, @NonNull java.lang.String protocol, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props)
static void	releaseResources() Releases any resources held by the available ConnectionProvider instances.
static void	resetConnectionInitFunc() Deprecated. Use Driver.resetConnectionInitFunc() instead
static void	resetProvider() Deprecated. Use Driver.resetCustomConnectionProvider() instead
static void	setConnectionInitFunc(@NonNull ConnectionProviderManager.ConnectionInitFunc func) Deprecated. @see Driver#setConnectionInitFunc(ConnectionInitFunc)
static void	setConnectionProvider(ConnectionProvider connProvider) Deprecated. Use Driver.setCustomConnectionProvider(ConnectionProvider) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionProviderManager

public ConnectionProviderManager(ConnectionProvider defaultProvider,
                                 @Nullable ConnectionProvider effectiveConnProvider)

ConnectionProviderManager constructor.

Parameters:

defaultProvider - the default ConnectionProvider to use if a non-default ConnectionProvider has not been set or the non-default ConnectionProvider has been set but does not accept a requested URL

effectiveConnProvider - the non-default ConnectionProvider to use

Method Detail

setConnectionProvider

@Deprecated
public static void setConnectionProvider(ConnectionProvider connProvider)

Deprecated. Use Driver.setCustomConnectionProvider(ConnectionProvider) instead.

Setter that can optionally be called to request a non-default ConnectionProvider. The requested ConnectionProvider will be used to establish future connections unless it does not support a requested URL, in which case the default ConnectionProvider will be used. See ConnectionProvider.acceptsUrl(java.lang.String, software.amazon.jdbc.HostSpec, java.util.Properties) for more info.

Parameters:

connProvider - the ConnectionProvider to use to establish new connections

getConnectionProvider

public ConnectionProvider getConnectionProvider(java.lang.String driverProtocol,
                                                HostSpec host,
                                                java.util.Properties props)

Get the ConnectionProvider to use to establish a connection using the given driver protocol, host details, and properties. If a non-default ConnectionProvider has been set using setConnectionProvider(software.amazon.jdbc.ConnectionProvider) and ConnectionProvider.acceptsUrl(java.lang.String, software.amazon.jdbc.HostSpec, java.util.Properties) returns true, the non-default ConnectionProvider will be returned. Otherwise, the default ConnectionProvider will be returned. See ConnectionProvider.acceptsUrl(java.lang.String, software.amazon.jdbc.HostSpec, java.util.Properties) for more info.

Parameters:

driverProtocol - the driver protocol that will be used to establish the connection

host - the host info for the connection that will be established

props - the connection properties for the connection that will be established

Returns:

the ConnectionProvider to use to establish a connection using the given driver protocol, host details, and properties

getDefaultProvider

public ConnectionProvider getDefaultProvider()

Get the default ConnectionProvider.

Returns:

the default ConnectionProvider.

acceptsStrategy

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

Returns a boolean indicating if the available ConnectionProvider instances support the selection of a host with the requested role and strategy via getHostSpecByStrategy(java.util.List<software.amazon.jdbc.HostSpec>, software.amazon.jdbc.HostRole, java.lang.String, java.util.Properties).

Parameters:

role - the desired host role

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

Returns:

true if the available ConnectionProvider instances support the selection of a host with the requested role and strategy via getHostSpecByStrategy(java.util.List<software.amazon.jdbc.HostSpec>, software.amazon.jdbc.HostRole, java.lang.String, java.util.Properties). Otherwise, return false

getHostSpecByStrategy

public HostSpec getHostSpecByStrategy(java.util.List<HostSpec> hosts,
                                      HostRole role,
                                      java.lang.String strategy,
                                      java.util.Properties props)
                               throws java.sql.SQLException,
                                      java.lang.UnsupportedOperationException

Select a HostSpec with the desired role from the given hosts using the requested strategy. acceptsStrategy(software.amazon.jdbc.HostRole, java.lang.String) should be called first to evaluate if the available ConnectionProvider instances support the selection of a host with the requested role and strategy.

Parameters:

hosts - the list of hosts to select from

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 host list (eg "random")

props - any properties that are required by the provided strategy to select a host

Returns:

a HostSpec with the requested role

Throws:

java.sql.SQLException - if the available ConnectionProvider instances cannot find a host in the host list matching the requested role or an error occurs while selecting a host

java.lang.UnsupportedOperationException - if the available ConnectionProvider instances do not support the requested strategy

resetProvider

@Deprecated
public static void resetProvider()

Deprecated. Use Driver.resetCustomConnectionProvider() instead

Clears the non-default ConnectionProvider if it has been set. The default ConnectionProvider will be used if the non-default ConnectionProvider has not been set or has been cleared.

releaseResources

public static void releaseResources()

Releases any resources held by the available ConnectionProvider instances.

setConnectionInitFunc

@Deprecated
public static void setConnectionInitFunc(@NonNull ConnectionProviderManager.ConnectionInitFunc func)

Deprecated. @see Driver#setConnectionInitFunc(ConnectionInitFunc)

Sets a custom connection initialization function. It'll be used for every brand-new database connection.

Parameters:

func - A function that initialize a new connection

resetConnectionInitFunc

@Deprecated
public static void resetConnectionInitFunc()

Deprecated. Use Driver.resetConnectionInitFunc() instead

Resets a custom connection initialization function.

initConnection

public void initConnection(@Nullable java.sql.Connection connection,
                           @NonNull java.lang.String protocol,
                           @NonNull HostSpec hostSpec,
                           @NonNull java.util.Properties props)
                    throws java.sql.SQLException

Throws:

java.sql.SQLException