software.aws.mcs.auth

Class SigV4AuthProvider

java.lang.Object

software.aws.mcs.auth.SigV4AuthProvider

All Implemented Interfaces:

com.datastax.oss.driver.api.core.auth.AuthProvider, AutoCloseable

public class SigV4AuthProvider
extends Object
implements com.datastax.oss.driver.api.core.auth.AuthProvider

This auth provider can be used with the Amazon MCS service to authenticate with SigV4. It uses the AWSCredentialsProvider interface provided by the official AWS Java SDK to provide credentials for signing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SigV4AuthProvider.SigV4Authenticator This authenticator performs SigV4 MCS authentication.

Constructor Summary

Constructors

Constructor and Description
SigV4AuthProvider() Create a new Provider, using the DefaultAWSCredentialsProviderChain as its credentials provider.
SigV4AuthProvider(@NotNull software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider, String region) Create a new Provider, using the specified AWSCredentialsProvider and region.
SigV4AuthProvider(com.datastax.oss.driver.api.core.context.DriverContext driverContext) This constructor is provided so that the driver can create instances of this class based on configuration.
SigV4AuthProvider(String region) Create a new Provider, using the specified region.

Method Summary

Modifier and Type	Method and Description
void	close()
com.datastax.oss.driver.api.core.auth.Authenticator	newAuthenticator(com.datastax.oss.driver.api.core.metadata.EndPoint endPoint, String authenticator)
void	onMissingChallenge(com.datastax.oss.driver.api.core.metadata.EndPoint endPoint)

Methods inherited from class java.lang.Object

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

Constructor Detail

SigV4AuthProvider

public SigV4AuthProvider()

Create a new Provider, using the DefaultAWSCredentialsProviderChain as its credentials provider. The signing region is taking from the AWS_DEFAULT_REGION environment variable or the "aws.region" system property.

SigV4AuthProvider

public SigV4AuthProvider(com.datastax.oss.driver.api.core.context.DriverContext driverContext)

This constructor is provided so that the driver can create instances of this class based on configuration. For example:

 datastax-java-driver.advanced.auth-provider = {
     aws-region = us-east-2
     class = software.aws.mcs.auth.SigV4AuthProvider
 }
 

The signing region is taken from the datastax-java-driver.advanced.auth-provider.aws-region property, from the "aws.region" system property, or the AWS_DEFAULT_REGION environment variable, in that order of preference. For programmatic construction, use SigV4AuthProvider() or SigV4AuthProvider(AwsCredentialsProvider, String).

Parameters:

driverContext - the driver context for instance creation. Unused for this plugin.

SigV4AuthProvider

public SigV4AuthProvider(String region)

Create a new Provider, using the specified region.

Parameters:

region - the region (e.g. us-east-1) to use for signing. A null value indicates to use the AWS_REGION environment variable, or the "aws.region" system property to configure it.

SigV4AuthProvider

public SigV4AuthProvider(@NotNull
                         @NotNull software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider,
                         String region)

Create a new Provider, using the specified AWSCredentialsProvider and region.

Parameters:

credentialsProvider - the credentials provider used to obtain signature material

region - the region (e.g. us-east-1) to use for signing. A null value indicates to use the AWS_REGION environment variable, or the "aws.region" system property to configure it.

Method Detail

newAuthenticator

public com.datastax.oss.driver.api.core.auth.Authenticator newAuthenticator(com.datastax.oss.driver.api.core.metadata.EndPoint endPoint,
                                                                            String authenticator)
                                                                     throws com.datastax.oss.driver.api.core.auth.AuthenticationException

Specified by:

newAuthenticator in interface com.datastax.oss.driver.api.core.auth.AuthProvider

Throws:

com.datastax.oss.driver.api.core.auth.AuthenticationException

onMissingChallenge

public void onMissingChallenge(com.datastax.oss.driver.api.core.metadata.EndPoint endPoint)

Specified by:

onMissingChallenge in interface com.datastax.oss.driver.api.core.auth.AuthProvider

close

public void close()

Specified by:

close in interface AutoCloseable