software.amazon.jdbc.plugin

Class AwsSecretsManagerConnectionPlugin

java.lang.Object

software.amazon.jdbc.plugin.AbstractConnectionPlugin

software.amazon.jdbc.plugin.AwsSecretsManagerConnectionPlugin

All Implemented Interfaces:

ConnectionPlugin, StateSnapshotProvider

Direct Known Subclasses:

AwsSecretsManagerConnectionPlugin2

public class AwsSecretsManagerConnectionPlugin
extends AbstractConnectionPlugin

Field Summary

Fields

Modifier and Type	Field and Description
static AwsWrapperProperty	ENDPOINT_PROPERTY
protected @Nullable TelemetryCounter	fetchCredentialsCounter
protected PluginService	pluginService
static AwsWrapperProperty	REGION_PROPERTY
protected static RegionUtils	regionUtils
protected @Nullable software.amazon.jdbc.plugin.AwsSecretsManagerConnectionPlugin.Secret	secret
static AwsWrapperProperty	SECRET_ID_PROPERTY
protected long	secretExpirationTime
static AwsWrapperProperty	SECRETS_MANAGER_EXPIRATION_SEC_PROPERTY
static AwsWrapperProperty	SECRETS_MANAGER_SECRET_PASSWORD_PROPERTY
static AwsWrapperProperty	SECRETS_MANAGER_SECRET_USERNAME_PROPERTY
protected FullServicesContainer	servicesContainer
protected static java.lang.String	TELEMETRY_UPDATE_SECRETS

Constructor Summary

Constructors

Constructor and Description
AwsSecretsManagerConnectionPlugin(FullServicesContainer servicesContainer, java.util.Properties props)

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 software.amazon.jdbc.plugin.AwsSecretsManagerConnectionPlugin.Secret	fetchAndStoreSecret(HostSpec hostSpec) Fetches the latest credentials from the AWS Secrets Manager service and stores them in the shared cache.
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()
protected long	resolveSecretExpirationTime(long configuredExpirationTime) Resolves the effective credentials' expiration time (in seconds) from the configured value.
protected boolean	updateSecret(HostSpec hostSpec, boolean forceReFetch) Called to update credentials from the cache, or from the AWS Secrets Manager service.

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

TELEMETRY_UPDATE_SECRETS

protected static final java.lang.String TELEMETRY_UPDATE_SECRETS

See Also:

Constant Field Values

SECRET_ID_PROPERTY

public static final AwsWrapperProperty SECRET_ID_PROPERTY

REGION_PROPERTY

public static final AwsWrapperProperty REGION_PROPERTY

ENDPOINT_PROPERTY

public static final AwsWrapperProperty ENDPOINT_PROPERTY

SECRETS_MANAGER_SECRET_USERNAME_PROPERTY

public static final AwsWrapperProperty SECRETS_MANAGER_SECRET_USERNAME_PROPERTY

SECRETS_MANAGER_SECRET_PASSWORD_PROPERTY

public static final AwsWrapperProperty SECRETS_MANAGER_SECRET_PASSWORD_PROPERTY

SECRETS_MANAGER_EXPIRATION_SEC_PROPERTY

public static final AwsWrapperProperty SECRETS_MANAGER_EXPIRATION_SEC_PROPERTY

regionUtils

protected static final RegionUtils regionUtils

secret

protected @Nullable software.amazon.jdbc.plugin.AwsSecretsManagerConnectionPlugin.Secret secret

secretExpirationTime

protected final long secretExpirationTime

pluginService

protected final PluginService pluginService

servicesContainer

protected final FullServicesContainer servicesContainer

fetchCredentialsCounter

protected final @Nullable TelemetryCounter fetchCredentialsCounter

Constructor Detail

AwsSecretsManagerConnectionPlugin

public AwsSecretsManagerConnectionPlugin(FullServicesContainer servicesContainer,
                                         java.util.Properties props)

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

resolveSecretExpirationTime

protected long resolveSecretExpirationTime(long configuredExpirationTime)

Resolves the effective credentials' expiration time (in seconds) from the configured value. Subclasses may override to enforce constraints (e.g. a minimum value).

Parameters:

configuredExpirationTime - the value configured via secretsManagerExpirationTimeSec.

Returns:

the expiration time to use.

updateSecret

protected boolean updateSecret(HostSpec hostSpec,
                               boolean forceReFetch)
                        throws java.sql.SQLException

Called to update credentials from the cache, or from the AWS Secrets Manager service.

Parameters:

forceReFetch - Allows ignoring cached credentials and force fetches the latest credentials from the service.

Returns:

true, if credentials were fetched from the service.

Throws:

java.sql.SQLException

fetchAndStoreSecret

protected software.amazon.jdbc.plugin.AwsSecretsManagerConnectionPlugin.Secret fetchAndStoreSecret(HostSpec hostSpec)
                                                                                            throws java.sql.SQLException

Fetches the latest credentials from the AWS Secrets Manager service and stores them in the shared cache. Service-specific exceptions are translated into a SQLException (or RuntimeException for a misconfigured endpoint), preserving the original error handling.

Parameters:

hostSpec - A HostSpec instance containing host information for the current connection.

Returns:

the freshly fetched Secret, or null if none was returned.

Throws:

java.sql.SQLException - if the credentials could not be fetched.

clearCache

public static void clearCache()