software.amazon.jdbc

Class ConnectionPluginManager

java.lang.Object

software.amazon.jdbc.ConnectionPluginManager

All Implemented Interfaces:

java.sql.Wrapper, CanReleaseResources

public class ConnectionPluginManager
extends java.lang.Object
implements CanReleaseResources, java.sql.Wrapper

This class creates and handles a chain of ConnectionPlugin for each connection.

THIS CLASS IS NOT MULTI-THREADING SAFE IT'S EXPECTED TO HAVE ONE INSTANCE OF THIS MANAGER PER JDBC CONNECTION

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	ConnectionPluginManager.PluginChainJdbcCallable<T,E extends java.lang.Exception>
protected static class	ConnectionPluginManager.PluginChainJdbcCallableInfo<T,E extends java.lang.Exception>
protected static interface	ConnectionPluginManager.PluginPipeline<T,E extends java.lang.Exception>

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionWrapper	connectionWrapper
protected @NonNull ConnectionProvider	defaultConnProvider
protected @Nullable ConnectionProvider	effectiveConnProvider
protected boolean	isTelemetryInUse
protected ConnectionPluginManager.PluginChainJdbcCallableInfo[]	pluginChainFuncMap
protected static java.util.Map<java.lang.Class<? extends ConnectionPlugin>,java.lang.String>	pluginNameByClass
protected java.util.List<ConnectionPlugin>	plugins
protected PluginService	pluginService
protected java.util.Properties	props
protected FullServicesContainer	servicesContainer
protected TelemetryFactory	telemetryFactory

Constructor Summary

Constructors

Constructor and Description
ConnectionPluginManager(@NonNull ConnectionProvider defaultConnProvider, @Nullable ConnectionProvider effectiveConnProvider, @Nullable ConnectionWrapper connectionWrapper, @NonNull TelemetryFactory telemetryFactory)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsStrategy(HostRole role, java.lang.String strategy) Returns a boolean indicating if the available ConnectionProvider or ConnectionPlugin instances implement the selection of a host with the requested role and strategy via getHostSpecByStrategy(software.amazon.jdbc.HostRole, java.lang.String).
java.sql.Connection	connect(java.lang.String driverProtocol, HostSpec hostSpec, java.util.Properties props, boolean isInitialConnection, @Nullable ConnectionPlugin pluginToSkip) Establishes a connection to the given host using the given driver protocol and properties.
<T,E extends java.lang.Exception> T	execute(java.lang.Class<T> resultType, java.lang.Class<E> exceptionClass, java.lang.Object methodInvokeOn, JdbcMethod jdbcMethod, JdbcCallable<T,E> jdbcMethodFunc, java.lang.Object[] jdbcMethodArgs)
protected <T,E extends java.lang.Exception> T	executeWithSubscribedPlugins(JdbcMethod jdbcMethod, ConnectionPluginManager.PluginPipeline<T,E> pluginPipeline, JdbcCallable<T,E> jdbcMethodFunc, @Nullable ConnectionPlugin pluginToSkip)
protected <T,E extends java.lang.Exception> T	executeWithTelemetry(@NonNull JdbcCallable<T,E> execution, @NonNull java.lang.String pluginName)
java.sql.Connection	forceConnect(java.lang.String driverProtocol, HostSpec hostSpec, java.util.Properties props, boolean isInitialConnection, @Nullable ConnectionPlugin pluginToSkip) Establishes a connection to the given host using the given driver protocol and properties.
ConnectionWrapper	getConnectionWrapper()
@NonNull ConnectionProvider	getDefaultConnProvider()
@Nullable ConnectionProvider	getEffectiveConnProvider()
HostSpec	getHostSpecByStrategy(HostRole role, java.lang.String strategy) Selects a HostSpec with the requested role from available hosts using the requested strategy.
HostSpec	getHostSpecByStrategy(java.util.List<HostSpec> hosts, HostRole role, java.lang.String strategy)
TelemetryFactory	getTelemetryFactory()
void	init(FullServicesContainer servicesContainer, java.util.Properties props, PluginManagerService pluginManagerService, @Nullable ConfigurationProfile configurationProfile) Initialize a chain of ConnectionPlugin using their corresponding ConnectionPluginFactory.
void	initHostProvider(java.lang.String driverProtocol, java.lang.String initialUrl, java.util.Properties props, HostListProviderService hostListProviderService)
boolean	isWrapperFor(java.lang.Class<?> iface)
void	lock()
protected <T,E extends java.lang.Exception> @Nullable ConnectionPluginManager.PluginChainJdbcCallableInfo<T,E>	makePluginChainFunc(@NonNull java.lang.String methodName)
boolean	mustUsePipeline(JdbcMethod jdbcMethod)
java.util.EnumSet<OldConnectionSuggestedAction>	notifyConnectionChanged(@NonNull java.util.EnumSet<NodeChangeOptions> changes, @Nullable ConnectionPlugin skipNotificationForThisPlugin)
void	notifyNodeListChanged(@NonNull java.util.Map<java.lang.String,java.util.EnumSet<NodeChangeOptions>> changes)
protected <E extends java.lang.Exception> void	notifySubscribedPlugins(java.lang.String methodName, ConnectionPluginManager.PluginPipeline<java.lang.Void,E> pluginPipeline, ConnectionPlugin skipNotificationForThisPlugin)
void	releaseResources() Release all dangling resources held by the connection plugins associated with a single connection.
void	unlock()
<T> T	unwrap(java.lang.Class<T> iface)

