https://github.com/mvallim/amazon-sns-java-messaging-lib
The Amazon SNS Java Messaging Library holds the compatible classes, that are used for communicating with Amazon Simple Notification Service. This project builds on top of the AWS SDK for Java to use Amazon SNS provider for the messaging applications without running any additional software.
https://github.com/mvallim/amazon-sns-java-messaging-lib
amazon amazon-sns amazon-web-services aws aws-sns aws-sns-topic batch java kotlin producer robust sns topic
Last synced: 28 days ago
JSON representation
The Amazon SNS Java Messaging Library holds the compatible classes, that are used for communicating with Amazon Simple Notification Service. This project builds on top of the AWS SDK for Java to use Amazon SNS provider for the messaging applications without running any additional software.
- Host: GitHub
- URL: https://github.com/mvallim/amazon-sns-java-messaging-lib
- Owner: mvallim
- License: apache-2.0
- Created: 2022-11-17T06:28:37.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-10-27T13:13:39.000Z (4 months ago)
- Last Synced: 2026-01-14T04:51:15.949Z (about 1 month ago)
- Topics: amazon, amazon-sns, amazon-web-services, aws, aws-sns, aws-sns-topic, batch, java, kotlin, producer, robust, sns, topic
- Language: Java
- Homepage: https://mvallim.github.io/amazon-sns-java-messaging-lib/
- Size: 575 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Amazon SNS Java Messaging Lib
[](https://github.com/mvallim/amazon-sns-java-messaging-lib/actions/workflows/cd-snapshot.yml)
[](https://sonarcloud.io/dashboard?id=amazon-sns-java-messaging-lib)
[](https://sonarcloud.io/dashboard?id=amazon-sns-java-messaging-lib)
[](https://img.shields.io/maven-central/v/com.github.mvallim/amazon-sns-java-messaging-lib)
[](http://www.apache.org/licenses/LICENSE-2.0)
The Amazon SNS Java Messaging Library holds the compatible classes, that are used for communicating with Amazon Simple Notification Service. This project builds on top of the AWS SDK for Java to use Amazon SNS provider for the messaging applications without running any additional software.
> The batch size should be chosen based on the size of individual messages and available network bandwidth as well as the observed latency and throughput improvements based on the real life load. These are configured to some sensible defaults assuming smaller message sizes and the optimal batch size for server side processing.
# Request Batch
Combine multiple requests to optimally utilise the network.
Article [Martin Fowler](https://martinfowler.com) [Request Batch](https://martinfowler.com/articles/patterns-of-distributed-systems/request-batch.html)
_**Compatible JDK 8, 11, 17 and 21**_
_**Compatible AWS JDK v1 >= 1.12**_
_**Compatible AWS JDK v2 >= 2.18**_
This library supports **`Kotlin`** aswell
# 1. Quick Start
## 1.1 Prerequisite
In order to use Amazon SNS Java Messaging Lib within a Maven project, simply add the following dependency to your pom.xml. There are no other dependencies for Amazon SNS Java Messaging Lib, which means other unwanted libraries will not overwhelm your project.
You can pull it from the central Maven repositories:
### For AWS SDK v1
```xml
com.github.mvallim
amazon-sns-java-messaging-lib-v1
1.1.0
```
### For AWS SDK v2
```xml
com.github.mvallim
amazon-sns-java-messaging-lib-v2
1.1.0
```
If you want to try a snapshot version, add the following repository:
```xml
sonatype-snapshots
Sonatype Snapshots
https://central.sonatype.com/repository/maven-snapshots
true
```
#### Gradle
### For AWS SDK v1
```groovy
implementation 'com.github.mvallim:amazon-sns-java-messaging-lib-v1:1.1.0'
```
### For AWS SDK v2
```groovy
implementation 'com.github.mvallim:amazon-sns-java-messaging-lib-v2:1.1.0'
```
If you want to try a snapshot version, add the following repository:
```groovy
repositories {
maven {
url "https://central.sonatype.com/repository/maven-snapshots"
}
}
```
## 1.2 Usage
### Properties `TopicProperty`
| Property | Type | Description |
|-----------------------|-------------|--------------------------------------------------------------------------------|
| **`fifo`** | **boolean** | refers if SNS is fifo or not. |
| **`maximumPoolSize`** | **int** | refers maximum threads for producer. |
| **`topicArn`** | **string** | refers topic arn name. |
| **`linger`** | **int** | refers to the time to wait before sending messages out to SNS. |
| **`maxBatchSize`** | **int** | refers to the maximum amount of data to be collected before sending the batch. |
**NOTICE**: the buffer of message store in memory is calculate using **`maximumPoolSize`** * **`maxBatchSize`** huge values demand huge memory.
#### Determining the type of `BlockingQueue` with its maximum capacity
```java
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(false)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate snsTemplate = new AmazonSnsTemplate<>(
amazonSNS, topicProperty, new LinkedBlockingQueue<>(100));
```
#### Using an `ObjectMapper` other than the default
```java
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(false)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate snsTemplate = new AmazonSnsTemplate<>(
amazonSNS, topicProperty, new ObjectMapper<>());
```
#### Using an `ObjectMapper` and a `BlockingQueue` other than the default
```java
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(false)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate snsTemplate = new AmazonSnsTemplate<>(
amazonSNS, topicProperty, new LinkedBlockingQueue<>(100), new ObjectMapper<>());
```
### Standard SNS
```java
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(false)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.build();
snsTemplate.send(requestEntry);
```
### FIFO SNS
```java
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(true)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.withGroupId(UUID.randomUUID().toString())
.withDeduplicationId(UUID.randomUUID().toString())
.build();
snsTemplate.send(requestEntry);
```
### Send With Callback
```java
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(true)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.withGroupId(UUID.randomUUID().toString())
.withDeduplicationId(UUID.randomUUID().toString())
.build();
snsTemplate.send(requestEntry).addCallback(result -> {
successCallback -> LOGGER.info("{}", successCallback),
failureCallback -> LOGGER.error("{}", failureCallback)
});
snsTemplate.send(requestEntry).addCallback(result -> {
successCallback -> LOGGER.info("{}", successCallback)
});
```
### Send And Wait
```java
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(true)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.withGroupId(UUID.randomUUID().toString())
.withDeduplicationId(UUID.randomUUID().toString())
.build();
snsTemplate.send(requestEntry).addCallback(result -> {
successCallback -> LOGGER.info("{}", successCallback),
failureCallback -> LOGGER.error("{}", failureCallback)
});
snsTemplate.await().join();
```
### Send And Shutdown
```java
final TopicProperty topicProperty = TopicProperty.builder()
.fifo(true)
.linger(100)
.maxBatchSize(10)
.maximumPoolSize(20)
.topicArn("arn:aws:sns:us-east-2:000000000000:topic")
.build();
final AmazonSnsTemplate snsTemplate = new AmazonSnsTemplate<>(amazonSNS, topicProperty);
final RequestEntry requestEntry = RequestEntry.builder()
.withValue(new MyMessage())
.withMessageHeaders(Map.of())
.withGroupId(UUID.randomUUID().toString())
.withDeduplicationId(UUID.randomUUID().toString())
.build();
snsTemplate.send(requestEntry).addCallback(result -> {
successCallback -> LOGGER.info("{}", successCallback),
failureCallback -> LOGGER.error("{}", failureCallback)
});
snsTemplate.shutdown();
```
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [GitHub](https://github.com/mvallim/amazon-sns-java-messaging-lib) for versioning. For the versions available, see the [tags on this repository](https://github.com/mvallim/amazon-sns-java-messaging-lib/tags).
## Authors
* **Marcos Vallim** - *Founder, Author, Development, Test, Documentation* - [mvallim](https://github.com/mvallim)
See also the list of [contributors](CONTRIBUTORS.txt) who participated in this project.
## License
This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details