PluginServiceImpl (aws-advanced-jdbc-wrapper 2.6.4 API)

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.util.List<HostSpec>`	`allHosts`
`protected @Nullable ConfigurationProfile`	`configurationProfile`
`protected ConnectionProviderManager`	`connectionProviderManager`
`protected java.util.concurrent.locks.ReentrantLock`	`connectionSwitchLock`
`protected java.sql.Connection`	`currentConnection`
`protected HostSpec`	`currentHostSpec`
`protected static long`	`DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO`
`protected static long`	`DEFAULT_STATUS_CACHE_EXPIRE_NANO`
`protected Dialect`	`dialect`
`protected DialectProvider`	`dialectProvider`
`protected @Nullable ExceptionHandler`	`exceptionHandler`
`protected static CacheMap<java.lang.String,HostAvailability>`	`hostAvailabilityExpiringCache`
`protected HostListProvider`	`hostListProvider`
`protected HostSpec`	`initialConnectionHostSpec`
`protected ConnectionPluginManager`	`pluginManager`
`protected FullServicesContainer`	`servicesContainer`
`protected SessionStateService`	`sessionStateService`
`protected static CacheMap<java.lang.String,java.lang.Object>`	`statusesExpiringCache`
`protected TargetDriverDialect`	`targetDriverDialect`

Constructor Summary

Constructors
Constructor and Description
`PluginServiceImpl(@NonNull FullServicesContainer servicesContainer, @NonNull ExceptionManager exceptionManager, @NonNull java.util.Properties props, @NonNull java.lang.String originalUrl, @NonNull java.lang.String targetDriverProtocol, @Nullable DialectProvider dialectProvider, @NonNull TargetDriverDialect targetDriverDialect, @Nullable ConfigurationProfile configurationProfile, @Nullable SessionStateService sessionStateService)`
`PluginServiceImpl(@NonNull FullServicesContainer servicesContainer, @NonNull java.util.Properties props, @NonNull java.lang.String originalUrl, @NonNull java.lang.String targetDriverProtocol, @NonNull TargetDriverDialect targetDriverDialect)`
`PluginServiceImpl(@NonNull FullServicesContainer servicesContainer, @NonNull java.util.Properties props, @NonNull java.lang.String originalUrl, @NonNull java.lang.String targetDriverProtocol, @NonNull TargetDriverDialect targetDriverDialect, @Nullable ConfigurationProfile configurationProfile)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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)`.
`static void`	`clearCache()`
`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.
`java.sql.Connection`	`connect(HostSpec hostSpec, java.util.Properties props, @Nullable ConnectionPlugin pluginToSkip)`
`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.
`java.sql.Connection`	`forceConnect(HostSpec hostSpec, java.util.Properties props, @Nullable ConnectionPlugin pluginToSkip)`
`void`	`forceRefreshHostList()`
`boolean`	`forceRefreshHostList(boolean shouldVerifyWriter, long timeoutMs)` Initiates a topology update.
`void`	`forceRefreshHostList(java.sql.Connection connection)`
`java.util.List<HostSpec>`	`getAllHosts()` Get host information for all hosts in the cluster.
`ConnectionProvider`	`getConnectionProvider()` Deprecated.
`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()` Get host information for allowed hosts in the cluster.
`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`	`getHostSpecByStrategy(java.util.List<HostSpec> hosts, HostRole role, java.lang.String strategy)` Selects a `HostSpec` with the requested role from available hosts using the requested strategy.
`HostSpec`	`getInitialConnectionHostSpec()`
`java.lang.String`	`getOriginalUrl()`
`<T> T`	`getPlugin(java.lang.Class<T> pluginClazz)`
`java.util.Properties`	`getProperties()`
`@NonNull SessionStateService`	`getSessionStateService()`
`<T> T`	`getStatus(@NonNull java.lang.Class<T> clazz, boolean clusterBound)` Deprecated.
`<T> T`	`getStatus(@NonNull java.lang.Class<T> clazz, java.lang.String key)` Deprecated.
`protected <T> java.lang.String`	`getStatusCacheKey(java.lang.Class<T> clazz, java.lang.String key)`
`TargetDriverDialect`	`getTargetDriverDialect()`
`java.lang.String`	`getTargetName()`
`TelemetryFactory`	`getTelemetryFactory()`
`HostSpec`	`identifyConnection(java.sql.Connection connection)`
`boolean`	`isInTransaction()`
`boolean`	`isLoginException(java.lang.String sqlState)`
`boolean`	`isLoginException(java.lang.Throwable throwable)` Deprecated.
`boolean`	`isLoginException(java.lang.Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect)`
`boolean`	`isNetworkException(java.lang.String sqlState)`
`boolean`	`isNetworkException(java.lang.Throwable throwable)` Deprecated.
`boolean`	`isNetworkException(java.lang.Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect)`
`boolean`	`isPluginInUse(java.lang.Class<? extends ConnectionPlugin> pluginClazz)`
`boolean`	`isPooledConnectionProvider(HostSpec host, java.util.Properties props)`
`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`	`setAllowedAndBlockedHosts(AllowedAndBlockedHosts allowedAndBlockedHosts)` Deprecated.
`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)` Set a new internal connection.
`void`	`setHostListProvider(HostListProvider hostListProvider)`
`void`	`setInitialConnectionHostSpec(@NonNull HostSpec initialConnectionHostSpec)`
`void`	`setInTransaction(boolean inTransaction)`
`<T> void`	`setStatus(java.lang.Class<T> clazz, T status, boolean clusterBound)` Deprecated.
`<T> void`	`setStatus(java.lang.Class<T> clazz, T status, java.lang.String key)` Deprecated.
`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
```
  - servicesContainer
```
protected final FullServicesContainer servicesContainer
```
  - statusesExpiringCache
```
protected static final CacheMap<java.lang.String,java.lang.Object> statusesExpiringCache
```
  - DEFAULT_STATUS_CACHE_EXPIRE_NANO
```
protected static final long DEFAULT_STATUS_CACHE_EXPIRE_NANO
```
  - pluginManager
```
protected final ConnectionPluginManager pluginManager
```
  - hostListProvider
```
protected volatile HostListProvider hostListProvider
```
  - allHosts
```
protected java.util.List<HostSpec> allHosts
```
  - currentConnection
```
protected java.sql.Connection currentConnection
```
  - currentHostSpec
```
protected HostSpec currentHostSpec
```
  - initialConnectionHostSpec
```
protected HostSpec initialConnectionHostSpec
```
  - exceptionHandler
```
protected final @Nullable ExceptionHandler exceptionHandler
```
  - dialectProvider
```
protected final DialectProvider dialectProvider
```
  - dialect
```
protected Dialect dialect
```
  - targetDriverDialect
```
protected TargetDriverDialect targetDriverDialect
```
  - configurationProfile
```
protected final @Nullable ConfigurationProfile configurationProfile
```
  - connectionProviderManager
```
protected final ConnectionProviderManager connectionProviderManager
```
  - sessionStateService
```
protected final SessionStateService sessionStateService
```
  - connectionSwitchLock
```
protected final java.util.concurrent.locks.ReentrantLock connectionSwitchLock
```
- Constructor Detail
  - PluginServiceImpl
```
public PluginServiceImpl(@NonNull FullServicesContainer servicesContainer,
                         @NonNull java.util.Properties props,
                         @NonNull java.lang.String originalUrl,
                         @NonNull java.lang.String targetDriverProtocol,
                         @NonNull TargetDriverDialect targetDriverDialect)
                  throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - PluginServiceImpl
