Package com.adaptris.aws.sqs.jms

Class AdvancedSQSImplementation

java.lang.Object

com.adaptris.core.jms.VendorImplementationImp

com.adaptris.aws.sqs.jms.AmazonSQSImplementation

com.adaptris.aws.sqs.jms.AdvancedSQSImplementation

All Implemented Interfaces:

com.adaptris.aws.AWSCredentialsProviderBuilder.BuilderConfig, ComponentLifecycleExtension, ConnectionComparator<VendorImplementationBase>, VendorImplementation, VendorImplementationBase

public class AdvancedSQSImplementation
extends AmazonSQSImplementation

JMS VendorImplementation for Amazon SQS.

This VendorImplementation uses the Amazon SQS JMS compatibility layer. When using this class, do not use the AmazonSQS Producer and Consumer classes. Use regular JMS consumers and producers instead.

The key from the client-configuration-properties element should match the name of the underlying ClientConfiguration property. So if you wanted to control the user-agent you would configure

 
   <client-configuration-properties>
     <key-value-pair>
        <key>UserAgent</key>
        <value>My User Agent</value>
     </key-value-pair>
   </client-configuration-properties>
 
 

Since:

3.2.1

In the adapter configuration file this class is aliased as advanced-amazon-sqs-implementation which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.jms.VendorImplementationImp

log

Constructor Summary

Constructors

Constructor	Description
AdvancedSQSImplementation()

Method Summary

Modifier and Type	Method	Description
KeyValuePairSet	clientConfiguration()
com.adaptris.aws.EndpointBuilder	endpointBuilder()
@NonNull KeyValuePairSet	getClientConfigurationProperties()	Any other properties you wish to set on the client.
com.adaptris.aws.CustomEndpoint	getCustomEndpoint()	Set a custom endpoint for this connection.
com.adaptris.aws.RetryPolicyFactory	getRetryPolicy()	The retry policy if required.
com.adaptris.aws.RetryPolicyFactory	retryPolicy()
void	setClientConfigurationProperties(@NonNull KeyValuePairSet clientConfigurationProperties)	Any other properties you wish to set on the client.
void	setCustomEndpoint(com.adaptris.aws.CustomEndpoint customEndpoint)	Set a custom endpoint for this connection.
void	setRetryPolicy(com.adaptris.aws.RetryPolicyFactory retryPolicy)	The retry policy if required.
AdvancedSQSImplementation	withCustomEndpoint(com.adaptris.aws.CustomEndpoint endpoint)

Methods inherited from class com.adaptris.aws.sqs.jms.AmazonSQSImplementation

build, buildClientConfiguration, connectionEquals, createConnectionFactory, credentialsProvider, getCredentials, getPrefetchCount, getRegion, getSqsClientFactory, newProviderConfiguration, prefetchCount, setCredentials, setPrefetchCount, setRegion, setSqsClientFactory, withClientFactory, withCredentialsProviderBuilder

Methods inherited from class com.adaptris.core.jms.VendorImplementationImp

applyVendorSessionProperties, createConsumer, createDestination, createQueue, createQueueReceiver, createSession, createTopic, createTopicSubscriber, prepare, retrieveBrokerDetailsForLogging

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.jms.VendorImplementation

createConnection

Constructor Details

AdvancedSQSImplementation

public AdvancedSQSImplementation()

Method Details

clientConfiguration

public KeyValuePairSet clientConfiguration()

Specified by:

clientConfiguration in interface com.adaptris.aws.AWSCredentialsProviderBuilder.BuilderConfig

Overrides:

clientConfiguration in class AmazonSQSImplementation

endpointBuilder

public com.adaptris.aws.EndpointBuilder endpointBuilder()

Specified by:

endpointBuilder in interface com.adaptris.aws.AWSCredentialsProviderBuilder.BuilderConfig

Overrides:

endpointBuilder in class AmazonSQSImplementation

withCustomEndpoint

public AdvancedSQSImplementation withCustomEndpoint(com.adaptris.aws.CustomEndpoint endpoint)

retryPolicy

public com.adaptris.aws.RetryPolicyFactory retryPolicy()

Specified by:

retryPolicy in interface com.adaptris.aws.AWSCredentialsProviderBuilder.BuilderConfig

Overrides:

retryPolicy in class AmazonSQSImplementation

getClientConfigurationProperties

@NonNull
public @NonNull KeyValuePairSet getClientConfigurationProperties()

Any other properties you wish to set on the client.

See Also:

• ClientConfigurationBuilder

setClientConfigurationProperties

public void setClientConfigurationProperties(@NonNull
 @NonNull KeyValuePairSet clientConfigurationProperties)

Any other properties you wish to set on the client.

See Also:

• ClientConfigurationBuilder

getRetryPolicy

public com.adaptris.aws.RetryPolicyFactory getRetryPolicy()

The retry policy if required.

setRetryPolicy

public void setRetryPolicy(com.adaptris.aws.RetryPolicyFactory retryPolicy)

The retry policy if required.

getCustomEndpoint

public com.adaptris.aws.CustomEndpoint getCustomEndpoint()

Set a custom endpoint for this connection.

Generally speaking, you don't need to configure this; use AmazonSQSImplementation.setRegion(String) instead. This is only required if you are planning to use a non-standard service endpoint such as localstack to provide AWS services. Explicitly configuring this means that your AmazonSQSImplementation.setRegion(String) will have no effect (i.e. AwsClientBuilder#setRegion(String) will never be invoked.

setCustomEndpoint

public void setCustomEndpoint(com.adaptris.aws.CustomEndpoint customEndpoint)

Set a custom endpoint for this connection.

Generally speaking, you don't need to configure this; use AmazonSQSImplementation.setRegion(String) instead. This is only required if you are planning to use a non-standard service endpoint such as localstack to provide AWS services. Explicitly configuring this means that your AmazonSQSImplementation.setRegion(String) will have no effect (i.e. AwsClientBuilder#setRegion(String) will never be invoked.