software.amazon.jdbc

Interface PluginService

All Superinterfaces:

ExceptionHandler

All Known Implementing Classes:

PluginServiceImpl

public interface PluginService
extends ExceptionHandler

Interface for retrieving the current active Connection and its HostSpec.

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 getHostSpecByStrategy(software.amazon.jdbc.HostRole, java.lang.String).
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	isReadOnly()
void	refreshHostList()
void	refreshHostList(java.sql.Connection connection)
void	setAvailability(java.util.Set<java.lang.String> hostAliases, 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	updateDialect(@NonNull java.sql.Connection connection)

Methods inherited from interface software.amazon.jdbc.exceptions.ExceptionHandler

isLoginException, isLoginException, isNetworkException, isNetworkException

Method Detail

getCurrentConnection

java.sql.Connection getCurrentConnection()

getCurrentHostSpec

HostSpec getCurrentHostSpec()

setCurrentConnection

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

Throws:

java.sql.SQLException

setCurrentConnection

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

Throws:

java.sql.SQLException

getHosts

java.util.List<HostSpec> getHosts()

getInitialConnectionHostSpec

HostSpec getInitialConnectionHostSpec()

acceptsStrategy

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

Returns a boolean indicating 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).

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

getHostSpecByStrategy

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 ConnectionProvider or ConnectionPlugin instances do not cannot find a host 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

getHostRole

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

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

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

setAvailability

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

isExplicitReadOnly

boolean isExplicitReadOnly()

isReadOnly

boolean isReadOnly()

isInTransaction

boolean isInTransaction()

getHostListProvider

HostListProvider getHostListProvider()

refreshHostList

void refreshHostList()
              throws java.sql.SQLException

Throws:

java.sql.SQLException

refreshHostList

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

Throws:

java.sql.SQLException

forceRefreshHostList

void forceRefreshHostList()
                   throws java.sql.SQLException

Throws:

java.sql.SQLException

forceRefreshHostList

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

Throws:

java.sql.SQLException

connect

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

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.

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

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

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.

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

getDialect

Dialect getDialect()

updateDialect

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

Throws:

java.sql.SQLException

identifyConnection

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

Throws:

java.sql.SQLException

fillAliases

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

Throws:

java.sql.SQLException

getHostSpecBuilder

HostSpecBuilder getHostSpecBuilder()

getConnectionProvider

ConnectionProvider getConnectionProvider()

getDriverProtocol

java.lang.String getDriverProtocol()