```
public PluginServiceImpl(@NonNull FullServicesContainer servicesContainer,
                         @NonNull java.util.Properties props,
                         @NonNull java.lang.String originalUrl,
                         @NonNull java.lang.String targetDriverProtocol,
                         @NonNull TargetDriverDialect targetDriverDialect,
                         @Nullable ConfigurationProfile configurationProfile)
                  throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - PluginServiceImpl
```
public PluginServiceImpl(@NonNull FullServicesContainer servicesContainer,
                         @NonNull ExceptionManager exceptionManager,
                         @NonNull java.util.Properties props,
                         @NonNull java.lang.String originalUrl,
                         @NonNull java.lang.String targetDriverProtocol,
                         @Nullable DialectProvider dialectProvider,
                         @NonNull TargetDriverDialect targetDriverDialect,
                         @Nullable ConfigurationProfile configurationProfile,
                         @Nullable SessionStateService sessionStateService)
                  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
  - getOriginalUrl
```
public java.lang.String getOriginalUrl()
```
    Specified by:
    
    getOriginalUrl in interface PluginService
  - setAllowedAndBlockedHosts
```
@Deprecated
public void setAllowedAndBlockedHosts(AllowedAndBlockedHosts allowedAndBlockedHosts)
```
    Deprecated.
    
    Description copied from interface: PluginService
    
    Set the collection of hosts that should be allowed and/or blocked for connections.
    
    Specified by:
    
    setAllowedAndBlockedHosts in interface PluginService
    
    Parameters:
    
    allowedAndBlockedHosts - An object defining the allowed and blocked sets of hosts.
  - 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 - if there's an error processing this method.
  - 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
  - getHostSpecByStrategy