Methods inherited from class java.lang.Object

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

Field Detail

pluginNameByClass

protected static final java.util.Map<java.lang.Class<? extends ConnectionPlugin>,java.lang.String> pluginNameByClass

props

protected java.util.Properties props

plugins

protected java.util.List<ConnectionPlugin> plugins

defaultConnProvider

protected final @NonNull ConnectionProvider defaultConnProvider

effectiveConnProvider

protected final @Nullable ConnectionProvider effectiveConnProvider

connectionWrapper

protected final ConnectionWrapper connectionWrapper

servicesContainer

protected FullServicesContainer servicesContainer

pluginService

protected PluginService pluginService

telemetryFactory

protected TelemetryFactory telemetryFactory

isTelemetryInUse

protected boolean isTelemetryInUse

pluginChainFuncMap

protected final ConnectionPluginManager.PluginChainJdbcCallableInfo[] pluginChainFuncMap

Constructor Detail

ConnectionPluginManager

public ConnectionPluginManager(@NonNull ConnectionProvider defaultConnProvider,
                               @Nullable ConnectionProvider effectiveConnProvider,
                               @Nullable ConnectionWrapper connectionWrapper,
                               @NonNull TelemetryFactory telemetryFactory)

Method Detail

lock

public void lock()

unlock

public void unlock()

init

public void init(FullServicesContainer servicesContainer,
                 java.util.Properties props,
                 PluginManagerService pluginManagerService,
                 @Nullable ConfigurationProfile configurationProfile)
          throws java.sql.SQLException

Initialize a chain of ConnectionPlugin using their corresponding ConnectionPluginFactory. If PropertyDefinition.PLUGINS is provided by the user, initialize the chain with the given connection plugins in the order they are specified.

The DefaultConnectionPlugin will always be initialized and attached as the last connection plugin in the chain.

Parameters:

servicesContainer - the service container for the services required by this class.

props - the configuration of the connection

pluginManagerService - a reference to a plugin manager service

configurationProfile - a profile configuration defined by the user

Throws:

java.sql.SQLException - if errors occurred during the execution

executeWithSubscribedPlugins

protected <T,E extends java.lang.Exception> T executeWithSubscribedPlugins(JdbcMethod jdbcMethod,
                                                                           ConnectionPluginManager.PluginPipeline<T,E> pluginPipeline,
                                                                           JdbcCallable<T,E> jdbcMethodFunc,
                                                                           @Nullable ConnectionPlugin pluginToSkip)
                                                                    throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

