io.micronaut.aws.sdk.v2.service

Class AwsClientFactory<SB extends software.amazon.awssdk.awscore.client.builder.AwsSyncClientBuilder<SB,SC> & software.amazon.awssdk.awscore.client.builder.AwsClientBuilder<SB,SC>,AB extends software.amazon.awssdk.awscore.client.builder.AwsAsyncClientBuilder<AB,AC> & software.amazon.awssdk.awscore.client.builder.AwsClientBuilder<AB,AC>,SC,AC extends software.amazon.awssdk.core.SdkClient>

java.lang.Object

io.micronaut.aws.sdk.v2.service.AwsClientFactory<SB,AB,SC,AC>

Type Parameters:

SB - The sync builder

AB - The async builder

SC - The sync client

AC - The async client

Direct Known Subclasses:

DynamoDbClientFactory, S3ClientFactory, SecretsManagerClientFactory, ServiceDiscoveryAsyncClientFactory, SesClientFactory, SnsClientFactory, SqsClientFactory, SsmClientFactory

public abstract class AwsClientFactory<SB extends software.amazon.awssdk.awscore.client.builder.AwsSyncClientBuilder<SB,SC> & software.amazon.awssdk.awscore.client.builder.AwsClientBuilder<SB,SC>,AB extends software.amazon.awssdk.awscore.client.builder.AwsAsyncClientBuilder<AB,AC> & software.amazon.awssdk.awscore.client.builder.AwsClientBuilder<AB,AC>,SC,AC extends software.amazon.awssdk.core.SdkClient>
extends java.lang.Object

Abstract class that eases creation of AWS client factories.

Since:

2.0.0

Author:

Álvaro Sánchez-Mariscal

Field Summary

Fields

Modifier and Type	Field and Description
protected software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain	credentialsProvider
protected software.amazon.awssdk.regions.providers.AwsRegionProviderChain	regionProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AwsClientFactory(software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider, software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider) Constructor.

Method Summary

Modifier and Type	Method and Description
AB	asyncBuilder(software.amazon.awssdk.http.async.SdkAsyncHttpClient httpClient) Configures the builder so that it uses the appropriate HTTP client, credentials and region providers.
AC	asyncClient(AB builder) Creates the async client.
protected abstract AB	createAsyncBuilder() Implementations need to create the builder, eg: S3AsyncClient.builder();.
protected abstract SB	createSyncBuilder() Implementations need to create the builder, eg: S3Client.builder();.
SB	syncBuilder(software.amazon.awssdk.http.SdkHttpClient httpClient) Configures the builder so that it uses the appropriate HTTP client, credentials and region providers.
SC	syncClient(SB builder) Creates the sync client.

Methods inherited from class java.lang.Object

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

Field Detail

credentialsProvider

protected final software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider

regionProvider

protected final software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider

Constructor Detail

AwsClientFactory

protected AwsClientFactory(software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider,
                           software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider)

Constructor.

Parameters:

credentialsProvider - The credentials provider

regionProvider - The region provider

Method Detail

syncBuilder

public SB syncBuilder(software.amazon.awssdk.http.SdkHttpClient httpClient)

Configures the builder so that it uses the appropriate HTTP client, credentials and region providers. Subclasses may want to override this method and annotate it with @Singleton.

Parameters:

httpClient - The sync HTTP client

Returns:

The sync builder

syncClient

public SC syncClient(SB builder)

Creates the sync client. It requires a bean of type SB.

Parameters:

builder - The sync builder

Returns:

The sync AWS client

See Also:

syncBuilder(SdkHttpClient)

asyncBuilder

public AB asyncBuilder(software.amazon.awssdk.http.async.SdkAsyncHttpClient httpClient)

Configures the builder so that it uses the appropriate HTTP client, credentials and region providers. Subclasses may want to override this method and annotate it with @Singleton.

Parameters:

httpClient - The async HTTP client

Returns:

The async builder

asyncClient

public AC asyncClient(AB builder)

Creates the async client. It requires a bean of type AB.

Parameters:

builder - The async builder

Returns:

The async AWS client

createSyncBuilder

protected abstract SB createSyncBuilder()

Implementations need to create the builder, eg: S3Client.builder();.

Returns:

The sync builder

createAsyncBuilder

protected abstract AB createAsyncBuilder()

Implementations need to create the builder, eg: S3AsyncClient.builder();.

Returns:

The async builder