```
public HostSpec getHostSpecByStrategy(java.util.List<HostSpec> hosts,
                                      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:
    
    hosts - the list of HostSpec from which a HostSpec will be selected 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 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
```
@Deprecated
public ConnectionProvider getConnectionProvider()
```
    Deprecated.
    
    Specified by:
    
    getConnectionProvider in interface PluginService
  - isPooledConnectionProvider
```
public boolean isPooledConnectionProvider(HostSpec host,
                                          java.util.Properties props)
```
    Specified by:
    
    isPooledConnectionProvider 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
```
    Description copied from interface: PluginService
    
    Set a new internal connection. While setting a new connection, a notification may be sent to all plugins. See ConnectionPlugin.notifyConnectionChanged(EnumSet) for more details. A plugin mentioned in parameter skipNotificationForThisPlugin won't be receiving such notification.
    
    Specified by:
    
    setCurrentConnection in interface PluginService
    
    Parameters:
    
    connection - the new internal connection.
    
    hostSpec - the host details for a new internal connection.
    
    skipNotificationForThisPlugin - A reference to a plugin that doesn't need to receive notification about connection change. Usually, a plugin that initiates connection change doesn't need to receive such notification and uses a pointer to itself as a call parameter.
    
    Returns:
    
    a set of notification options about this connection switch.
    
    Throws:
    
    java.sql.SQLException - if there's an error setting a current connection.
  - 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)
```
  - getAllHosts
```
public java.util.List<HostSpec> getAllHosts()
```
    Description copied from interface: PluginService
    
    Get host information for all hosts in the cluster.
    
    Specified by:
    
    getAllHosts in interface PluginService
    
    Returns:
    
    host information for all hosts in the cluster.
  - getHosts
```
public java.util.List<HostSpec> getHosts()
```
    Description copied from interface: PluginService
    
    Get host information for allowed hosts in the cluster. Certain hosts in the cluster may be disallowed, and these hosts will not be returned by this function. For example, if a custom endpoint is being used, hosts outside the custom endpoint will not be returned.
    
    Specified by:
    
    getHosts in interface PluginService
    
    Returns:
    
    host information for allowed hosts in the cluster.
  - setAvailability
```
public void setAvailability(@NonNull java.util.Set<java.lang.String> hostAliases,
                            @NonNull HostAvailability availability)
```
    Specified by:
    
    setAvailability in interface PluginService
  - isInTransaction
```
public boolean isInTransaction()
```
    Specified by:
    
    isInTransaction in interface PluginService
  - 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
  - forceRefreshHostList
```
public boolean forceRefreshHostList(boolean shouldVerifyWriter,
                                    long timeoutMs)
                             throws java.sql.SQLException
```
    Description copied from interface: PluginService
    
    Initiates a topology update.
    
    Specified by:
    
    forceRefreshHostList in interface PluginService
    
    Parameters:
    
    shouldVerifyWriter - true, if a caller expects to get topology with the latest confirmed writer
    
    timeoutMs - timeout in msec to wait until topology gets refreshed and a new (or existing) writer is confirmed (if shouldVerifyWriter has a value of true).
    
    Returns:
    
    true, if successful. False, if operation is unsuccessful or timeout is reached
    
    Throws:
    
    java.sql.SQLException - if there was an error establishing a connection or fetching a topology
  - 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 Driver.setCustomConnectionProvider(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
  - connect
```
public java.sql.Connection connect(HostSpec hostSpec,
                                   java.util.Properties props,
                                   @Nullable ConnectionPlugin pluginToSkip)
                            throws java.sql.SQLException
```
    Specified by:
    
    connect in interface PluginService
    
    Throws:
    
    java.sql.SQLException
  - 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 Driver.setCustomConnectionProvider(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
  - forceConnect
```
public java.sql.Connection forceConnect(HostSpec hostSpec,
                                        java.util.Properties props,
                                        @Nullable ConnectionPlugin pluginToSkip)
                                 throws java.sql.SQLException
```
    Specified by:
    
    forceConnect in interface PluginService
    
    Throws:
    
    java.sql.SQLException
  - 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
```
@Deprecated
public boolean isNetworkException(java.lang.Throwable throwable)
```
    Deprecated.
    
    Description copied from interface: ExceptionHandler
    
    The method determines whether provided throwable is about any network issues.
    
    Specified by:
    
    isNetworkException in interface ExceptionHandler
    
    Parameters:
    
    throwable - A throwable object to check.
    
    Returns:
    
    true, if a provided throwable object is network-related.
  - isNetworkException
```
public boolean isNetworkException(java.lang.Throwable throwable,
                                  @Nullable TargetDriverDialect targetDriverDialect)
```
    Specified by:
    
    isNetworkException in interface ExceptionHandler
  - isNetworkException
```
public boolean isNetworkException(java.lang.String sqlState)
```
    Specified by:
    
    isNetworkException in interface ExceptionHandler
  - isLoginException
```
@Deprecated
public boolean isLoginException(java.lang.Throwable throwable)
```
    Deprecated.
    
    Description copied from interface: ExceptionHandler
    
    The method determines whether provided throwable is about any login or authentication issues.
    
    Specified by:
    
    isLoginException in interface ExceptionHandler
    
    Parameters:
    
    throwable - A throwable object to check.
    
    Returns:
    
    true, if a provided throwable object is related to authentication.
  - isLoginException
```
public boolean isLoginException(java.lang.Throwable throwable,
                                @Nullable TargetDriverDialect targetDriverDialect)
```
    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
  - getTargetDriverDialect
```
public TargetDriverDialect getTargetDriverDialect()
```
    Specified by:
    
    getTargetDriverDialect 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
  - getProperties
```
public java.util.Properties getProperties()
```
    Specified by:
    
    getProperties in interface PluginService
  - getTelemetryFactory
```
public TelemetryFactory getTelemetryFactory()
```
    Specified by:
    
    getTelemetryFactory in interface PluginService
  - getTargetName
```
public java.lang.String getTargetName()
```
    Specified by:
    
    getTargetName in interface PluginService
  - getSessionStateService
```
public @NonNull SessionStateService getSessionStateService()
```
    Specified by:
    
    getSessionStateService in interface PluginService
  - getPlugin
```
public <T> T getPlugin(java.lang.Class<T> pluginClazz)
```
    Specified by:
    
    getPlugin in interface PluginService
  - clearCache
```
public static void clearCache()
```
  - setStatus
```
@Deprecated
public <T> void setStatus(java.lang.Class<T> clazz,
                                      T status,
                                      boolean clusterBound)
```
    Deprecated.
    
    Specified by:
    
    setStatus in interface PluginService
  - setStatus
```
@Deprecated
public <T> void setStatus(java.lang.Class<T> clazz,
                                      T status,
                                      java.lang.String key)
```
    Deprecated.
    
    Specified by:
    
    setStatus in interface PluginService
  - getStatus
```
@Deprecated
public <T> T getStatus(@NonNull java.lang.Class<T> clazz,
                                   boolean clusterBound)
```
    Deprecated.
    
    Specified by:
    
    getStatus in interface PluginService
  - getStatus
```
@Deprecated
public <T> T getStatus(@NonNull java.lang.Class<T> clazz,
                                   java.lang.String key)
```
    Deprecated.
    
    Specified by:
    
    getStatus in interface PluginService
  - getStatusCacheKey
```
protected <T> java.lang.String getStatusCacheKey(java.lang.Class<T> clazz,
                                                 java.lang.String key)
```
  - isPluginInUse
```
public boolean isPluginInUse(java.lang.Class<? extends ConnectionPlugin> pluginClazz)
```
    Specified by:
    
    isPluginInUse in interface PluginService

Class PluginServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO

hostAvailabilityExpiringCache

servicesContainer

statusesExpiringCache

DEFAULT_STATUS_CACHE_EXPIRE_NANO

pluginManager

hostListProvider

allHosts

currentConnection

currentHostSpec

initialConnectionHostSpec

exceptionHandler

dialectProvider

dialect

targetDriverDialect

configurationProfile

connectionProviderManager

sessionStateService

connectionSwitchLock

Constructor Detail

PluginServiceImpl

PluginServiceImpl

PluginServiceImpl

Method Detail

getCurrentConnection

getCurrentHostSpec

setInitialConnectionHostSpec

getInitialConnectionHostSpec

getOriginalUrl

setAllowedAndBlockedHosts

acceptsStrategy

getHostSpecByStrategy

getHostSpecByStrategy

getHostRole

getConnectionProvider

isPooledConnectionProvider

getDriverProtocol

setCurrentConnection

setCurrentConnection

compare

compare

getAllHosts

getHosts

setAvailability

isInTransaction

setInTransaction

getHostListProvider

refreshHostList

refreshHostList

forceRefreshHostList

forceRefreshHostList

forceRefreshHostList

isStaticHostListProvider

setHostListProvider

connect

connect

forceConnect

forceConnect

releaseResources

isNetworkException

isNetworkException

isNetworkException

isLoginException

isLoginException

isLoginException

getDialect

getTargetDriverDialect

updateDialect

identifyConnection

fillAliases

getHostSpecBuilder

getProperties

getTelemetryFactory

getTargetName