software.amazon.jdbc.authentication

Class LoginCredentialsProviderFactory

java.lang.Object

software.amazon.jdbc.authentication.LoginCredentialsProviderFactory

public class LoginCredentialsProviderFactory
extends java.lang.Object

Builds an AwsCredentialsProvider for AWS profiles that authenticate via a login_session entry (the AWS Sign-In / browser-login credential flow).

The AWS SDK resolves login_session credentials through a LoginCredentialsProvider whose region is carried by an internally constructed SigninClient. When that provider is built through the profile-credentials factory (i.e. through DefaultCredentialsProvider), the SigninClient region is resolved via the SDK's DefaultAwsRegionProviderChain, which ignores the configured AWS profile and falls back to the default profile. This factory instead constructs the provider with a SigninClient scoped to the region that the driver already resolved for the connection, so the configured profile is honored.

The software.amazon.awssdk:signin module is optional and is therefore accessed purely via reflection. This class only reaches the reflective code path when the connected profile actually declares a login_session entry.

Constructor Summary

Constructors

Constructor and Description
LoginCredentialsProviderFactory()

Method Summary

Modifier and Type	Method and Description
static @Nullable software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	create(@Nullable java.lang.String awsProfileName, @Nullable software.amazon.awssdk.regions.Region region) Attempts to build a login-session credentials provider for the given profile.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginCredentialsProviderFactory

public LoginCredentialsProviderFactory()

Method Detail

create

public static @Nullable software.amazon.awssdk.auth.credentials.AwsCredentialsProvider create(@Nullable java.lang.String awsProfileName,
                                                                                              @Nullable software.amazon.awssdk.regions.Region region)

Attempts to build a login-session credentials provider for the given profile.

Parameters:

awsProfileName - the configured AWS profile name, or null/empty to use the default profile.

region - the region resolved for the connection, used to scope the signin exchange.

Returns:

a login-session credentials provider, or null if the profile does not use a login_session entry (in which case the caller should fall back to the standard credentials provider).

Throws:

java.lang.RuntimeException - if the profile uses a login_session entry but the login flow cannot be set up (signin module missing, region unknown, or reflective construction failed).