Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* SPDX-License-Identifier: Apache-2.0
*
* Copyright 2018-2024 Agorapulse.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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.agorapulse.micronaut.aws.sqs;
import com.amazonaws.services.sqs.model.Message;
import com.amazonaws.services.sqs.model.SendMessageRequest;
import groovy.lang.Closure;
import groovy.lang.DelegatesTo;
import groovy.transform.stc.ClosureParams;
import groovy.transform.stc.FromString;
import space.jasan.support.groovy.closure.ConsumerWithDelegate;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
/**
* Amazon SQS services
*
* @see SimpleQueueServiceConfiguration
*/
public interface SimpleQueueService {
/**
* @return the default queue name from the configuration
* @throws AssertionError if the default queue name is not set (aws.sqs.queue configuration value)
*/
String getDefaultQueueName();
/**
* @return true if the service is caching queues urls, useful for longer running applications
*/
boolean isCaching();
String createQueue(QueueConfiguration queueConfiguration);
/**
* Creates new queue with given name.
* @param queueName the queue name
* @return url of the new queue
*/
String createQueue(String queueName);
/**
* Deletes message from the queue.
* @param queueName the queue name
* @param receiptHandle message id
*/
void deleteMessage(String queueName, String receiptHandle);
/**
* Deletes message from the default queue.
* @param receiptHandle message id
*/
default void deleteMessage(String receiptHandle) {
deleteMessage(getDefaultQueueName(), receiptHandle);
}
/**
* Deletes queue by name.
* @param queueName the name of the queue
*/
void deleteQueue(String queueName);
/**
* @param queueName the name of the queue
* @return the attributes of the queue
*/
Map getQueueAttributes(String queueName);
/**
* @return the attributes of the default queue
*/
default Map getQueueAttributes() {
return getQueueAttributes(getDefaultQueueName());
}
/**
* @param queueName the queue name
* @return the queue url
*/
String getQueueUrl(String queueName);
/**
* @return the default queue url
*/
default String getQueueUrl() {
return getQueueUrl(getDefaultQueueName());
}
/**
* @param queueName the queue name
* @return the queue arn
*/
String getQueueArn(String queueName);
/**
* @return the default queue arn
*/
default String getQueueArn() {
return getQueueArn(getDefaultQueueName());
}
/**
* @return list of all queues' names
*/
default List listQueueNames() {
return listQueueNames(!isCaching());
}
/**
* @param reload whether to reload the list of the queue
* @return the list of all queues' names
*/
List listQueueNames(boolean reload);
/**
* @return the list of all queues' urls
*/
default List listQueueUrls() {
return listQueueUrls(!isCaching());
}
/**
* @param reload whether to reload the list of the queue
* @return the list of all queues' urls
*/
List listQueueUrls(boolean reload);
/**
* @param queueName the queue name
* @param maxNumberOfMessages the maximum number of messages to retrieve
* @param visibilityTimeout the visibility timeout of the messages
* @return the list of received messages from the given queue
*/
default List receiveMessages(String queueName, int maxNumberOfMessages, int visibilityTimeout) {
return receiveMessages(queueName, maxNumberOfMessages, visibilityTimeout, 0);
}
/**
* @param queueName the queue name
* @param maxNumberOfMessages the maximum number of messages to retrieve
* @return the list of received messages from the given queue
*/
default List receiveMessages(String queueName, int maxNumberOfMessages) {
return receiveMessages(queueName, maxNumberOfMessages, 0);
}
/**
* @param queueName the queue name
* @return the list of received messages from the given queue
*/
default List receiveMessages(String queueName) {
return receiveMessages(queueName, 1);
}
/**
* @param maxNumberOfMessages the maximum number of messages to retrieve
* @param visibilityTimeout the visibility timeout of the messages
* @param waitTimeSeconds the time to wait for the messages to arrive
* @return the list of received messages from the default queue
*/
default List receiveMessages(int maxNumberOfMessages, int visibilityTimeout, int waitTimeSeconds) {
return receiveMessages(getDefaultQueueName(), maxNumberOfMessages, visibilityTimeout, waitTimeSeconds);
}
/**
* @param maxNumberOfMessages the maximum number of messages to retrieve
* @param visibilityTimeout the visibility timeout of the messages
* @return the list of received messages from the default queue
*/
default List receiveMessages(int maxNumberOfMessages, int visibilityTimeout) {
return receiveMessages(getDefaultQueueName(), maxNumberOfMessages, visibilityTimeout, 0);
}
/**
* @param maxNumberOfMessages the maximum number of messages to retrieve
* @return the list of received messages from the default queue
*/
default List receiveMessages(int maxNumberOfMessages) {
return receiveMessages(getDefaultQueueName(), maxNumberOfMessages, 0);
}
/**
* @return the list of received messages from the default queue
*/
default List receiveMessages() {
return receiveMessages(getDefaultQueueName(), 1);
}
/**
* @param queueName the queue name
* @param maxNumberOfMessages the maximum number of messages to retrieve
* @param visibilityTimeout the visibility timeout of the messages
* @param waitTimeSeconds the time to wait for the messages to arrive
* @return the list of received messages from the given queue
*/
List receiveMessages(String queueName, int maxNumberOfMessages, int visibilityTimeout, int waitTimeSeconds);
/**
* Send message immediately
* @param queueName the name of the queue
* @param messageBody the body of the message
* @return the message id of the message sent
*/
default String sendMessage(String queueName, String messageBody) {
return sendMessage(queueName, messageBody, 0);
}
/**
* Send message with given delay.
* @param queueName the name of the queue
* @param messageBody the body of the message
* @param delaySeconds the delay in seconds
* @param groupId group id for FIFO queues
* @return the message id of the message sent
*/
String sendMessage(String queueName, String messageBody, int delaySeconds, String groupId);
/**
* Send message with given delay.
* @param queueName the name of the queue
* @param messageBody the body of the message
* @param delaySeconds the delay in seconds
* @return the message id of the message sent
*/
default String sendMessage(String queueName, String messageBody, int delaySeconds) {
return sendMessage(queueName, messageBody, delaySeconds, null);
}
/**
* Send message in default queue immediately
* @param messageBody the body of the message
* @return the message id of the message sent
*/
default String sendMessage(String messageBody) {
return sendMessage(getDefaultQueueName(), messageBody);
}
/**
* Send message in the default queue with given delay.
* @param messageBody the body of the message
* @param delaySeconds the delay in seconds
* @return the message id of the message sent
*/
default String sendMessage(String messageBody, int delaySeconds) {
return sendMessage(getDefaultQueueName(), messageBody, delaySeconds);
}
/**
* Send message with given delay.
* @param messageBody the body of the message
* @param delaySeconds the delay in seconds
* @param groupId group id for FIFO queues
* @return the message id of the message sent
*/
default String sendMessage(String messageBody, int delaySeconds, String groupId) {
return sendMessage(getDefaultQueueName(), messageBody, delaySeconds, null);
}
/**
* Sends message with additional configuration into the default queue.
* @param messageBody message body
* @param messageConfiguration additional configuration
* @return message id
*/
default String sendMessage(String messageBody, Consumer messageConfiguration) {
return sendMessage(getDefaultQueueName(), messageBody, messageConfiguration);
}
/**
* Sends message with additional configuration into the default queue.
* @param messageBody message body
* @param messageConfiguration additional configuration
* @return message id
*/
default String sendMessage(String messageBody,
@DelegatesTo(value = SendMessageRequest.class, strategy = Closure.DELEGATE_FIRST)
@ClosureParams(value = FromString.class, options = "com.amazonaws.services.sqs.model.SendMessageRequest")
Closure messageConfiguration
) {
return sendMessage(getDefaultQueueName(), messageBody, ConsumerWithDelegate.create(messageConfiguration));
}
/**
* Sends message with additional configuration into the given queue.
* @param queueName name of the queue
* @param messageBody message body
* @param messageConfiguration additional configuration
* @return message id
*/
default String sendMessage(
String queueName,
String messageBody,
@DelegatesTo(value = SendMessageRequest.class, strategy = Closure.DELEGATE_FIRST)
@ClosureParams(value = FromString.class, options = "com.amazonaws.services.sqs.model.SendMessageRequest")
Closure messageConfiguration
) {
return sendMessage(queueName, messageBody, ConsumerWithDelegate.create(messageConfiguration));
}
/**
* Sends message with additional configuration into the given queue.
* @param queueName name of the queue
* @param messageBody message body
* @param messageConfiguration additional configuration
* @return message id
*/
String sendMessage(String queueName, String messageBody, Consumer messageConfiguration);
}
