software.amazon.jdbc.plugin.federatedauth

Class BaseSamlAuthPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.federatedauth.BaseSamlAuthPlugin

All Implemented Interfaces:

ConnectionPlugin, StateSnapshotProvider

Direct Known Subclasses:

FederatedAuthPlugin, OktaAuthPlugin

public abstract class BaseSamlAuthPlugin
extends AbstractConnectionPlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable TelemetryGauge	cacheSizeGauge
protected CredentialsProviderFactory	credentialsProviderFactory
protected @Nullable TelemetryCounter	fetchTokenCounter
protected static java.lang.String	IAM_REGION_NAME
protected PluginService	pluginService
protected RdsUtils	rdsUtils
protected RegionUtils	regionUtils
protected SamlUtils	samlUtils
protected FullServicesContainer	servicesContainer
protected TelemetryFactory	telemetryFactory

Method Summary

Modifier and Type	Method and Description
static void	clearCache()
java.sql.Connection	connect(java.lang.String driverProtocol, HostSpec hostSpec, java.util.Properties props, boolean isInitialConnection, JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc) Establishes a connection to the given host using the given driver protocol and properties.
protected java.sql.Connection	connectInternal(HostSpec hostSpec, java.util.Properties props, JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc)
java.sql.Connection	forceConnect(java.lang.String driverProtocol, HostSpec hostSpec, java.util.Properties props, boolean isInitialConnection, JdbcCallable<java.sql.Connection,java.sql.SQLException> forceConnectFunc) Establishes a connection to the given host using the given driver protocol and properties.
java.util.Set<java.lang.String>	getSubscribedMethods()

Methods inherited from class software.amazon.jdbc.plugin.AbstractConnectionPlugin

acceptsStrategy, execute, getHostSpecByStrategy, getHostSpecByStrategy, getSnapshotState, initHostProvider, notifyConnectionChanged, notifyNodeListChanged

Methods inherited from class java.lang.Object

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

Field Detail

IAM_REGION_NAME

protected static final java.lang.String IAM_REGION_NAME

See Also:

Constant Field Values

servicesContainer

protected final FullServicesContainer servicesContainer

pluginService

protected final PluginService pluginService

credentialsProviderFactory

protected final CredentialsProviderFactory credentialsProviderFactory

rdsUtils

protected final RdsUtils rdsUtils

samlUtils

protected final SamlUtils samlUtils

telemetryFactory

protected final TelemetryFactory telemetryFactory

regionUtils

protected RegionUtils regionUtils

cacheSizeGauge

protected @Nullable TelemetryGauge cacheSizeGauge

fetchTokenCounter

protected @Nullable TelemetryCounter fetchTokenCounter

Method Detail

getSubscribedMethods

public java.util.Set<java.lang.String> getSubscribedMethods()

Specified by:

getSubscribedMethods in interface ConnectionPlugin

Specified by:

getSubscribedMethods in class AbstractConnectionPlugin

connect

public java.sql.Connection connect(java.lang.String driverProtocol,
                                   HostSpec hostSpec,
                                   java.util.Properties props,
                                   boolean isInitialConnection,
                                   JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc)
                            throws java.sql.SQLException

Description copied from interface: ConnectionPlugin

Establishes a connection to the given host using the given driver protocol and properties. If a non-default ConnectionProvider has been set with Driver.setCustomConnectionProvider(ConnectionProvider) and ConnectionProvider.acceptsUrl(String, HostSpec, Properties) returns true for the given 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 ConnectionPlugin

Overrides:

connect in class AbstractConnectionPlugin

Parameters:

driverProtocol - the driver protocol that should be used to establish the connection

hostSpec - the host details for the desired connection

props - the connection properties

isInitialConnection - a boolean indicating whether the current Connection is establishing an initial physical connection to the database or has already established a physical connection in the past

connectFunc - the function to call to continue the connect request down the connect pipeline

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(java.lang.String driverProtocol,
                                        HostSpec hostSpec,
                                        java.util.Properties props,
                                        boolean isInitialConnection,
                                        JdbcCallable<java.sql.Connection,java.sql.SQLException> forceConnectFunc)
                                 throws java.sql.SQLException

Description copied from interface: ConnectionPlugin

Establishes a connection to the given host using the given driver protocol and 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 ConnectionPlugin

Overrides:

forceConnect in class AbstractConnectionPlugin

Parameters:

driverProtocol - the driver protocol that should be used to establish the connection

hostSpec - the host details for the desired connection

props - the connection properties

isInitialConnection - a boolean indicating whether the current Connection is establishing an initial physical connection to the database or has already established a physical connection in the past

forceConnectFunc - the function to call to continue the forceConnect request down the forceConnect pipeline

Returns:

a Connection to the requested host

Throws:

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

connectInternal

protected java.sql.Connection connectInternal(HostSpec hostSpec,
                                              java.util.Properties props,
                                              JdbcCallable<java.sql.Connection,java.sql.SQLException> connectFunc)
                                       throws java.sql.SQLException

Throws:

java.sql.SQLException

clearCache

public static void clearCache()