io.micronaut.aws.sdk.v2.service.s3

Class S3ClientFactory

java.lang.Object

io.micronaut.aws.sdk.v2.service.AwsClientFactory<software.amazon.awssdk.services.s3.S3ClientBuilder,software.amazon.awssdk.services.s3.S3AsyncClientBuilder,software.amazon.awssdk.services.s3.S3Client,software.amazon.awssdk.services.s3.S3AsyncClient>

io.micronaut.aws.sdk.v2.service.s3.S3ClientFactory

@Factory
public class S3ClientFactory
extends AwsClientFactory<software.amazon.awssdk.services.s3.S3ClientBuilder,software.amazon.awssdk.services.s3.S3AsyncClientBuilder,software.amazon.awssdk.services.s3.S3Client,software.amazon.awssdk.services.s3.S3AsyncClient>

Factory that creates an S3 client.

Since:

2.0.0

Author:

Álvaro Sánchez-Mariscal

Field Summary

Fields inherited from class io.micronaut.aws.sdk.v2.service.AwsClientFactory

credentialsProvider, regionProvider

Constructor Summary

Constructors

Constructor and Description
S3ClientFactory(software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider, software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider, S3ConfigurationProperties configuration) Constructor.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ClientFactory

public S3ClientFactory(software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider,
                       software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider,
                       S3ConfigurationProperties configuration)

Constructor.

Parameters:

credentialsProvider - The credentials provider

regionProvider - The region provider

configuration - The service configuration

Method Detail

createSyncBuilder

protected software.amazon.awssdk.services.s3.S3ClientBuilder createSyncBuilder()

Description copied from class: AwsClientFactory

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

Specified by:

createSyncBuilder in class AwsClientFactory<software.amazon.awssdk.services.s3.S3ClientBuilder,software.amazon.awssdk.services.s3.S3AsyncClientBuilder,software.amazon.awssdk.services.s3.S3Client,software.amazon.awssdk.services.s3.S3AsyncClient>

Returns:

The sync builder

createAsyncBuilder

protected software.amazon.awssdk.services.s3.S3AsyncClientBuilder createAsyncBuilder()

Description copied from class: AwsClientFactory

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

Specified by:

createAsyncBuilder in class AwsClientFactory<software.amazon.awssdk.services.s3.S3ClientBuilder,software.amazon.awssdk.services.s3.S3AsyncClientBuilder,software.amazon.awssdk.services.s3.S3Client,software.amazon.awssdk.services.s3.S3AsyncClient>

Returns:

The async builder

syncBuilder

@Singleton
public software.amazon.awssdk.services.s3.S3ClientBuilder syncBuilder(software.amazon.awssdk.http.SdkHttpClient httpClient)

Description copied from class: AwsClientFactory

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.

Overrides:

syncBuilder in class AwsClientFactory<software.amazon.awssdk.services.s3.S3ClientBuilder,software.amazon.awssdk.services.s3.S3AsyncClientBuilder,software.amazon.awssdk.services.s3.S3Client,software.amazon.awssdk.services.s3.S3AsyncClient>

Parameters:

httpClient - The sync HTTP client

Returns:

The sync builder

syncClient

@Bean(preDestroy="close")
 @Singleton
public software.amazon.awssdk.services.s3.S3Client syncClient(software.amazon.awssdk.services.s3.S3ClientBuilder builder)

Description copied from class: AwsClientFactory

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

Overrides:

syncClient in class AwsClientFactory<software.amazon.awssdk.services.s3.S3ClientBuilder,software.amazon.awssdk.services.s3.S3AsyncClientBuilder,software.amazon.awssdk.services.s3.S3Client,software.amazon.awssdk.services.s3.S3AsyncClient>

Parameters:

builder - The sync builder

Returns:

The sync AWS client

See Also:

AwsClientFactory.syncBuilder(SdkHttpClient)

asyncBuilder

@Singleton
 @Requires(beans=software.amazon.awssdk.http.async.SdkAsyncHttpClient.class)
public software.amazon.awssdk.services.s3.S3AsyncClientBuilder asyncBuilder(software.amazon.awssdk.http.async.SdkAsyncHttpClient httpClient)

Description copied from class: AwsClientFactory

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.

Overrides:

asyncBuilder in class AwsClientFactory<software.amazon.awssdk.services.s3.S3ClientBuilder,software.amazon.awssdk.services.s3.S3AsyncClientBuilder,software.amazon.awssdk.services.s3.S3Client,software.amazon.awssdk.services.s3.S3AsyncClient>

Parameters:

httpClient - The async HTTP client

Returns:

The async builder

asyncClient

@Bean(preDestroy="close")
 @Singleton
 @Requires(beans=software.amazon.awssdk.http.async.SdkAsyncHttpClient.class)
public software.amazon.awssdk.services.s3.S3AsyncClient asyncClient(software.amazon.awssdk.services.s3.S3AsyncClientBuilder builder)

Description copied from class: AwsClientFactory

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

Overrides:

asyncClient in class AwsClientFactory<software.amazon.awssdk.services.s3.S3ClientBuilder,software.amazon.awssdk.services.s3.S3AsyncClientBuilder,software.amazon.awssdk.services.s3.S3Client,software.amazon.awssdk.services.s3.S3AsyncClient>

Parameters:

builder - The async builder

Returns:

The async AWS client