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

java.lang.Object
- software.amazon.jdbc.PluginServiceImpl

All Implemented Interfaces:: java.sql.Wrapper, CanReleaseResources, ExceptionHandler, HostListProviderService, PluginManagerService, PluginService, StateSnapshotProvider

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<HostSpec>`	`allHosts`
`protected PluginCallContext`	`callContext`
`protected @Nullable ConfigurationProfile`	`configurationProfile`
`protected ConnectionProviderManager`	`connectionProviderManager`
`protected ResourceLock`	`connectionSwitchLock`
`protected java.sql.Connection`	`currentConnection`
`protected @Nullable HostSpec`	`currentHostSpec`
`protected static long`	`DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO`
`protected static int`	`DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS`
`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 @Nullable java.lang.Boolean`	`pooledConnection`
`protected @Nullable HostSpec`	`routedHostSpec`
`protected FullServicesContainer`	`servicesContainer`
`protected SessionStateService`	`sessionStateService`
`protected TargetDriverDialect`	`targetDriverDialect`
`protected TrackedConnectionList.Node`	`trackedConnectionNode`

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)`
`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 verifyTopology, long timeoutMs)` Initiates a topology update.
`java.util.List<HostSpec>`	`getAllHosts()` Get host information for all hosts in the cluster.
`PluginCallContext`	`getCallContext()` Returns the per-call context that flows through the plugin pipeline for the current JDBC call.
`java.sql.Connection`	`getCurrentConnection()`
`HostSpec`	`getCurrentHostSpec()`
`ConnectionProvider`	`getDefaultConnectionProvider()`
`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(@Nullable 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, @Nullable 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()`
`@Nullable HostSpec`	`getRoutedHostSpec()`
`@NonNull SessionStateService`	`getSessionStateService()`
`java.util.List<Pair<java.lang.String,java.lang.Object>>`	`getSnapshotState()`
`TargetDriverDialect`	`getTargetDriverDialect()`
`java.lang.String`	`getTargetName()`
`TelemetryFactory`	`getTelemetryFactory()`
`TrackedConnectionList.Node`	`getTrackedConnectionNode()` Returns the tracked connection list node associated with the current connection.
`@Nullable HostSpec`	`identifyConnection(java.sql.Connection connection)`
`@Nullable HostSpec`	`identifyConnection(java.sql.Connection connection, @NonNull HostSpec connectionHostSpec)`
`boolean`	`isDialectConfirmed()`
`boolean`	`isInTransaction()`
`boolean`	`isLoginException(@Nullable java.lang.String sqlState)`
`boolean`	`isLoginException(java.lang.Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect)`
`boolean`	`isNetworkException(@Nullable java.lang.String sqlState)`
`boolean`	`isNetworkException(java.lang.Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect)`
`boolean`	`isPluginInUse(java.lang.Class<? extends ConnectionPlugin> pluginClazz)`
`@Nullable java.lang.Boolean`	`isPooledConnection()` Retrieves details about the most recent `PluginService.connect(software.amazon.jdbc.HostSpec, java.util.Properties, software.amazon.jdbc.ConnectionPlugin)` or `PluginService.forceConnect(software.amazon.jdbc.HostSpec, java.util.Properties)` calls.
`boolean`	`isPooledConnectionProvider(HostSpec host, java.util.Properties props)` Deprecated.
`boolean`	`isReadOnlyConnectionException(@Nullable java.lang.String sqlState, @Nullable java.lang.Integer errorCode)`
`boolean`	`isReadOnlyConnectionException(java.lang.Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect)`
`boolean`	`isStaticHostListProvider()`
`boolean`	`isWrapperFor(java.lang.Class<?> iface)`
`void`	`refreshHostList()`
`void`	`releaseResources()` An object that implements this interface should release all acquired resources assuming it may be disposed at any time.
`void`	`resetCallContext()`
`void`	`setAvailability(@NonNull HostSpec hostSpec, @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)`
`void`	`setIsPooledConnection(@Nullable java.lang.Boolean isPooledConnection)`
`void`	`setRoutedHostSpec(@Nullable HostSpec routedHostSpec)`
`void`	`setTrackedConnectionNode(TrackedConnectionList.Node node)` Sets the tracked connection list node for the current connection.
`<T> T`	`unwrap(java.lang.Class<T> iface)`
`void`	`updateDialect(@NonNull java.sql.Connection connection)`
`protected void`	`updateHostListProvider()`

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
```
  - DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS
```
protected static final int DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - hostAvailabilityExpiringCache
```
protected static final CacheMap<java.lang.String,HostAvailability> hostAvailabilityExpiringCache
```
  - servicesContainer