executeWithTelemetry

protected <T,E extends java.lang.Exception> T executeWithTelemetry(@NonNull JdbcCallable<T,E> execution,
                                                                   @NonNull java.lang.String pluginName)
                                                            throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

makePluginChainFunc

protected <T,E extends java.lang.Exception> @Nullable ConnectionPluginManager.PluginChainJdbcCallableInfo<T,E> makePluginChainFunc(@NonNull java.lang.String methodName)

notifySubscribedPlugins

protected <E extends java.lang.Exception> void notifySubscribedPlugins(java.lang.String methodName,
                                                                       ConnectionPluginManager.PluginPipeline<java.lang.Void,E> pluginPipeline,
                                                                       ConnectionPlugin skipNotificationForThisPlugin)
                                                                throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

getConnectionWrapper

public ConnectionWrapper getConnectionWrapper()

getTelemetryFactory

public TelemetryFactory getTelemetryFactory()

mustUsePipeline

public boolean mustUsePipeline(JdbcMethod jdbcMethod)

execute

public <T,E extends java.lang.Exception> T execute(java.lang.Class<T> resultType,
                                                   java.lang.Class<E> exceptionClass,
                                                   java.lang.Object methodInvokeOn,
                                                   JdbcMethod jdbcMethod,
                                                   JdbcCallable<T,E> jdbcMethodFunc,
                                                   java.lang.Object[] jdbcMethodArgs)
                                            throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

connect

public java.sql.Connection connect(java.lang.String driverProtocol,
                                   HostSpec hostSpec,
                                   java.util.Properties props,
                                   boolean isInitialConnection,
                                   @Nullable ConnectionPlugin pluginToSkip)
                            throws java.sql.SQLException

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.

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

pluginToSkip - the plugin that needs to be skipped while executing this 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,
                                        @Nullable ConnectionPlugin pluginToSkip)
                                 throws java.sql.SQLException

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 Driver.setCustomConnectionProvider(ConnectionProvider). The default ConnectionProvider will be DriverConnectionProvider for connections requested via the DriverManager and DataSourceConnectionProvider for connections requested via an AwsWrapperDataSource.

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

pluginToSkip - the plugin that needs to be skipped while executing this 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)
                        throws java.sql.SQLException

Returns a boolean indicating if the available ConnectionProvider or ConnectionPlugin instances implement the selection of a host with the requested role and strategy via getHostSpecByStrategy(software.amazon.jdbc.HostRole, java.lang.String).

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 or ConnectionPlugin instances support the selection of a host with the requested role and strategy via getHostSpecByStrategy(software.amazon.jdbc.HostRole, java.lang.String). Otherwise, return false.

Throws:

java.sql.SQLException - if there's error processing this method

getHostSpecByStrategy

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

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

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 the available ConnectionProvider or ConnectionPlugin instances do not support the requested strategy

getHostSpecByStrategy

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

Throws:

java.sql.SQLException

java.lang.UnsupportedOperationException

initHostProvider

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

Throws:

java.sql.SQLException

notifyConnectionChanged

public java.util.EnumSet<OldConnectionSuggestedAction> notifyConnectionChanged(@NonNull java.util.EnumSet<NodeChangeOptions> changes,
                                                                               @Nullable ConnectionPlugin skipNotificationForThisPlugin)

notifyNodeListChanged

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

releaseResources

public void releaseResources()

Release all dangling resources held by the connection plugins associated with a single connection.

Specified by:

releaseResources in interface CanReleaseResources

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException

Specified by:

unwrap in interface java.sql.Wrapper

Throws:

java.sql.SQLException

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException

Specified by:

isWrapperFor in interface java.sql.Wrapper

Throws:

java.sql.SQLException

getDefaultConnProvider

public @NonNull ConnectionProvider getDefaultConnProvider()

getEffectiveConnProvider

public @Nullable ConnectionProvider getEffectiveConnProvider()