io.micronaut.aws.sdk.v2.service.sqs

Class SqsClientFactory

java.lang.Object

io.micronaut.aws.sdk.v2.service.AwsClientFactory<software.amazon.awssdk.services.sqs.SqsClientBuilder,software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder,software.amazon.awssdk.services.sqs.SqsClient,software.amazon.awssdk.services.sqs.SqsAsyncClient>

io.micronaut.aws.sdk.v2.service.sqs.SqsClientFactory

@Factory
public class SqsClientFactory
extends AwsClientFactory<software.amazon.awssdk.services.sqs.SqsClientBuilder,software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder,software.amazon.awssdk.services.sqs.SqsClient,software.amazon.awssdk.services.sqs.SqsAsyncClient>

Factory that creates a SQS client.

Since:

2.0.0

Author:

Álvaro Sánchez-Mariscal

Field Summary

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

configuration, credentialsProvider, regionProvider, userAgentProvider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SqsClientFactory(software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider, software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider) Deprecated. Use SqsClientFactory(AwsCredentialsProviderChain,AwsRegionProviderChain,UserAgentProvider, AWSServiceConfiguration) instead.
protected	SqsClientFactory(software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider, software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider, UserAgentProvider userAgentProvider) Deprecated. Use SqsClientFactory(AwsCredentialsProviderChain,AwsRegionProviderChain,UserAgentProvider, AWSServiceConfiguration) instead.
protected	SqsClientFactory(software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider, software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider, UserAgentProvider userAgentProvider, AWSServiceConfiguration awsServiceConfiguration) Constructor.

Method Summary

Modifier and Type	Method and Description
software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder	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.sqs.SqsAsyncClient	asyncClient(software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder builder) Creates the async client.
protected software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder	createAsyncBuilder() Implementations need to create the builder, eg: S3AsyncClient.builder();.
protected software.amazon.awssdk.services.sqs.SqsClientBuilder	createSyncBuilder() Implementations need to create the builder, eg: S3Client.builder();.
software.amazon.awssdk.services.sqs.SqsClientBuilder	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.sqs.SqsClient	syncClient(software.amazon.awssdk.services.sqs.SqsClientBuilder 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

SqsClientFactory

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

Deprecated. Use SqsClientFactory(AwsCredentialsProviderChain,AwsRegionProviderChain,UserAgentProvider, AWSServiceConfiguration) instead.

Constructor.

Parameters:

credentialsProvider - The credentials provider

regionProvider - The region provider

SqsClientFactory

@Deprecated
protected SqsClientFactory(software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider,
                                       software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider,
                                       @Nullable
                                       UserAgentProvider userAgentProvider)

Deprecated. Use SqsClientFactory(AwsCredentialsProviderChain,AwsRegionProviderChain,UserAgentProvider, AWSServiceConfiguration) instead.

Constructor.

Parameters:

credentialsProvider - The credentials provider

regionProvider - The region provider

userAgentProvider - User-Agent Provider

SqsClientFactory

@Inject
protected SqsClientFactory(software.amazon.awssdk.auth.credentials.AwsCredentialsProviderChain credentialsProvider,
                                   software.amazon.awssdk.regions.providers.AwsRegionProviderChain regionProvider,
                                   @Nullable
                                   UserAgentProvider userAgentProvider,
                                   @Nullable @Named(value="sqs")
                                   AWSServiceConfiguration awsServiceConfiguration)

Constructor.

Parameters:

credentialsProvider - The credentials provider

regionProvider - The region provider

userAgentProvider - User-Agent Provider

awsServiceConfiguration - AWS Service Configuration

Method Detail

createSyncBuilder

protected software.amazon.awssdk.services.sqs.SqsClientBuilder 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.sqs.SqsClientBuilder,software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder,software.amazon.awssdk.services.sqs.SqsClient,software.amazon.awssdk.services.sqs.SqsAsyncClient>

Returns:

The sync builder

createAsyncBuilder

protected software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder 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.sqs.SqsClientBuilder,software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder,software.amazon.awssdk.services.sqs.SqsClient,software.amazon.awssdk.services.sqs.SqsAsyncClient>

Returns:

The async builder

syncBuilder

@Singleton
public software.amazon.awssdk.services.sqs.SqsClientBuilder 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.sqs.SqsClientBuilder,software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder,software.amazon.awssdk.services.sqs.SqsClient,software.amazon.awssdk.services.sqs.SqsAsyncClient>

Parameters:

httpClient - The sync HTTP client

Returns:

The sync builder

syncClient

@Bean(preDestroy="close")
 @Singleton
public software.amazon.awssdk.services.sqs.SqsClient syncClient(software.amazon.awssdk.services.sqs.SqsClientBuilder 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.sqs.SqsClientBuilder,software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder,software.amazon.awssdk.services.sqs.SqsClient,software.amazon.awssdk.services.sqs.SqsAsyncClient>

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.sqs.SqsAsyncClientBuilder 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.sqs.SqsClientBuilder,software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder,software.amazon.awssdk.services.sqs.SqsClient,software.amazon.awssdk.services.sqs.SqsAsyncClient>

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.sqs.SqsAsyncClient asyncClient(software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder 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.sqs.SqsClientBuilder,software.amazon.awssdk.services.sqs.SqsAsyncClientBuilder,software.amazon.awssdk.services.sqs.SqsClient,software.amazon.awssdk.services.sqs.SqsAsyncClient>

Parameters:

builder - The async builder

Returns:

The async AWS client