software.amazon.jdbc

Class ConnectionPluginManager

java.lang.Object

software.amazon.jdbc.ConnectionPluginManager

All Implemented Interfaces:

CanReleaseResources

public class ConnectionPluginManager
extends java.lang.Object
implements CanReleaseResources

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionProvider	connectionProvider
protected ConnectionWrapper	connectionWrapper
protected static java.lang.String	DEFAULT_PLUGINS
protected java.util.Map<java.lang.String,software.amazon.jdbc.ConnectionPluginManager.PluginChainJdbcCallable>	pluginChainFuncMap
protected static java.util.Map<java.lang.String,java.lang.Class<? extends ConnectionPluginFactory>>	pluginFactoriesByCode
protected java.util.ArrayList<ConnectionPlugin>	plugins
protected java.util.Properties	props

Constructor Summary

Constructors

Constructor and Description
ConnectionPluginManager(ConnectionProvider connectionProvider, ConnectionWrapper connectionWrapper)

Method Summary

Modifier and Type	Method and Description
java.sql.Connection	connect(java.lang.String driverProtocol, HostSpec hostSpec, java.util.Properties props, boolean isInitialConnection)
<T,E extends java.lang.Exception> T	execute(java.lang.Class<T> resultType, java.lang.Class<E> exceptionClass, java.lang.Object methodInvokeOn, java.lang.String methodName, JdbcCallable<T,E> jdbcMethodFunc, java.lang.Object[] jdbcMethodArgs)
protected <T,E extends java.lang.Exception> T	executeWithSubscribedPlugins(java.lang.String methodName, software.amazon.jdbc.ConnectionPluginManager.PluginPipeline<T,E> pluginPipeline, JdbcCallable<T,E> jdbcMethodFunc)
ConnectionWrapper	getConnectionWrapper()
void	init(PluginService pluginService, java.util.Properties props, PluginManagerService pluginManagerService) 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)
void	lock()
protected <T,E extends java.lang.Exception> @Nullable software.amazon.jdbc.ConnectionPluginManager.PluginChainJdbcCallable<T,E>	makePluginChainFunc(@NonNull java.lang.String methodName)
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, software.amazon.jdbc.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()

Methods inherited from class java.lang.Object

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

Field Detail

pluginFactoriesByCode

protected static final java.util.Map<java.lang.String,java.lang.Class<? extends ConnectionPluginFactory>> pluginFactoriesByCode

DEFAULT_PLUGINS

protected static final java.lang.String DEFAULT_PLUGINS

See Also:

Constant Field Values

props

protected java.util.Properties props

plugins

protected java.util.ArrayList<ConnectionPlugin> plugins

connectionProvider

protected final ConnectionProvider connectionProvider

connectionWrapper

protected final ConnectionWrapper connectionWrapper

pluginChainFuncMap

protected final java.util.Map<java.lang.String,software.amazon.jdbc.ConnectionPluginManager.PluginChainJdbcCallable> pluginChainFuncMap

Constructor Detail

ConnectionPluginManager

public ConnectionPluginManager(ConnectionProvider connectionProvider,
                               ConnectionWrapper connectionWrapper)

Method Detail

lock

public void lock()

unlock

public void unlock()

init

public void init(PluginService pluginService,
                 java.util.Properties props,
                 PluginManagerService pluginManagerService)
          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:

pluginService - A reference to a plugin service that plugin can use.

props - The configuration of the connection.

pluginManagerService - A reference to a plugin manager service.

Throws:

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

executeWithSubscribedPlugins

protected <T,E extends java.lang.Exception> T executeWithSubscribedPlugins(java.lang.String methodName,
                                                                           software.amazon.jdbc.ConnectionPluginManager.PluginPipeline<T,E> pluginPipeline,
                                                                           JdbcCallable<T,E> jdbcMethodFunc)
                                                                    throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

makePluginChainFunc

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

notifySubscribedPlugins

protected <E extends java.lang.Exception> void notifySubscribedPlugins(java.lang.String methodName,
                                                                       software.amazon.jdbc.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()

execute

public <T,E extends java.lang.Exception> T execute(java.lang.Class<T> resultType,
                                                   java.lang.Class<E> exceptionClass,
                                                   java.lang.Object methodInvokeOn,
                                                   java.lang.String methodName,
                                                   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)
                            throws java.sql.SQLException

Throws:

java.sql.SQLException

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