com.amazon.sqs.javamessaging.SQSConnectionFactory Maven / Gradle / Ivy
Show all versions of amazon-sqs-java-messaging-lib Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazon.sqs.javamessaging;
import javax.jms.ConnectionFactory;
import javax.jms.JMSException;
import javax.jms.JMSSecurityException;
import javax.jms.QueueConnection;
import javax.jms.QueueConnectionFactory;
import com.amazonaws.ClientConfiguration;
import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.auth.AWSCredentialsProvider;
import com.amazonaws.auth.BasicAWSCredentials;
import com.amazonaws.auth.DefaultAWSCredentialsProviderChain;
import com.amazonaws.regions.Region;
import com.amazonaws.regions.Regions;
import com.amazonaws.services.sqs.AmazonSQSClient;
/**
* 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,
* {@link com.amazonaws.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.
*/
public class SQSConnectionFactory implements ConnectionFactory, QueueConnectionFactory {
private final ClientConfiguration clientConfig;
private final Region region;
private final String endpoint;
private final String signerRegionOverride;
private final AWSCredentialsProvider awsCredentialsProvider;
/** Controls the size of the prefetch buffers used by consumers. */
private final int numberOfMessagesToPrefetch;
private SQSConnectionFactory(Builder builder) {
this.region = builder.region;
this.endpoint = builder.endpoint;
this.signerRegionOverride = builder.signerRegionOverride;
this.clientConfig = builder.clientConfiguration;
this.awsCredentialsProvider = builder.awsCredentialsProvider;
this.numberOfMessagesToPrefetch = builder.numberOfMessagesToPrefetch;
}
@Override
public SQSConnection createConnection() throws JMSException {
if (awsCredentialsProvider == null) {
throw new JMSSecurityException("AWS credentials cannot be null");
}
return createConnection(awsCredentialsProvider);
}
@Override
public SQSConnection createConnection(String awsAccessKeyId, String awsSecretKey) throws JMSException {
BasicAWSCredentials basicAWSCredentials = new BasicAWSCredentials(awsAccessKeyId, awsSecretKey);
return createConnection(basicAWSCredentials);
}
public SQSConnection createConnection(AWSCredentials awsCredentials) throws JMSException {
AmazonSQSClient amazonSQSClient = new AmazonSQSClient(awsCredentials, clientConfig);
configureClient(amazonSQSClient);
AmazonSQSMessagingClientWrapper amazonSQSClientJMSWrapper = new AmazonSQSMessagingClientWrapper(amazonSQSClient);
return new SQSConnection(amazonSQSClientJMSWrapper, numberOfMessagesToPrefetch);
}
public SQSConnection createConnection(AWSCredentialsProvider awsCredentialsProvider) throws JMSException {
AmazonSQSClient amazonSQSClient = new AmazonSQSClient(awsCredentialsProvider, clientConfig);
configureClient(amazonSQSClient);
AmazonSQSMessagingClientWrapper amazonSQSClientJMSWrapper = new AmazonSQSMessagingClientWrapper(amazonSQSClient);
return new SQSConnection(amazonSQSClientJMSWrapper, numberOfMessagesToPrefetch);
}
@Override
public QueueConnection createQueueConnection() throws JMSException {
return (QueueConnection) createConnection();
}
@Override
public QueueConnection createQueueConnection(String userName, String password) throws JMSException {
return (QueueConnection) createConnection(userName, password);
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Region region;
private String endpoint;
private String signerRegionOverride;
private ClientConfiguration clientConfiguration;
private int numberOfMessagesToPrefetch;
private AWSCredentialsProvider awsCredentialsProvider = new DefaultAWSCredentialsProviderChain();
public Builder(Region region) {
this();
this.region = region;
}
/** Recommended way to set the AmazonSQSClient is to use region */
public Builder(String region) {
this(Region.getRegion(Regions.fromName(region)));
}
public Builder() {
clientConfiguration = new ClientConfiguration();
clientConfiguration.setUserAgent(
clientConfiguration.getUserAgent() + SQSMessagingClientConstants.APPENDED_USER_AGENT_HEADER_VERSION );
// Set default numberOfMessagesToPrefetch to MIN_BATCH.
this.numberOfMessagesToPrefetch = SQSMessagingClientConstants.MIN_BATCH;
}
public Builder withRegion(Region region) {
setRegion(region);
return this;
}
public Builder withRegionName(String regionName)
throws IllegalArgumentException
{
setRegion(Region.getRegion( Regions.fromName(regionName) ) );
return this;
}
public Builder withEndpoint(String endpoint) {
setEndpoint(endpoint);
return this;
}
/**
* An internal method used to explicitly override the internal signer region
* computed by the default implementation. This method is not expected to be
* normally called except for AWS internal development purposes.
*/
public Builder withSignerRegionOverride(String signerRegionOverride) {
setSignerRegionOverride(signerRegionOverride);
return this;
}
public Builder withAWSCredentialsProvider(AWSCredentialsProvider awsCredentialsProvider) {
setAwsCredentialsProvider(awsCredentialsProvider);
return this;
}
public Builder withClientConfiguration(ClientConfiguration clientConfig) {
setClientConfiguration(clientConfig);
return this;
}
public Builder withNumberOfMessagesToPrefetch(int numberOfMessagesToPrefetch) {
setNumberOfMessagesToPrefetch(numberOfMessagesToPrefetch);
return this;
}
public SQSConnectionFactory build() {
return new SQSConnectionFactory(this);
}
public Region getRegion() {
return region;
}
public void setRegion(Region region) {
this.region = region;
this.endpoint = null;
}
public void setRegionName(String regionName) {
setRegion( Region.getRegion( Regions.fromName( regionName ) ) );
}
public String getEndpoint() {
return endpoint;
}
public void setEndpoint(String endpoint) {
this.endpoint = endpoint;
this.region = null;
}
public String getSignerRegionOverride() {
return signerRegionOverride;
}
public void setSignerRegionOverride(String signerRegionOverride) {
this.signerRegionOverride = signerRegionOverride;
}
public ClientConfiguration getClientConfiguration() {
return clientConfiguration;
}
public void setClientConfiguration(ClientConfiguration clientConfig) {
clientConfiguration = new ClientConfiguration( clientConfig );
if( clientConfig.getUserAgent() == null || clientConfig.getUserAgent().isEmpty() ) {
clientConfig.setUserAgent( ClientConfiguration.DEFAULT_USER_AGENT );
}
clientConfiguration.setUserAgent(
clientConfig.getUserAgent() + SQSMessagingClientConstants.APPENDED_USER_AGENT_HEADER_VERSION );
}
public int getNumberOfMessagesToPrefetch() {
return numberOfMessagesToPrefetch;
}
public void setNumberOfMessagesToPrefetch(int numberOfMessagesToPrefetch) {
if (numberOfMessagesToPrefetch <= 0 ) {
throw new IllegalArgumentException("Invalid prefetch size.");
}
this.numberOfMessagesToPrefetch = numberOfMessagesToPrefetch;
}
public AWSCredentialsProvider getAwsCredentialsProvider() {
return awsCredentialsProvider;
}
public void setAwsCredentialsProvider(
AWSCredentialsProvider awsCredentialsProvider) {
this.awsCredentialsProvider = awsCredentialsProvider;
}
}
private void configureClient(AmazonSQSClient client) throws JMSException {
try {
if( region != null ) {
client.setRegion(region);
}
if( endpoint != null ) {
client.setEndpoint(endpoint);
}
if( signerRegionOverride != null ) {
client.setSignerRegionOverride(signerRegionOverride);
}
} catch( IllegalArgumentException e ) {
throw (JMSException)
new JMSException( "Bad endpoint configuration: " + e.getMessage() ).initCause(e);
}
}
}