Payara Community Documentation

Currently Viewing Skip version selector. Download Enterprise Documentation

Payara Platform
Edit this Page

Amazon SQS Versioning

The SQS connector’s behavior and features are affected by the exact version of the Amazon Web Services Java SDK version being planned to use. For each version, there are separate versions of the connector’s JCA adapter and its API.

The tags below are for the Cloud Connectors repository. You should use the one corresponding to the SQS and Jakarta version you require.

0.8.0

Amazon SQS Version 1 using JakartaEE 8 and the javax namespace

AmazonSQS-1.1.0

Amazon SQS Version 2 using JakartaEE 8 and the javax namespace

AmazonSQS-2.1.0

Amazon SQS Version 2 using JakartaEE 10 and the jakarta namespace

Amazon SQS Connector Version 1

This is the first version of the connector that is based on Amazon Web Services Java SDK v1.

Usage

The amazon-sqs-rar-0.8.0.rar JCA adapter has to be deployed as shown in the Installing a connector section of the Cloud Connectors overview.

Additionally, to use the connector API add the following Maven dependencies to your application’s project:

<dependency>
  <groupId>fish.payara.cloud.connectors.amazonsqs</groupId>
  <artifactId>amazon-sqs-jca-api</artifactId>
  <version>[,1.0.0)</version>
  <type>jar</type>
  <scope>provided</scope>
</dependency>

<dependency>
  <groupId>com.amazonaws</groupId>
  <artifactId>aws-java-sdk-sqs</artifactId>
  <version>[1.11.118,)</version>
  <type>jar</type>
  <scope>provided</scope>
</dependency>
These dependencies have a provided scope since the types within this dependency are globally available to every application deployed to Payara Micro after the amazon-sqs-rar-0.8.0.rar has been deployed.

Amazon SQS Connector Version 2

This is the second version of the connector that is based on Amazon Web Services SDK v2.

If you have selected to use SQS Connector 2.1.0, replace all occurunces of 1.0.0 with 2.1.0 for the following example.

Usage

git clone git@github.com:payara/Cloud-Connectors.git
cd Cloud-Connectors/
git checkout tags/AmazonSQS-2.1.0
mvn clean install

The connector’s RAR artifact can be found in the following location:

./AmazonSQS/AmazonSQSRAR/target/amazon-sqs-rar-2.1.0.rar

Additionally, to use the connector API add the following Maven dependencies to your application’s project:

<dependency>
    <groupId>fish.payara.cloud.connectors.amazonsqs</groupId>
    <artifactId>amazon-sqs-jca-api</artifactId>
    <version>2.1.0</version>
    <type>jar</type>
    <scope>provided</scope>
</dependency>

<dependency>
    <groupId>software.amazon.awssdk</groupId>
    <artifactId>sqs</artifactId>
    <version>[2.25.6,)</version>
    <type>jar</type>
    <scope>provided</scope>
</dependency>
The amazon-sqs-jca-api artifact has to be installed to your local Maven repository first.