Package io.micronaut.jms.sqs.configuration

Class SqsConfiguration

java.lang.Object

io.micronaut.jms.sqs.configuration.SqsConfiguration

@Factory
@Requires(property="micronaut.jms.sqs.enabled",
          value="true")
public class SqsConfiguration
extends Object

Generates the AWS SQS JMSConnectionFactory based on the properties provided by SqsConfigurationProperties.

Since:

1.0.0

Author:

Burt Beckwith

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECTION_FACTORY_BEAN_NAME	Name of the SQS ConnectionFactory bean.

Constructor Summary

Constructors

Constructor	Description
SqsConfiguration()

Method Summary

Modifier and Type	Method	Description
jakarta.jms.ConnectionFactory	sqsJmsConnectionFactory(SqsConfigurationProperties config, software.amazon.awssdk.services.sqs.SqsClient sqs)	Generates a JMSConnectionFactory bean in the application context.
jakarta.jms.ConnectionFactory	sqsJmsConnectionFactory(SqsConfigurationProperties config, software.amazon.awssdk.services.sqs.SqsClientBuilder builder)	Generates a JMSConnectionFactory bean in the application context.

Methods inherited from class java.lang.Object

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

Field Details

CONNECTION_FACTORY_BEAN_NAME

public static final String CONNECTION_FACTORY_BEAN_NAME

Name of the SQS ConnectionFactory bean.

See Also:

• Constant Field Values

Constructor Details

SqsConfiguration

public SqsConfiguration()

Method Details

sqsJmsConnectionFactory

@JMSConnectionFactory("sqsJmsConnectionFactory")
public jakarta.jms.ConnectionFactory sqsJmsConnectionFactory(SqsConfigurationProperties config,
 software.amazon.awssdk.services.sqs.SqsClient sqs)

Generates a JMSConnectionFactory bean in the application context.

The bean is a SQSConnectionFactory configured with properties from SqsConfigurationProperties.

Parameters:

config - config settings for SQS

sqs - a configured SqsClient instance, typically built with SqsClientBuilder.

Returns:

the SQSConnectionFactory defined by the config.

sqsJmsConnectionFactory

@JMSConnectionFactory("sqsJmsConnectionFactory")
public jakarta.jms.ConnectionFactory sqsJmsConnectionFactory(SqsConfigurationProperties config,
 software.amazon.awssdk.services.sqs.SqsClientBuilder builder)

Generates a JMSConnectionFactory bean in the application context.

The bean is a SQSConnectionFactory configured with properties from SqsConfigurationProperties.

Parameters:

config - config settings for SQS

builder - a configured SqsClientBuilder.

Returns:

the SQSConnectionFactory defined by the config.