software.amazon.jdbc

Class PluginServiceImpl

java.lang.Object

software.amazon.jdbc.PluginServiceImpl

All Implemented Interfaces:

CanReleaseResources, ExceptionHandler, HostListProviderService, PluginManagerService, PluginService

public class PluginServiceImpl
extends java.lang.Object
implements PluginService, CanReleaseResources, HostListProviderService, PluginManagerService

Field Summary

Fields

Modifier and Type	Field and Description
protected java.sql.Connection	currentConnection
protected HostSpec	currentHostSpec
protected static long	DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO
protected Dialect	dialect
protected DialectProvider	dialectProvider
protected static CacheMap<java.lang.String,HostAvailability>	hostAvailabilityExpiringCache
protected HostListProvider	hostListProvider
protected java.util.List<HostSpec>	hosts
protected HostSpec	initialConnectionHostSpec
protected ConnectionPluginManager	pluginManager

Constructor Summary

Constructors

Constructor and Description
PluginServiceImpl(@NonNull ConnectionPluginManager pluginManager, @NonNull ExceptionManager exceptionManager, @NonNull java.util.Properties props, @NonNull java.lang.String originalUrl, java.lang.String targetDriverProtocol, @Nullable DialectProvider dialectProvider)
PluginServiceImpl(@NonNull ConnectionPluginManager pluginManager, @NonNull java.util.Properties props, @NonNull java.lang.String originalUrl, java.lang.String targetDriverProtocol)

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 support the selection of a host with the requested role and strategy via PluginService.getHostSpecByStrategy(software.amazon.jdbc.HostRole, java.lang.String).
protected java.util.EnumSet<NodeChangeOptions>	compare(@NonNull java.sql.Connection connA, @NonNull HostSpec hostSpecA, @NonNull java.sql.Connection connB, @NonNull HostSpec hostSpecB)
protected java.util.EnumSet<NodeChangeOptions>	compare(@NonNull HostSpec hostSpecA, @NonNull HostSpec hostSpecB)
java.sql.Connection	connect(HostSpec hostSpec, java.util.Properties props) Establishes a connection to the given host using the given properties.
void	fillAliases(java.sql.Connection connection, HostSpec hostSpec)
java.sql.Connection	forceConnect(HostSpec hostSpec, java.util.Properties props) Establishes a connection to the given host using the given properties.
void	forceRefreshHostList()
void	forceRefreshHostList(java.sql.Connection connection)
ConnectionProvider	getConnectionProvider()
java.sql.Connection	getCurrentConnection()
HostSpec	getCurrentHostSpec()
Dialect	getDialect()
java.lang.String	getDriverProtocol()
HostListProvider	getHostListProvider()
HostRole	getHostRole(java.sql.Connection conn) Evaluates the host role of the given connection - either a writer or a reader.
java.util.List<HostSpec>	getHosts()
HostSpecBuilder	getHostSpecBuilder()
HostSpec	getHostSpecByStrategy(HostRole role, java.lang.String strategy) Selects a HostSpec with the requested role from available hosts using the requested strategy.
HostSpec	getInitialConnectionHostSpec()
HostSpec	identifyConnection(java.sql.Connection connection)
boolean	isExplicitReadOnly()
boolean	isInTransaction()
boolean	isLoginException(java.lang.String sqlState)
boolean	isLoginException(java.lang.Throwable throwable)
boolean	isNetworkException(java.lang.String sqlState)
boolean	isNetworkException(java.lang.Throwable throwable)
boolean	isReadOnly()
boolean	isStaticHostListProvider()
void	refreshHostList()
void	refreshHostList(java.sql.Connection connection)
void	releaseResources() An object that implements this interface should release all acquired resources assuming it may be disposed at any time.
void	setAvailability(@NonNull java.util.Set<java.lang.String> hostAliases, @NonNull HostAvailability availability)
void	setCurrentConnection(@NonNull java.sql.Connection connection, @NonNull HostSpec hostSpec)
java.util.EnumSet<NodeChangeOptions>	setCurrentConnection(@NonNull java.sql.Connection connection, @NonNull HostSpec hostSpec, @Nullable ConnectionPlugin skipNotificationForThisPlugin)
void	setHostListProvider(HostListProvider hostListProvider)
void	setInitialConnectionHostSpec(@NonNull HostSpec initialConnectionHostSpec)
void	setInTransaction(boolean inTransaction)
void	setReadOnly(boolean readOnly)
void	updateDialect(@NonNull java.sql.Connection connection)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO

protected static final long DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO

hostAvailabilityExpiringCache

protected static final CacheMap<java.lang.String,HostAvailability> hostAvailabilityExpiringCache

pluginManager

protected final ConnectionPluginManager pluginManager

hostListProvider

protected volatile HostListProvider hostListProvider

hosts

protected java.util.List<HostSpec> hosts

currentConnection

protected java.sql.Connection currentConnection

currentHostSpec

protected HostSpec currentHostSpec

initialConnectionHostSpec

protected HostSpec initialConnectionHostSpec

dialectProvider

protected final DialectProvider dialectProvider

dialect

protected Dialect dialect

Constructor Detail

PluginServiceImpl

public PluginServiceImpl(@NonNull ConnectionPluginManager pluginManager,
                         @NonNull java.util.Properties props,
                         @NonNull java.lang.String originalUrl,
                         java.lang.String targetDriverProtocol)
                  throws java.sql.SQLException

Throws:

java.sql.SQLException

PluginServiceImpl

public PluginServiceImpl(@NonNull ConnectionPluginManager pluginManager,
                         @NonNull ExceptionManager exceptionManager,
                         @NonNull java.util.Properties props,
                         @NonNull java.lang.String originalUrl,
                         java.lang.String targetDriverProtocol,
                         @Nullable DialectProvider dialectProvider)
                  throws java.sql.SQLException

Throws:

java.sql.SQLException

Method Detail

getCurrentConnection

public java.sql.Connection getCurrentConnection()

Specified by:

getCurrentConnection in interface HostListProviderService

Specified by:

getCurrentConnection in interface PluginService

getCurrentHostSpec

public HostSpec getCurrentHostSpec()

Specified by:

getCurrentHostSpec in interface HostListProviderService

Specified by:

getCurrentHostSpec in interface PluginService

setInitialConnectionHostSpec

public void setInitialConnectionHostSpec(@NonNull HostSpec initialConnectionHostSpec)

Specified by:

setInitialConnectionHostSpec in interface HostListProviderService

getInitialConnectionHostSpec

public HostSpec getInitialConnectionHostSpec()

Specified by:

getInitialConnectionHostSpec in interface HostListProviderService

Specified by:

getInitialConnectionHostSpec in interface PluginService

acceptsStrategy

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

Description copied from interface: PluginService

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

Specified by:

acceptsStrategy in interface PluginService

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 PluginService.getHostSpecByStrategy(software.amazon.jdbc.HostRole, java.lang.String). Otherwise, return false.

Throws:

java.sql.SQLException

getHostSpecByStrategy

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

Description copied from interface: PluginService

Selects a HostSpec with the requested role from available hosts using the requested strategy. PluginService.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.

Specified by:

getHostSpecByStrategy in interface PluginService

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 ConnectionProvider or ConnectionPlugin instances do not cannot find a host matching the requested role or an error occurs while selecting a host

getHostRole

public HostRole getHostRole(java.sql.Connection conn)
                     throws java.sql.SQLException

Description copied from interface: PluginService

Evaluates the host role of the given connection - either a writer or a reader.

Specified by:

getHostRole in interface PluginService

Parameters:

conn - a connection to the database instance whose role should be determined

Returns:

the role of the given connection - either a writer or a reader

Throws:

java.sql.SQLException - if there is a problem executing or processing the SQL query used to determine the host role

getConnectionProvider

public ConnectionProvider getConnectionProvider()

Specified by:

getConnectionProvider in interface PluginService

getDriverProtocol

public java.lang.String getDriverProtocol()

Specified by:

getDriverProtocol in interface PluginService

setCurrentConnection

public void setCurrentConnection(@NonNull java.sql.Connection connection,
                                 @NonNull HostSpec hostSpec)
                          throws java.sql.SQLException

Specified by:

setCurrentConnection in interface PluginService

Throws:

java.sql.SQLException

setCurrentConnection

public java.util.EnumSet<NodeChangeOptions> setCurrentConnection(@NonNull java.sql.Connection connection,
                                                                 @NonNull HostSpec hostSpec,
                                                                 @Nullable ConnectionPlugin skipNotificationForThisPlugin)
                                                          throws java.sql.SQLException

Specified by:

setCurrentConnection in interface PluginService

Throws:

java.sql.SQLException

compare

protected java.util.EnumSet<NodeChangeOptions> compare(@NonNull java.sql.Connection connA,
                                                       @NonNull HostSpec hostSpecA,
                                                       @NonNull java.sql.Connection connB,
                                                       @NonNull HostSpec hostSpecB)

compare