```
protected final FullServicesContainer servicesContainer
```
  - 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 @Nullable HostSpec currentHostSpec
```
  - initialConnectionHostSpec
```
protected HostSpec initialConnectionHostSpec
```
  - routedHostSpec
```
protected @Nullable HostSpec routedHostSpec
```
  - 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 ResourceLock connectionSwitchLock
```
  - trackedConnectionNode
```
protected TrackedConnectionList.Node trackedConnectionNode
```
  - pooledConnection
```
protected @Nullable java.lang.Boolean pooledConnection
```
  - callContext
```
protected final PluginCallContext callContext
```
- 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
  - 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(@Nullable 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,
                                      @Nullable 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
  - getDefaultConnectionProvider
```
public ConnectionProvider getDefaultConnectionProvider()
```
    Specified by:
    
    getDefaultConnectionProvider in interface PluginService
  - isPooledConnectionProvider
```
@Deprecated
public boolean isPooledConnectionProvider(HostSpec host,
                                                      java.util.Properties props)
```
    Deprecated.
    
    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.
  - getRoutedHostSpec
```
public @Nullable HostSpec getRoutedHostSpec()
```
    Specified by:
    
    getRoutedHostSpec in interface PluginService
  - setRoutedHostSpec
```
public void setRoutedHostSpec(@Nullable HostSpec routedHostSpec)
```
    Specified by:
    
    setRoutedHostSpec in interface PluginService
  - 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 HostSpec hostSpec,
                            @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
  - isDialectConfirmed
```
public boolean isDialectConfirmed()
```
    Specified by:
    
    isDialectConfirmed in interface PluginService
  - 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
  - forceRefreshHostList
```
public void forceRefreshHostList()
                          throws java.sql.SQLException
```
    Specified by:
    
    forceRefreshHostList in interface PluginService
    
    Throws:
    
    java.sql.SQLException
  - forceRefreshHostList
```
public boolean forceRefreshHostList(boolean verifyTopology,
                                    long timeoutMs)
                             throws java.sql.SQLException
```
    Description copied from interface: PluginService
    
    Initiates a topology update.
    
    Specified by:
    
    forceRefreshHostList in interface PluginService
    
    Parameters:
    
    verifyTopology - defines whether extra measures should be taken to verify the topology. If false, the method will return as soon as topology is successfully retrieved from any instance. If true, extra steps are taken to verify the topology is accurate.
    
    timeoutMs - timeout in msec to wait until the topology gets refreshed (if verifyWriter has a value of false) or verified (if verifyTopology has a value of true).
    
    Returns:
    
    true if successful, false if unsuccessful or the 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
```
public boolean isNetworkException(java.lang.Throwable throwable,
                                  @Nullable TargetDriverDialect targetDriverDialect)
```
    Specified by:
    
    isNetworkException in interface ExceptionHandler
  - isNetworkException
```
public boolean isNetworkException(@Nullable java.lang.String sqlState)
```
    Specified by:
    
    isNetworkException in interface ExceptionHandler
  - isLoginException
```
public boolean isLoginException(java.lang.Throwable throwable,
                                @Nullable TargetDriverDialect targetDriverDialect)
```
    Specified by:
    
    isLoginException in interface ExceptionHandler
  - isLoginException
```
public boolean isLoginException(@Nullable java.lang.String sqlState)
```
    Specified by:
    
    isLoginException in interface ExceptionHandler
  - isReadOnlyConnectionException
```
public boolean isReadOnlyConnectionException(@Nullable java.lang.String sqlState,
                                             @Nullable java.lang.Integer errorCode)
```
    Specified by:
    
    isReadOnlyConnectionException in interface ExceptionHandler
  - isReadOnlyConnectionException
```
public boolean isReadOnlyConnectionException(java.lang.Throwable throwable,
                                             @Nullable TargetDriverDialect targetDriverDialect)
```
    Specified by:
    
    isReadOnlyConnectionException 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
  - updateHostListProvider
```
protected void updateHostListProvider()
                               throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - identifyConnection
```
public @Nullable HostSpec identifyConnection(java.sql.Connection connection,
                                             @NonNull HostSpec connectionHostSpec)
                                      throws java.sql.SQLException
```
    Specified by:
    
    identifyConnection in interface PluginService
    
    Throws:
    
    java.sql.SQLException
  - identifyConnection
```
public @Nullable HostSpec identifyConnection(java.sql.Connection connection)
                                      throws java.sql.SQLException
```
    Specified by:
    
    identifyConnection 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
  - getCallContext
```
public PluginCallContext getCallContext()
```
    Description copied from interface: PluginService
    
    Returns the per-call context that flows through the plugin pipeline for the current JDBC call. Plugins can use it to share SQL analysis results and other per-call attributes.
    
    Specified by:
    
    getCallContext in interface PluginService
    
    Returns:
    
    the current PluginCallContext.
  - getPlugin
```
public <T> T getPlugin(java.lang.Class<T> pluginClazz)
```
    Specified by:
    
    getPlugin in interface PluginService
  - clearCache
```
public static void clearCache()
```
  - isPluginInUse
```
public boolean isPluginInUse(java.lang.Class<? extends ConnectionPlugin> pluginClazz)
```
    Specified by:
    
    isPluginInUse in interface PluginService
  - isPooledConnection
```
public @Nullable java.lang.Boolean isPooledConnection()
```
    Description copied from interface: PluginService
    
    Retrieves details about the most recent PluginService.connect(software.amazon.jdbc.HostSpec, java.util.Properties, software.amazon.jdbc.ConnectionPlugin) or PluginService.forceConnect(software.amazon.jdbc.HostSpec, java.util.Properties) calls. Specifically indicates whether the returned connection was obtained from a connection pool or newly created.
    Note: The ConnectionPlugin must process or store this information during the current JDBC call, as these details will be reset before the next JDBC call is processed, or another PluginService.connect(software.amazon.jdbc.HostSpec, java.util.Properties, software.amazon.jdbc.ConnectionPlugin) or PluginService.forceConnect(software.amazon.jdbc.HostSpec, java.util.Properties) is made.
    
    Specified by:
    
    isPooledConnection in interface PluginService
    
    Returns:
    
    true if the most recent connection was obtained from a connection pool, false if it was newly created, null if the information is not available
  - setIsPooledConnection
```
public void setIsPooledConnection(@Nullable java.lang.Boolean isPooledConnection)
```
    Specified by:
    
    setIsPooledConnection in interface PluginManagerService
  - getTrackedConnectionNode
```
public TrackedConnectionList.Node getTrackedConnectionNode()
```
    Description copied from interface: PluginService
    
    Returns the tracked connection list node associated with the current connection.
    
    Specified by:
    
    getTrackedConnectionNode in interface PluginService
    
    Returns:
    
    the node, or null if the current connection is not tracked
  - setTrackedConnectionNode
```
public void setTrackedConnectionNode(TrackedConnectionList.Node node)
```
    Description copied from interface: PluginService
    
    Sets the tracked connection list node for the current connection.
    
    Specified by:
    
    setTrackedConnectionNode in interface PluginService
    
    Parameters:
    
    node - the node returned by OpenedConnectionTracker.populateOpenedConnectionQueue(software.amazon.jdbc.HostSpec, java.sql.Connection)
  - resetCallContext
```
public void resetCallContext()
```
    Specified by:
    
    resetCallContext in interface PluginManagerService
  - 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
  - getSnapshotState
```
public java.util.List<Pair<java.lang.String,java.lang.Object>> getSnapshotState()
```
    Specified by:
    
    getSnapshotState in interface StateSnapshotProvider

Class PluginServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HOST_AVAILABILITY_CACHE_EXPIRE_NANO

DEFAULT_TOPOLOGY_QUERY_TIMEOUT_MS

hostAvailabilityExpiringCache

servicesContainer

pluginManager

hostListProvider

allHosts

currentConnection

currentHostSpec

initialConnectionHostSpec

routedHostSpec

exceptionHandler

dialectProvider

dialect

targetDriverDialect

configurationProfile

connectionProviderManager

sessionStateService

connectionSwitchLock

trackedConnectionNode

pooledConnection

callContext

Constructor Detail

PluginServiceImpl

PluginServiceImpl

PluginServiceImpl

Method Detail

getCurrentConnection

getCurrentHostSpec

setInitialConnectionHostSpec

getInitialConnectionHostSpec

getOriginalUrl

acceptsStrategy

getHostSpecByStrategy

getHostSpecByStrategy

getHostRole

getDefaultConnectionProvider

isPooledConnectionProvider

getDriverProtocol

setCurrentConnection

setCurrentConnection

getRoutedHostSpec

setRoutedHostSpec

compare

compare

getAllHosts

getHosts

setAvailability

isInTransaction

setInTransaction

isDialectConfirmed

getHostListProvider

refreshHostList

forceRefreshHostList

forceRefreshHostList

isStaticHostListProvider

setHostListProvider

connect

connect

forceConnect

forceConnect

releaseResources

isNetworkException

isNetworkException

isLoginException

isLoginException

isReadOnlyConnectionException

isReadOnlyConnectionException

getDialect

getTargetDriverDialect

updateDialect

updateHostListProvider

identifyConnection

identifyConnection