Amazon SNS Client
Amazon Simple Notification Service (SNS) is a highly available and fully managed pub/sub messaging service. It provides topics for high-throughput, push-based, many-to-many messaging. Messages can fan out to a large number of subscriber endpoints for parallel processing, including Amazon SQS queues, AWS Lambda functions, and HTTP/S webhooks. Additionally, SNS can be used to fan out notifications to end users using mobile push, SMS and email.
You can find more information about SNS at the Amazon SNS website.
The SNS extension is based on AWS Java SDK 2.x. It’s a major rewrite of the 1.x code base that offers two programming models (Blocking & Async). |
The Quarkus extension supports two programming models:
-
Blocking access using URL Connection HTTP client (by default) or the Apache HTTP Client
-
Asynchronous programming based on JDK’s
CompletableFuture
objects and the Netty HTTP client.
In this guide, we see how you can get your REST services to use SNS locally and on AWS.
Prerequisites
To complete this guide, you need:
-
JDK 11+ installed with
JAVA_HOME
configured appropriately -
an IDE
-
Apache Maven 3.8.1+
-
An AWS Account to access the SNS service
-
Optionally, Docker for your system to run SNS locally for testing purposes
Provision SNS locally via Dev Services
The easiest way to start working with SNS is to run a local instance using Dev Services.
Provision SNS locally manually
You can also set up a local version of SNS manually, first start a LocalStack container:
docker run -it --publish 4566:4575 -e SERVICES=sns -e START_WEB=0 localstack/localstack:1.0.3
This starts a SNS instance that is accessible on port 4566
.
Create an AWS profile for your local instance using AWS CLI:
$ aws configure --profile localstack
AWS Access Key ID [None]: test-key
AWS Secret Access Key [None]: test-secret
Default region name [None]: us-east-1
Default output format [None]: text
Create a SNS topic
Create a SNS topic using AWS CLI and store in TOPIC_ARN
environment variable
TOPIC_ARN=`aws sns create-topic --name=QuarksCollider --profile localstack --endpoint-url=http://localhost:4566`
If you are using LocalStack, some additional configuration is needed:
Otherwise your service will not receive the notifications. |
If you want to run the demo using SNS on your AWS account, you can create a topic using AWS default profile
TOPIC_ARN=`aws sns create-topic --name=QuarksCollider`
Solution
The application built here allows to shoot elementary particles (quarks) into a QuarksCollider
topic of the AWS SNS.
Additionally, we create a resource that allows to subscribe to the QuarksCollider
topic in order to receive published quarks.
We recommend that you follow the instructions in the next sections and create the application step by step. However, you can go right to the completed example.
Clone the Git repository: git clone https://github.com/quarkusio/quarkus-quickstarts.git
, or download an archive.
The solution is located in the amazon-sns-quickstart
directory.
Creating the Maven project
First, we need a new project. Create a new project with the following command:
mvn io.quarkus.platform:quarkus-maven-plugin:2.16.9.Final:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=amazon-sns-quickstart \
-DclassName="org.acme.sns.QuarksCannonSyncResource" \
-Dpath="/sync-cannon" \
-Dextensions="resteasy-reactive-jackson,amazon-sns"
cd amazon-sns-quickstart
This command generates a Maven structure importing the RESTEasy Reactive/JAX-RS and Amazon SNS Client extensions.
After this, the amazon-sns
extension has been added to your pom.xml
as well as the Mutiny support for RESTEasy.
Creating JSON REST service
In this example, we will create an application that allows to publish quarks. The example application will demonstrate the two programming models supported by the extension.
First, let’s create the Quark
bean as follows:
package org.acme.sns.model;
import io.quarkus.runtime.annotations.RegisterForReflection;
import java.util.Objects;
@RegisterForReflection
public class Quark {
private String flavor;
private String spin;
public Quark() {
}
public String getFlavor() {
return flavor;
}
public void setFlavor(String flavor) {
this.flavor = flavor;
}
public String getSpin() {
return spin;
}
public void setSpin(String spin) {
this.spin = spin;
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof Quark)) {
return false;
}
Quark other = (Quark) obj;
return Objects.equals(other.flavor, this.flavor);
}
@Override
public int hashCode() {
return Objects.hash(this.flavor);
}
}
Then, create a org.acme.sns.QuarksCannonSyncResource
that will provide an API to shoot quarks into the SNS topic via the SNS synchronous client.
The @RegisterForReflection annotation instructs Quarkus to keep the class and its members during the native compilation. More details about the @RegisterForReflection annotation can be found on the native application tips page.
|
package org.acme.sns;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectWriter;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.acme.sns.model.Quark;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;
import software.amazon.awssdk.services.sns.SnsClient;
import software.amazon.awssdk.services.sns.model.PublishResponse;
@Path("/sync/cannon")
@Produces(MediaType.TEXT_PLAIN)
public class QuarksCannonSyncResource {
private static final Logger LOGGER = Logger.getLogger(QuarksCannonSyncResource.class);
@Inject
SnsClient sns;
@ConfigProperty(name = "topic.arn")
String topicArn;
static ObjectWriter QUARK_WRITER = new ObjectMapper().writerFor(Quark.class);
@POST
@Path("/shoot")
@Consumes(MediaType.APPLICATION_JSON)
public Response publish(Quark quark) throws Exception {
String message = QUARK_WRITER.writeValueAsString(quark);
PublishResponse response = sns.publish(p -> p.topicArn(topicArn).message(message));
LOGGER.infov("Fired Quark[{0}, {1}}]", quark.getFlavor(), quark.getSpin());
return Response.ok().entity(response.messageId()).build();
}
}
Because of the fact that messages published must be simply a String
we’re using Jackson’s ObjectWriter
in order to serialize our Quark
objects into a String
.
The missing piece is the subscriber that will receive the messages published to our topic. Before implementing subscribers, we need to define POJO classes representing messages posted by the AWS SNS.
Let’s create two classes that represent SNS Notification and SNS Subscription Confirmation messages based on the AWS SNS Message and JSON formats
Create org.acme.sns.model.SnsNotification
class
package org.acme.sns.model;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
@JsonIgnoreProperties(ignoreUnknown = true)
public class SnsNotification {
@JsonProperty("Message")
private String message;
@JsonProperty("MessageId")
private String messageId;
@JsonProperty("Signature")
private String signature;
@JsonProperty("SignatureVersion")
private String signatureVersion;
@JsonProperty("SigningCertURL")
private String signinCertUrl;
@JsonProperty("Subject")
private String subject;
@JsonProperty("Timestamp")
private String timestamp;
@JsonProperty("TopicArn")
private String topicArn;
@JsonProperty("Type")
private String type;
@JsonProperty("UnsubscribeURL")
private String unsubscribeURL;
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public String getMessageId() {
return messageId;
}
public void setMessageId(String messageId) {
this.messageId = messageId;
}
public String getSignature() {
return signature;
}
public void setSignature(String signature) {
this.signature = signature;
}
public String getSignatureVersion() {
return signatureVersion;
}
public void setSignatureVersion(String signatureVersion) {
this.signatureVersion = signatureVersion;
}
public String getSigninCertUrl() {
return signinCertUrl;
}
public void setSigninCertUrl(String signinCertUrl) {
this.signinCertUrl = signinCertUrl;
}
public String getSubject() {
return subject;
}
public void setSubject(String subject) {
this.subject = subject;
}
public String getTimestamp() {
return timestamp;
}
public void setTimestamp(String timestamp) {
this.timestamp = timestamp;
}
public String getTopicArn() {
return topicArn;
}
public void setTopicArn(String topicArn) {
this.topicArn = topicArn;
}
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public String getUnsubscribeURL() {
return unsubscribeURL;
}
public void setUnsubscribeURL(String unsubscribeURL) {
this.unsubscribeURL = unsubscribeURL;
}
}
Then, create org.acme.sns.SnsSubscriptionConfirmation
package org.acme.sns.model;
import com.fasterxml.jackson.annotation.JsonProperty;
public class SnsSubscriptionConfirmation {
@JsonProperty("Message")
private String message;
@JsonProperty("MessageId")
private String messageId;
@JsonProperty("Signature")
private String signature;
@JsonProperty("SignatureVersion")
private String signatureVersion;
@JsonProperty("SigningCertURL")
private String signingCertUrl;
@JsonProperty("SubscribeURL")
private String subscribeUrl;
@JsonProperty("Timestamp")
private String timestamp;
@JsonProperty("Token")
private String token;
@JsonProperty("TopicArn")
private String topicArn;
@JsonProperty("Type")
private String type;
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public String getMessageId() {
return messageId;
}
public void setMessageId(String messageId) {
this.messageId = messageId;
}
public String getSignature() {
return signature;
}
public void setSignature(String signature) {
this.signature = signature;
}
public String getSignatureVersion() {
return signatureVersion;
}
public void setSignatureVersion(String signatureVersion) {
this.signatureVersion = signatureVersion;
}
public String getSigningCertUrl() {
return signingCertUrl;
}
public void setSigningCertUrl(String signingCertUrl) {
this.signingCertUrl = signingCertUrl;
}
public String getSubscribeUrl() {
return subscribeUrl;
}
public void setSubscribeUrl(String subscribeUrl) {
this.subscribeUrl = subscribeUrl;
}
public String getTimestamp() {
return timestamp;
}
public void setTimestamp(String timestamp) {
this.timestamp = timestamp;
}
public String getToken() {
return token;
}
public void setToken(String token) {
this.token = token;
}
public String getTopicArn() {
return topicArn;
}
public void setTopicArn(String topicArn) {
this.topicArn = topicArn;
}
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
}
Now, create org.acme.QuarksShieldSyncResource
REST resources that:
- Allows to subscribe itself to our SNS topic
- Unsubscribe from the SNS topic
- Receive notifications from the subscribed SNS topic
Keep in mind that AWS SNS supports multiple types of subscribers (that is web servers, email addresses, AWS SQS queues, AWS Lambda functions, and many more), but for the sake of the quickstart we will show how to subscribe an HTTP endpoint served by our application. |
package org.acme.sns;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectReader;
import java.util.HashMap;
import java.util.Map;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.acme.sns.model.Quark;
import org.acme.sns.model.SnsNotification;
import org.acme.sns.model.SnsSubscriptionConfirmation;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;
import software.amazon.awssdk.services.sns.SnsClient;
import software.amazon.awssdk.services.sns.model.SubscribeResponse;
@Path("/sync/shield")
public class QuarksShieldSyncResource {
private static final Logger LOGGER = Logger.getLogger(QuarksShieldSyncResource.class);
private static final String NOTIFICATION_TYPE = "Notification";
private static final String SUBSCRIPTION_CONFIRMATION_TYPE = "SubscriptionConfirmation";
private static final String UNSUBSCRIPTION_CONFIRMATION_TYPE = "UnsubscribeConfirmation";
@Inject
SnsClient sns;
@ConfigProperty(name = "topic.arn")
String topicArn;
@ConfigProperty(name = "quarks.shield.base.url")
String quarksShieldBaseUrl;
private volatile String subscriptionArn;
static Map<Class<?>, ObjectReader> READERS = new HashMap<>();
static {
READERS.put(SnsNotification.class, new ObjectMapper().readerFor(SnsNotification.class));
READERS.put(SnsSubscriptionConfirmation.class, new ObjectMapper().readerFor(SnsSubscriptionConfirmation.class));
READERS.put(Quark.class, new ObjectMapper().readerFor(Quark.class));
}
@POST
@Consumes({MediaType.TEXT_PLAIN})
public Response notificationEndpoint(@HeaderParam("x-amz-sns-message-type") String messageType, String message) throws JsonProcessingException {
if (messageType == null) {
return Response.status(400).build();
}
if (messageType.equals(NOTIFICATION_TYPE)) {
SnsNotification notification = readObject(SnsNotification.class, message);
Quark quark = readObject(Quark.class, notification.getMessage());
LOGGER.infov("Quark[{0}, {1}] collision with the shield.", quark.getFlavor(), quark.getSpin());
} else if (messageType.equals(SUBSCRIPTION_CONFIRMATION_TYPE)) {
SnsSubscriptionConfirmation subConf = readObject(SnsSubscriptionConfirmation.class, message);
sns.confirmSubscription(cs -> cs.topicArn(topicArn).token(subConf.getToken()));
LOGGER.info("Subscription confirmed. Ready for quarks collisions.");
} else if (messageType.equals(UNSUBSCRIPTION_CONFIRMATION_TYPE)) {
LOGGER.info("We are unsubscribed");
} else {
return Response.status(400).entity("Unknown messageType").build();
}
return Response.ok().build();
}
@POST
@Path("/subscribe")
public Response subscribe() {
String notificationEndpoint = notificationEndpoint();
SubscribeResponse response = sns.subscribe(s -> s.topicArn(topicArn).protocol("http").endpoint(notificationEndpoint));
subscriptionArn = response.subscriptionArn();
LOGGER.infov("Subscribed Quarks shield <{0}> : {1} ", notificationEndpoint, response.subscriptionArn());
return Response.ok().entity(response.subscriptionArn()).build();
}
@POST
@Path("/unsubscribe")
public Response unsubscribe() {
if (subscriptionArn != null) {
sns.unsubscribe(s -> s.subscriptionArn(subscriptionArn));
LOGGER.infov("Unsubscribed quarks shield for id = {0}", subscriptionArn);
return Response.ok().build();
} else {
LOGGER.info("Not subscribed yet");
return Response.status(400).entity("Not subscribed yet").build();
}
}
private String notificationEndpoint() {
return quarksShieldBaseUrl + "/sync/shield";
}
private <T> T readObject(Class<T> clazz, String message) {
T object = null;
try {
object = READERS.get(clazz).readValue(message);
} catch (JsonProcessingException e) {
LOGGER.errorv("Unable to deserialize message <{0}> to Class <{1}>", message, clazz.getSimpleName());
throw new RuntimeException(e);
}
return object;
}
}
-
subscribe()
endpoint subscribes to our topic by providing the URL to the POST endpoint receiving SNS notification requests. -
unsubscribe()
simply removes our subscription, so any messages published to the topic will not be routed to our endpoint anymore -
notificationEndpoint()
is called by SNS on new message if endpoint is subscribed. See Amazon SNS message and JSON formats for details about the format of the messages SNS can submit.
Configuring SNS clients
Both SNS clients (sync and async) are configurable via the application.properties
file that can be provided in the src/main/resources
directory.
Additionally, you need to add to the classpath a proper implementation of the sync client. By default the extension uses URL connection HTTP client, so
you need to add a URL connection client dependency to the pom.xml
file:
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>url-connection-client</artifactId>
</dependency>
If you want to use Apache HTTP client instead, configure it as follows:
quarkus.sns.sync-client.type=apache
And add the following dependency to the application pom.xml
:
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>apache-client</artifactId>
</dependency>
If you’re going to use a local SNS instance, configure it as follows:
quarkus.sns.endpoint-override=http://localhost:4566
quarkus.sns.aws.region=us-east-1
quarkus.sns.aws.credentials.type=static
quarkus.sns.aws.credentials.static-provider.access-key-id=test-key
quarkus.sns.aws.credentials.static-provider.secret-access-key=test-secret
-
quarkus.sns.aws.region
- It’s required by the client, but since you’re using a local SNS instance you can pick any valid AWS region. -
quarkus.sns.aws.credentials.type
- Setstatic
credentials provider with any values foraccess-key-id
andsecret-access-key
-
quarkus.sns.endpoint-override
- Override the SNS client to use a local instance instead of an AWS service
If you want to work with an AWS account, you’d need to set it with:
quarkus.sns.aws.region=<YOUR_REGION>
quarkus.sns.aws.credentials.type=default
-
quarkus.sns.aws.region
you should set it to the region where you provisioned the SNS table, -
quarkus.sns.aws.credentials.type
- use thedefault
credentials provider chain that looks for credentials in this order:-
Java System Properties -
aws.accessKeyId
andaws.secretAccessKey
-
Environment Variables -
AWS_ACCESS_KEY_ID
andAWS_SECRET_ACCESS_KEY
-
Credential profiles file at the default location (
~/.aws/credentials
) shared by all AWS SDKs and the AWS CLI -
Credentials delivered through the Amazon ECS if the
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI
environment variable is set and the security manager has permission to access the variable, -
Instance profile credentials delivered through the Amazon EC2 metadata service
-
Next steps
Packaging
Packaging your application is as simple as ./mvnw clean package
.
It can be run with java -Dtopic.arn=$TOPIC_ARN -jar target/quarkus-app/quarkus-run.jar
.
With GraalVM installed, you can also create a native executable binary: ./mvnw clean package -Dnative
.
Depending on your system, that will take some time.
Going asynchronous
Thanks to the AWS SDK v2.x used by the Quarkus extension, you can use the asynchronous programming model out of the box.
Create a org.acme.sns.QuarksCannonAsyncResource
REST resource that will be similar to our QuarksCannonSyncResource
but using an asynchronous programming model.
package org.acme.sns;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectWriter;
import io.smallrye.mutiny.Uni;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.acme.sns.model.Quark;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;
import software.amazon.awssdk.services.sns.SnsAsyncClient;
import software.amazon.awssdk.services.sns.model.PublishResponse;
@Path("/async/cannon")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public class QuarksCannonAsyncResource {
private static final Logger LOGGER = Logger.getLogger(QuarksCannonAsyncResource.class);
@Inject
SnsAsyncClient sns;
@ConfigProperty(name = "topic.arn")
String topicArn;
static ObjectWriter QUARK_WRITER = new ObjectMapper().writerFor(Quark.class);
@POST
@Path("/shoot")
@Consumes(MediaType.APPLICATION_JSON)
public Uni<Response> publish(Quark quark) throws Exception {
String message = QUARK_WRITER.writeValueAsString(quark);
return Uni.createFrom()
.completionStage(sns.publish(p -> p.topicArn(topicArn).message(message)))
.onItem().invoke(item -> LOGGER.infov("Fired Quark[{0}, {1}}]", quark.getFlavor(), quark.getSpin()))
.onItem().transform(PublishResponse::messageId)
.onItem().transform(id -> Response.ok().entity(id).build());
}
}
We create Uni
instances from the CompletionStage
objects returned by the asynchronous SNS client, and then transform the emitted item.
And corresponding async subscriber org.acme.sns.QuarksShieldAsyncResource
package org.acme.sns;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectReader;
import io.smallrye.mutiny.Uni;
import java.util.HashMap;
import java.util.Map;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.acme.sns.model.Quark;
import org.acme.sns.model.SnsNotification;
import org.acme.sns.model.SnsSubscriptionConfirmation;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;
import software.amazon.awssdk.services.sns.SnsAsyncClient;
import software.amazon.awssdk.services.sns.model.SubscribeResponse;
@Path("/async/shield")
public class QuarksShieldAsyncResource {
private static final Logger LOGGER = Logger.getLogger(QuarksShieldAsyncResource.class);
private static final String NOTIFICATION_TYPE = "Notification";
private static final String SUBSCRIPTION_CONFIRMATION_TYPE = "SubscriptionConfirmation";
private static final String UNSUBSCRIPTION_CONFIRMATION_TYPE = "UnsubscribeConfirmation";
@Inject
SnsAsyncClient sns;
@ConfigProperty(name = "topic.arn")
String topicArn;
@ConfigProperty(name = "quarks.shield.base.url")
String quarksShieldBaseUrl;
private volatile String subscriptionArn;
static Map<Class<?>, ObjectReader> READERS = new HashMap<>();
static {
READERS.put(SnsNotification.class, new ObjectMapper().readerFor(SnsNotification.class));
READERS.put(SnsSubscriptionConfirmation.class, new ObjectMapper().readerFor(SnsSubscriptionConfirmation.class));
READERS.put(Quark.class, new ObjectMapper().readerFor(Quark.class));
}
@POST
@Consumes({MediaType.TEXT_PLAIN})
public Uni<Response> notificationEndpoint(@HeaderParam("x-amz-sns-message-type") String messageType, String message) {
if (messageType == null) {
return Uni.createFrom().item(Response.status(400).build());
}
if (messageType.equals(NOTIFICATION_TYPE)) {
return Uni.createFrom().item(readObject(SnsNotification.class, message))
.onItem().transform(notification -> readObject(Quark.class, notification.getMessage()))
.onItem().invoke(quark -> LOGGER.infov("Quark[{0}, {1}] collision with the shield.", quark.getFlavor(), quark.getSpin()))
.onItem().transform(quark -> Response.ok().build());
} else if (messageType.equals(SUBSCRIPTION_CONFIRMATION_TYPE)) {
return Uni.createFrom().item(readObject(SnsSubscriptionConfirmation.class, message))
.onItem().transformToUni(msg ->
Uni.createFrom().completionStage(
sns.confirmSubscription(confirm -> confirm.topicArn(topicArn).token(msg.getToken())))
)
.onItem().invoke(resp -> LOGGER.info("Subscription confirmed. Ready for quarks collisions."))
.onItem().transform(resp -> Response.ok().build());
} else if (messageType.equals(UNSUBSCRIPTION_CONFIRMATION_TYPE)) {
LOGGER.info("We are unsubscribed");
return Uni.createFrom().item(Response.ok().build());
}
return Uni.createFrom().item(Response.status(400).entity("Unknown messageType").build());
}
@POST
@Path("/subscribe")
public Uni<Response> subscribe() {
return Uni.createFrom()
.completionStage(sns.subscribe(s -> s.topicArn(topicArn).protocol("http").endpoint(notificationEndpoint())))
.onItem().transform(SubscribeResponse::subscriptionArn)
.onItem().invoke(this::setSubscriptionArn)
.onItem().invoke(arn -> LOGGER.infov("Subscribed Quarks shield with id = {0} ", arn))
.onItem().transform(arn -> Response.ok().entity(arn).build());
}
@POST
@Path("/unsubscribe")
public Uni<Response> unsubscribe() {
if (subscriptionArn != null) {
return Uni.createFrom()
.completionStage(sns.unsubscribe(s -> s.subscriptionArn(subscriptionArn)))
.onItem().invoke(arn -> LOGGER.infov("Unsubscribed quarks shield for id = {0}", subscriptionArn))
.onItem().invoke(arn -> subscriptionArn = null)
.onItem().transform(arn -> Response.ok().build());
} else {
return Uni.createFrom().item(Response.status(400).entity("Not subscribed yet").build());
}
}
private String notificationEndpoint() {
return quarksShieldBaseUrl + "/async/shield";
}
private void setSubscriptionArn(String arn) {
this.subscriptionArn = arn;
}
private <T> T readObject(Class<T> clazz, String message) {
T object = null;
try {
object = READERS.get(clazz).readValue(message);
} catch (JsonProcessingException e) {
LOGGER.errorv("Unable to deserialize message <{0}> to Class <{1}>", message, clazz.getSimpleName());
throw new RuntimeException(e);
}
return object;
}
}
And we need to add Netty HTTP client dependency to the pom.xml
:
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>netty-nio-client</artifactId>
</dependency>
Configuration Reference
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Type |
Default |
|
---|---|---|
List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK.
The list should consists of class names which implements Environment variable: |
list of string |
|
Type of the sync HTTP client implementation Environment variable: |
|
|
If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto Environment variable: |
boolean |
|
Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container.
The discovery uses the Environment variable: |
boolean |
|
The value of the Environment variable: |
string |
|
Generic properties that are pass for additional container configuration. Environment variable: |
|
|
Type |
Default |
|
The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. Environment variable: |
||
The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. Environment variable: |
||
The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. Environment variable: |
||
Type |
Default |
|
An Amazon Web Services region that hosts the given service. It overrides region provider chain with static value of region with which the service client should communicate. If not set, region is retrieved via the default providers chain in the following order:
See Environment variable: |
Region |
|
Configure the credentials provider that should be used to authenticate with AWS. Available values:
Environment variable: |
|
|
Type |
Default |
|
Whether this provider should fetch credentials asynchronously in the background.
If this is Environment variable: |
boolean |
|
Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. Environment variable: |
boolean |
|
Type |
Default |
|
AWS Access key id Environment variable: |
string |
|
AWS Secret access key Environment variable: |
string |
|
AWS Session token Environment variable: |
string |
|
Type |
Default |
|
The name of the profile that should be used by this credentials provider.
If not specified, the value in Environment variable: |
string |
|
Type |
Default |
|
Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. Environment variable: |
boolean |
|
The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed *before* they are reported to expire. Environment variable: |
|
|
The maximum size of the output that can be returned by the external process before an exception is raised. Environment variable: |
|
|
The command that should be executed to retrieve credentials. Environment variable: |
string |
|
Type |
Default |
|
The name of custom AwsCredentialsProvider bean. Environment variable: |
string |
|
Type |
Default |
|
The maximum amount of time to establish a connection before timing out. Environment variable: |
|
|
The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. Environment variable: |
|
|
TLS key managers provider type. Available providers:
Environment variable: |
|
|
Path to the key store. Environment variable: |
path |
|
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. Environment variable: |
string |
|
Key store password Environment variable: |
string |
|
TLS trust managers provider type. Available providers:
Environment variable: |
|
|
Path to the key store. Environment variable: |
path |
|
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. Environment variable: |
string |
|
Key store password Environment variable: |
string |
|
Type |
Default |
|
The amount of time to wait when acquiring a connection from the pool before giving up and timing out. Environment variable: |
|
|
The maximum amount of time that a connection should be allowed to remain open while idle. Environment variable: |
|
|
The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. Environment variable: |
||
The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. Environment variable: |
int |
|
Whether the client should send an HTTP expect-continue handshake before each request. Environment variable: |
boolean |
|
Whether the idle connections in the connection pool should be closed asynchronously.
When enabled, connections left idling for longer than Environment variable: |
boolean |
|
Configure whether to enable or disable TCP KeepAlive. Environment variable: |
boolean |
|
Enable HTTP proxy Environment variable: |
boolean |
|
The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. Environment variable: |
||
The username to use when connecting through a proxy. Environment variable: |
string |
|
The password to use when connecting through a proxy. Environment variable: |
string |
|
For NTLM proxies - the Windows domain name to use when authenticating with the proxy. Environment variable: |
string |
|
For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. Environment variable: |
string |
|
Whether to attempt to authenticate preemptively against the proxy server using basic authentication. Environment variable: |
boolean |
|
The hosts that the client is allowed to access without going through the proxy. Environment variable: |
list of string |
|
Type |
Default |
|
The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. Environment variable: |
int |
|
The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. Environment variable: |
int |
|
The amount of time to wait for a read on a socket before an exception is thrown.
Specify Environment variable: |
|
|
The amount of time to wait for a write on a socket before an exception is thrown.
Specify Environment variable: |
|
|
The amount of time to wait when initially establishing a connection before giving up and timing out. Environment variable: |
|
|
The amount of time to wait when acquiring a connection from the pool before giving up and timing out. Environment variable: |
|
|
The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. Environment variable: |
||
The maximum amount of time that a connection should be allowed to remain open while idle.
Currently has no effect if Environment variable: |
|
|
Whether the idle connections in the connection pool should be closed.
When enabled, connections left idling for longer than Environment variable: |
boolean |
|
Configure whether to enable or disable TCP KeepAlive. Environment variable: |
boolean |
|
The HTTP protocol to use. Environment variable: |
|
|
The SSL Provider to be used in the Netty client.
Default is Environment variable: |
|
|
The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. Environment variable: |
long |
|
The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. Environment variable: |
int |
|
Sets the period that the Netty client will send Environment variable: |
|
|
Enable HTTP proxy. Environment variable: |
boolean |
|
The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. Environment variable: |
||
The hosts that the client is allowed to access without going through the proxy. Environment variable: |
list of string |
|
TLS key managers provider type. Available providers:
Environment variable: |
|
|
Path to the key store. Environment variable: |
path |
|
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. Environment variable: |
string |
|
Key store password Environment variable: |
string |
|
TLS trust managers provider type. Available providers:
Environment variable: |
|
|
Path to the key store. Environment variable: |
path |
|
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. Environment variable: |
string |
|
Key store password Environment variable: |
string |
|
Enable the custom configuration of the Netty event loop group. Environment variable: |
boolean |
|
Number of threads to use for the event loop group.
If not set, the default Netty thread count is used (which is double the number of available processors unless the Environment variable: |
int |
|
The thread name prefix for threads created by this thread factory used by event loop group.
The prefix will be appended with a number unique to the thread factory and a number unique to the thread.
If not specified it defaults to Environment variable: |
string |
|
Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. Environment variable: |
boolean |
|
About the Duration format
The format for durations uses the standard You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, |
About the MemorySize format
A size configuration option recognises string in this format (shown as a regular expression): |