com.amazon.sqs.javamessaging

Class SQSConnectionFactory

java.lang.Object

com.amazon.sqs.javamessaging.SQSConnectionFactory

All Implemented Interfaces:

javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory

public class SQSConnectionFactory
extends Object
implements javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory

A ConnectionFactory object encapsulates a set of connection configuration parameters for AmazonSQSClient as well as setting numberOfMessagesToPrefetch.

The numberOfMessagesToPrefetch parameter is used to size of the prefetched messages, which can be tuned based on the application workload. It helps in returning messages from internal buffers(if there is any) instead of waiting for the SQS receiveMessage call to return.

If more physical connections than the default maximum value (that is 50 as of today) are needed on the connection pool, ClientConfiguration needs to be configured.

None of the createConnection methods set-up the physical connection to SQS, so validity of credentials are not checked with those methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQSConnectionFactory.Builder Deprecated.

Constructor Summary

Constructors

Constructor and Description
SQSConnectionFactory(ProviderConfiguration providerConfiguration)
SQSConnectionFactory(ProviderConfiguration providerConfiguration, com.amazonaws.services.sqs.AmazonSQS client)
SQSConnectionFactory(ProviderConfiguration providerConfiguration, com.amazonaws.services.sqs.AmazonSQSClientBuilder clientBuilder)

Method Summary

Modifier and Type	Method and Description
static SQSConnectionFactory.Builder	builder() Deprecated.
SQSConnection	createConnection()
SQSConnection	createConnection(com.amazonaws.auth.AWSCredentials awsCredentials)
SQSConnection	createConnection(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)
SQSConnection	createConnection(String awsAccessKeyId, String awsSecretKey)
javax.jms.QueueConnection	createQueueConnection()
javax.jms.QueueConnection	createQueueConnection(String userName, String password)

Methods inherited from class java.lang.Object

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

Constructor Detail

SQSConnectionFactory

public SQSConnectionFactory(ProviderConfiguration providerConfiguration)

SQSConnectionFactory

public SQSConnectionFactory(ProviderConfiguration providerConfiguration,
                            com.amazonaws.services.sqs.AmazonSQS client)

SQSConnectionFactory

public SQSConnectionFactory(ProviderConfiguration providerConfiguration,
                            com.amazonaws.services.sqs.AmazonSQSClientBuilder clientBuilder)

Method Detail

createConnection

public SQSConnection createConnection()
                               throws javax.jms.JMSException

Specified by:

createConnection in interface javax.jms.ConnectionFactory

Throws:

javax.jms.JMSException

createConnection

public SQSConnection createConnection(String awsAccessKeyId,
                                      String awsSecretKey)
                               throws javax.jms.JMSException

Specified by:

createConnection in interface javax.jms.ConnectionFactory

Throws:

javax.jms.JMSException

createConnection

public SQSConnection createConnection(com.amazonaws.auth.AWSCredentials awsCredentials)
                               throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createConnection

public SQSConnection createConnection(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)
                               throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createQueueConnection

public javax.jms.QueueConnection createQueueConnection()
                                                throws javax.jms.JMSException

Specified by:

createQueueConnection in interface javax.jms.QueueConnectionFactory

Throws:

javax.jms.JMSException

createQueueConnection

public javax.jms.QueueConnection createQueueConnection(String userName,
                                                       String password)
                                                throws javax.jms.JMSException

Specified by:

createQueueConnection in interface javax.jms.QueueConnectionFactory

Throws:

javax.jms.JMSException

builder

@Deprecated
public static SQSConnectionFactory.Builder builder()

Deprecated.

Deprecated. Use one of the constructors of this class instead and provide either AmazonSQS client or AmazonSQSClientBuilder.

Returns: