software.amazon.jdbc.plugin.federatedauth

Class FederatedAuthPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.federatedauth.FederatedAuthPlugin

All Implemented Interfaces:

ConnectionPlugin

public class FederatedAuthPlugin
extends AbstractConnectionPlugin

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	DB_USER
static AwsWrapperProperty	HTTP_CLIENT_CONNECT_TIMEOUT
static AwsWrapperProperty	HTTP_CLIENT_SOCKET_TIMEOUT
static AwsWrapperProperty	IAM_DEFAULT_PORT
static AwsWrapperProperty	IAM_HOST
static AwsWrapperProperty	IAM_IDP_ARN
static AwsWrapperProperty	IAM_REGION
static AwsWrapperProperty	IAM_ROLE_ARN
static AwsWrapperProperty	IAM_TOKEN_EXPIRATION
static AwsWrapperProperty	IDP_ENDPOINT
static AwsWrapperProperty	IDP_NAME
static AwsWrapperProperty	IDP_PASSWORD
static AwsWrapperProperty	IDP_PORT
static AwsWrapperProperty	IDP_USERNAME
protected PluginService	pluginService
protected RdsUtils	rdsUtils
protected static RegionUtils	regionUtils
static AwsWrapperProperty	RELAYING_PARTY_ID
protected static java.util.regex.Pattern	SAML_RESPONSE_PATTERN
protected static java.lang.String	SAML_RESPONSE_PATTERN_GROUP
protected SamlUtils	samlUtils
static AwsWrapperProperty	SSL_INSECURE

Constructor Summary

Constructors

Constructor and Description
FederatedAuthPlugin(PluginService pluginService, CredentialsProviderFactory credentialsProviderFactory)

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.
java.sql.Connection	forceConnect(@NonNull java.lang.String driverProtocol, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props, boolean isInitialConnection, @NonNull 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, initHostProvider, notifyConnectionChanged, notifyNodeListChanged

Methods inherited from class java.lang.Object

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

Field Detail

IDP_ENDPOINT

public static final AwsWrapperProperty IDP_ENDPOINT

IDP_PORT

public static final AwsWrapperProperty IDP_PORT

RELAYING_PARTY_ID

public static final AwsWrapperProperty RELAYING_PARTY_ID

IAM_ROLE_ARN

public static final AwsWrapperProperty IAM_ROLE_ARN

IAM_IDP_ARN

public static final AwsWrapperProperty IAM_IDP_ARN

IAM_REGION

public static final AwsWrapperProperty IAM_REGION

IAM_TOKEN_EXPIRATION

public static final AwsWrapperProperty IAM_TOKEN_EXPIRATION

IDP_USERNAME

public static final AwsWrapperProperty IDP_USERNAME

IDP_PASSWORD

public static final AwsWrapperProperty IDP_PASSWORD

IAM_HOST

public static final AwsWrapperProperty IAM_HOST

IAM_DEFAULT_PORT

public static final AwsWrapperProperty IAM_DEFAULT_PORT

HTTP_CLIENT_SOCKET_TIMEOUT

public static final AwsWrapperProperty HTTP_CLIENT_SOCKET_TIMEOUT

HTTP_CLIENT_CONNECT_TIMEOUT

public static final AwsWrapperProperty HTTP_CLIENT_CONNECT_TIMEOUT

SSL_INSECURE

public static final AwsWrapperProperty SSL_INSECURE

IDP_NAME

public static AwsWrapperProperty IDP_NAME

DB_USER

public static final AwsWrapperProperty DB_USER

SAML_RESPONSE_PATTERN

protected static final java.util.regex.Pattern SAML_RESPONSE_PATTERN

SAML_RESPONSE_PATTERN_GROUP

protected static final java.lang.String SAML_RESPONSE_PATTERN_GROUP

See Also:

Constant Field Values

regionUtils

protected static final RegionUtils regionUtils

pluginService

protected final PluginService pluginService

rdsUtils

protected final RdsUtils rdsUtils

samlUtils

protected final SamlUtils samlUtils

Constructor Detail

FederatedAuthPlugin

public FederatedAuthPlugin(PluginService pluginService,
                           CredentialsProviderFactory credentialsProviderFactory)

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(@NonNull java.lang.String driverProtocol,
                                        @NonNull HostSpec hostSpec,
                                        @NonNull java.util.Properties props,
                                        boolean isInitialConnection,
                                        @NonNull 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

clearCache

public static void clearCache()