protected java.util.EnumSet<NodeChangeOptions> compare(@NonNull HostSpec hostSpecA,
                                                       @NonNull HostSpec hostSpecB)

getHosts

public java.util.List<HostSpec> getHosts()

Specified by:

getHosts in interface PluginService

setAvailability

public void setAvailability(@NonNull java.util.Set<java.lang.String> hostAliases,
                            @NonNull HostAvailability availability)

Specified by:

setAvailability in interface PluginService

isExplicitReadOnly

public boolean isExplicitReadOnly()

Specified by:

isExplicitReadOnly in interface PluginService

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface PluginService

isInTransaction

public boolean isInTransaction()

Specified by:

isInTransaction in interface PluginService

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface PluginManagerService

setInTransaction

public void setInTransaction(boolean inTransaction)

Specified by:

setInTransaction in interface PluginManagerService

getHostListProvider

public HostListProvider getHostListProvider()

Specified by:

getHostListProvider in interface HostListProviderService

Specified by:

getHostListProvider in interface PluginService

refreshHostList

public void refreshHostList()
                     throws java.sql.SQLException

Specified by:

refreshHostList in interface PluginService

Throws:

java.sql.SQLException

refreshHostList

public void refreshHostList(java.sql.Connection connection)
                     throws java.sql.SQLException

Specified by:

refreshHostList in interface PluginService

Throws:

java.sql.SQLException

forceRefreshHostList

public void forceRefreshHostList()
                          throws java.sql.SQLException

Specified by:

forceRefreshHostList in interface PluginService

Throws:

java.sql.SQLException

forceRefreshHostList

public void forceRefreshHostList(java.sql.Connection connection)
                          throws java.sql.SQLException

Specified by:

forceRefreshHostList in interface PluginService

Throws:

java.sql.SQLException

isStaticHostListProvider

public boolean isStaticHostListProvider()

Specified by:

isStaticHostListProvider in interface HostListProviderService

setHostListProvider

public void setHostListProvider(HostListProvider hostListProvider)

Specified by:

setHostListProvider in interface HostListProviderService

connect

public java.sql.Connection connect(HostSpec hostSpec,
                                   java.util.Properties props)
                            throws java.sql.SQLException

Description copied from interface: PluginService

Establishes a connection to the given host using the given 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 desired 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 PluginService

Parameters:

hostSpec - the host details for the desired connection

props - the connection properties

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(HostSpec hostSpec,
                                        java.util.Properties props)
                                 throws java.sql.SQLException

Description copied from interface: PluginService

Establishes a connection to the given host using the given 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 PluginService

Parameters:

hostSpec - the host details for the desired connection

props - the connection properties

Returns:

a Connection to the requested host

Throws:

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

releaseResources

public void releaseResources()

Description copied from interface: CanReleaseResources

An object that implements this interface should release all acquired resources assuming it may be disposed at any time. This method may be called more than once.

Calling this method does NOT mean that an object is disposing and there won't be any further calls. An object should keep its functional state after calling this method.

Specified by:

releaseResources in interface CanReleaseResources

isNetworkException

public boolean isNetworkException(java.lang.Throwable throwable)

Specified by:

isNetworkException in interface ExceptionHandler

isNetworkException

public boolean isNetworkException(java.lang.String sqlState)

Specified by:

isNetworkException in interface ExceptionHandler

isLoginException

public boolean isLoginException(java.lang.Throwable throwable)

Specified by:

isLoginException in interface ExceptionHandler

isLoginException

public boolean isLoginException(java.lang.String sqlState)

Specified by:

isLoginException in interface ExceptionHandler

getDialect

public Dialect getDialect()

Specified by:

getDialect in interface HostListProviderService

Specified by:

getDialect in interface PluginService

updateDialect

public void updateDialect(@NonNull java.sql.Connection connection)
                   throws java.sql.SQLException

Specified by:

updateDialect in interface PluginService

Throws:

java.sql.SQLException

identifyConnection

public HostSpec identifyConnection(java.sql.Connection connection)
                            throws java.sql.SQLException

Specified by:

identifyConnection in interface PluginService

Throws:

java.sql.SQLException

fillAliases

public void fillAliases(java.sql.Connection connection,
                        HostSpec hostSpec)
                 throws java.sql.SQLException

Specified by:

fillAliases in interface PluginService

Throws:

java.sql.SQLException

getHostSpecBuilder

public HostSpecBuilder getHostSpecBuilder()

Specified by:

getHostSpecBuilder in interface HostListProviderService

Specified by:

getHostSpecBuilder in interface PluginService