Getting Started

Version 2.x (AWS Java SDKv2)

  <dependency>    <groupId>software.amazon.sns</groupId>    <artifactId>sns-extended-client</artifactId>    <version>2.1.0</version>    <type>jar</type>  </dependency>

Version 1.x (AWS Java SDKv1)

  <dependency>    <groupId>software.amazon.sns</groupId>    <artifactId>sns-extended-client</artifactId>    <version>1.1.2</version>    <type>jar</type>  </dependency>

S3 Message Storage Configuration

Publishing messages to SNS topics and receiving them from SQS subscribers

importcom.amazon.sqs.javamessaging.AmazonSQSExtendedClient;importcom.amazon.sqs.javamessaging.ExtendedClientConfiguration;importsoftware.amazon.awssdk.regions.Region;importsoftware.amazon.awssdk.services.s3.S3Client;importsoftware.amazon.awssdk.services.s3.model.CreateBucketRequest;importsoftware.amazon.awssdk.services.sns.SnsClient;importsoftware.amazon.awssdk.services.sns.model.CreateTopicRequest;importsoftware.amazon.awssdk.services.sns.model.PublishRequest;importsoftware.amazon.awssdk.services.sns.model.SetSubscriptionAttributesRequest;importsoftware.amazon.awssdk.services.sns.model.SubscribeRequest;importsoftware.amazon.awssdk.services.sqs.SqsClient;importsoftware.amazon.awssdk.services.sqs.model.CreateQueueRequest;importsoftware.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;importsoftware.amazon.awssdk.services.sqs.model.ReceiveMessageResponse;importsoftware.amazon.sns.AmazonSNSExtendedClient;importsoftware.amazon.sns.SNSExtendedClientConfiguration;publicclassExample {publicstaticvoidmain(String[]args) {finalStringBUCKET_NAME ="extended-client-bucket";finalStringTOPIC_NAME ="extended-client-topic";finalStringQUEUE_NAME ="extended-client-queue";finalRegionregion =Region.US_WEST_2;//Message threshold controls the maximum message size that will be allowed to be published//through SNS using the extended client. Payload of messages exceeding this value will be stored in//S3. The default value of this parameter is 256 KB which is the maximum message size in SNS (and SQS).finalintEXTENDED_STORAGE_MESSAGE_SIZE_THRESHOLD =32;//Initialize SNS, SQS and S3 clientsfinalSnsClientsnsClient =SnsClient.builder().region(region).build();finalSqsClientsqsClient =SqsClient.builder().region(region).build();finalS3Clients3Client =S3Client.builder().region(region).build();//Create bucket, topic, queue and subscriptions3Client.createBucket(CreateBucketRequest.builder().bucket(BUCKET_NAME).build());finalStringtopicArn =snsClient.createTopic(CreateTopicRequest.builder().name(TOPIC_NAME).build()        ).topicArn();finalStringqueueUrl =sqsClient.createQueue(CreateQueueRequest.builder().queueName(QUEUE_NAME).build()        ).queueUrl();finalStringsubscriptionArn =snsClient.subscribe(SubscribeRequest.builder().topicArn(topicArn).endpoint(queueUrl).build()        ).subscriptionArn();//To read message content stored in S3 transparently through SQS extended client,//set the RawMessageDelivery subscription attribute to TRUEfinalSetSubscriptionAttributesRequestsubscriptionAttributesRequest =SetSubscriptionAttributesRequest.builder()            .subscriptionArn(subscriptionArn)            .attributeName("RawMessageDelivery")            .attributeValue("TRUE")            .build();snsClient.setSubscriptionAttributes(subscriptionAttributesRequest);//Initialize SNS extended client//PayloadSizeThreshold triggers message content storage in S3 when the threshold is exceeded//To store all messages content in S3, use AlwaysThroughS3 flagfinalSNSExtendedClientConfigurationsnsExtendedClientConfiguration =newSNSExtendedClientConfiguration()            .withPayloadSupportEnabled(s3Client,BUCKET_NAME)            .withPayloadSizeThreshold(EXTENDED_STORAGE_MESSAGE_SIZE_THRESHOLD);finalAmazonSNSExtendedClientsnsExtendedClient =newAmazonSNSExtendedClient(snsClient,snsExtendedClientConfiguration);//Publish message via SNS with storage in S3finalStringmessage ="This message is stored in S3 as it exceeds the threshold of 32 bytes set above.";snsExtendedClient.publish(PublishRequest.builder().topicArn(topicArn).message(message).build());//Initialize SQS extended clientfinalExtendedClientConfigurationsqsExtendedClientConfiguration =newExtendedClientConfiguration()            .withPayloadSupportEnabled(s3Client,BUCKET_NAME);finalAmazonSQSExtendedClientsqsExtendedClient =newAmazonSQSExtendedClient(sqsClient,sqsExtendedClientConfiguration);//Read the message from the queuefinalReceiveMessageResponseresponse =sqsExtendedClient.receiveMessage(ReceiveMessageRequest.builder().queueUrl(queueUrl).build());System.out.println("Received message is " +response.messages().get(0).body());    }}

Aug 12, 2020 12:42:31 PM software.amazon.payloadoffloading.PayloadStorageConfiguration setPayloadSupportEnabledINFO: Payload support enabled.Aug 12, 2020 12:42:32 PM software.amazon.payloadoffloading.S3BackedPayloadStore storeOriginalPayloadINFO: S3 object created, Bucket name: extended-client-bucket, Object key: 09900296-35fc-4927-91f6-768ecf8dafa4.Aug 12, 2020 12:42:32 PM software.amazon.payloadoffloading.PayloadStorageConfiguration setPayloadSupportEnabledINFO: Payload support enabled.Received message is This message is stored in S3. This message is stored in S3.

Releases

Contribution

License