Package com.github.sonus21.rqueue.core

Interface RqueueMessageSender

All Known Implementing Classes:

RqueueMessageSenderImpl

@Deprecated
public interface RqueueMessageSender

Deprecated.

RqueueMessage sender sends message to redis using different mechanism. Use any of the methods from this interface to send message over any queue. Queue must exist, if a queue does not exist then it will throw an error of the QueueDoesNotExist.

There're three types of interfaces in this 1. enqueueXYZ 2. enqueueInXYZ 3. enqueueAtXYZ

Messages send using enqueueXYZ shall be consume as soon as possible

Messages send using enqueueInXYZ shall be consumed once the given time is elapsed, like in 30 seconds.

Messages send using enqueueAtXYZ shall be consumed as soon as the given time is reached for example 3PM tomorrow.

See Also:

RqueueMessageEnqueuer, RqueueMessageManager, RqueueEndpointManager

Method Summary

Modifier and Type	Method	Description
boolean	deleteAllMessages(java.lang.String queueName)	Deprecated. Very dangerous method it will delete all messages in a queue
boolean	enqueue(java.lang.String queueName, java.lang.Object message)	Deprecated. Enqueue a message on given queue without any delay, consume as soon as possible.
default boolean	enqueueAt(java.lang.String queueName, java.lang.Object message, long startTimeInMilliSeconds)	Deprecated. Schedule a message on the given queue at the provided time.
default boolean	enqueueAt(java.lang.String queueName, java.lang.Object message, java.time.Instant starTime)	Deprecated. Schedule a message on the given queue at the provided time.
default boolean	enqueueAt(java.lang.String queueName, java.lang.Object message, java.util.Date starTime)	Deprecated. Schedule a message on the given queue at the provided time.
default boolean	enqueueAtWithPriority(java.lang.String queueName, java.lang.String priority, java.lang.Object message, long startTimeInMilliSecond)	Deprecated. Schedule a message on the given queue at the provided time.
default boolean	enqueueAtWithPriority(java.lang.String queueName, java.lang.String priority, java.lang.Object message, java.time.Instant startTime)	Deprecated. Schedule a message on the given queue at the provided time.
default boolean	enqueueAtWithPriority(java.lang.String queueName, java.lang.String priority, java.lang.Object message, java.util.Date startTime)	Deprecated. Schedule a message on the given queue at the provided time.
boolean	enqueueIn(java.lang.String queueName, java.lang.Object message, long delayInMilliSecs)	Deprecated. Schedule a message on the given queue with the provided delay.
default boolean	enqueueIn(java.lang.String queueName, java.lang.Object message, long delay, java.util.concurrent.TimeUnit unit)	Deprecated. Schedule a message on the given queue with the provided delay.
default boolean	enqueueIn(java.lang.String queueName, java.lang.Object message, java.time.Duration delay)	Deprecated. Schedule a message on the given queue with the provided delay.
boolean	enqueueInWithPriority(java.lang.String queueName, java.lang.String priority, java.lang.Object message, long delayInMilliSecs)	Deprecated. Schedule a message on the given queue at the provided time.
default boolean	enqueueInWithPriority(java.lang.String queueName, java.lang.String priority, java.lang.Object message, long delay, java.util.concurrent.TimeUnit unit)	Deprecated. Schedule a message on the given queue at the provided time.
default boolean	enqueueInWithPriority(java.lang.String queueName, java.lang.String priority, java.lang.Object message, java.time.Duration delay)	Deprecated. Schedule a message on the given queue at the provided time.
boolean	enqueueInWithRetry(java.lang.String queueName, java.lang.Object message, int retryCount, long delayInMilliSecs)	Deprecated. Enqueue a task that would be scheduled to run in the specified milli seconds.
boolean	enqueueWithPriority(java.lang.String queueName, java.lang.String priority, java.lang.Object message)	Deprecated. Enqueue a message on given queue, that will be consumed as soon as possible.
boolean	enqueueWithRetry(java.lang.String queueName, java.lang.Object message, int retryCount)	Deprecated. Enqueue a message on the given queue with the given retry count.
java.util.List<java.lang.Object>	getAllMessages(java.lang.String queueName)	Deprecated. Find all messages stored on a given queue, it considers all the messages including delayed and non-delayed.
org.springframework.messaging.converter.MessageConverter	getMessageConverter()	Deprecated. Get all registered message converters.
java.lang.Iterable<? extends org.springframework.messaging.converter.MessageConverter>	getMessageConverters()	Deprecated. Get one or more registered message converters.
boolean	moveMessageFromDeadLetterToQueue(java.lang.String deadLetterQueueName, java.lang.String queueName)	Deprecated. A shortcut to the method moveMessageFromDeadLetterToQueue(String, String, Integer)
boolean	moveMessageFromDeadLetterToQueue(java.lang.String deadLetterQueueName, java.lang.String queueName, java.lang.Integer maxMessages)	Deprecated. Move messages from Dead Letter queue to the destination queue.
default boolean	put(java.lang.String queueName, java.lang.Object message)	Deprecated. migrate to enqueue(String, Object)
default boolean	put(java.lang.String queueName, java.lang.Object message, int retryCount)	Deprecated. migrate to enqueueWithPriority(String, String, Object)
default boolean	put(java.lang.String queueName, java.lang.Object message, int retryCount, long delayInMilliSecs)	Deprecated. migrate to enqueueInWithRetry(String, Object, int, long)
default boolean	put(java.lang.String queueName, java.lang.Object message, long delayInMilliSecs)	Deprecated.
void	registerQueue(java.lang.String name, java.lang.String... priorities)	Deprecated. Use this method to register any queue, that's only used for sending message.

Method Detail

put

@Deprecated
default boolean put(java.lang.String queueName,
                    java.lang.Object message)

Deprecated.

migrate to enqueue(String, Object)

Enqueue a message on given queue without any delay, consume as soon as possible.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

Returns:

message was submitted successfully or failed.

enqueue

boolean enqueue(java.lang.String queueName,
                java.lang.Object message)

Deprecated.

Enqueue a message on given queue without any delay, consume as soon as possible.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

Returns:

message was submitted successfully or failed.

put

@Deprecated
default boolean put(java.lang.String queueName,
                    java.lang.Object message,
                    long delayInMilliSecs)

Deprecated.

Enqueue a message on the given queue with the provided delay. It will be available to consume as soon as the delay elapse.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

delayInMilliSecs - delay in milli seconds

Returns:

message was submitted successfully or failed.

enqueueIn

boolean enqueueIn(java.lang.String queueName,
                  java.lang.Object message,
                  long delayInMilliSecs)

Deprecated.

Schedule a message on the given queue with the provided delay. It will be available to consume as soon as the delay elapse.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

delayInMilliSecs - delay in milli seconds

Returns:

message was submitted successfully or failed.

enqueueIn

default boolean enqueueIn(java.lang.String queueName,
                          java.lang.Object message,
                          java.time.Duration delay)

Deprecated.

Schedule a message on the given queue with the provided delay. It will be available to consume as soon as the delay elapse.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

delay - time to wait before it can be executed.

Returns:

message was submitted successfully or failed.

enqueueIn

default boolean enqueueIn(java.lang.String queueName,
                          java.lang.Object message,
                          long delay,
                          java.util.concurrent.TimeUnit unit)

Deprecated.

Schedule a message on the given queue with the provided delay. It will be available to consume as soon as the specified delay elapse.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

delay - time to wait before it can be executed.

unit - unit of the delay

Returns:

message was submitted successfully or failed.

enqueueAt

default boolean enqueueAt(java.lang.String queueName,
                          java.lang.Object message,
                          long startTimeInMilliSeconds)

Deprecated.

Schedule a message on the given queue at the provided time. It will be available to consume as soon as the given time is reached.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

startTimeInMilliSeconds - time at which this message has to be consumed.

Returns:

message was submitted successfully or failed.

enqueueAt

default boolean enqueueAt(java.lang.String queueName,
                          java.lang.Object message,
                          java.time.Instant starTime)

Deprecated.

Schedule a message on the given queue at the provided time. It will be available to consume as soon as the given time is reached.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

starTime - time at which this message has to be consumed.

Returns:

message was submitted successfully or failed.

enqueueAt

default boolean enqueueAt(java.lang.String queueName,
                          java.lang.Object message,
                          java.util.Date starTime)

Deprecated.

Schedule a message on the given queue at the provided time. It will be available to consume as soon as the given time is reached.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

starTime - time at which this message has to be consumed.

Returns:

message was submitted successfully or failed.

put

@Deprecated
default boolean put(java.lang.String queueName,
                    java.lang.Object message,
                    int retryCount)

Deprecated.

migrate to enqueueWithPriority(String, String, Object)

Enqueue a message on the given queue with the given retry count. This message would not be consumed more than the specified time due to failure in underlying systems.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

retryCount - how many times a message would be retried, before it can be discarded or send to dead letter queue configured using RqueueListener.numRetries()

Returns:

message was submitted successfully or failed.

enqueueWithRetry

boolean enqueueWithRetry(java.lang.String queueName,
                         java.lang.Object message,
                         int retryCount)

Deprecated.

Enqueue a message on the given queue with the given retry count. This message would not be consumed more than the specified time due to failure in underlying systems.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

retryCount - how many times a message would be retried, before it can be discarded or send to dead letter queue configured using RqueueListener.numRetries()

Returns:

message was submitted successfully or failed.

put

@Deprecated
default boolean put(java.lang.String queueName,
                    java.lang.Object message,
                    int retryCount,
                    long delayInMilliSecs)

Deprecated.

migrate to enqueueInWithRetry(String, Object, int, long)

Enqueue a message on the given queue that would be scheduled to run in the specified milli seconds.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

retryCount - how many times a message would be retried, before it can be discarded or sent to dead letter queue configured using RqueueListener.numRetries() ()}

delayInMilliSecs - delay in milli seconds, this message would be only visible to the listener when number of millisecond has elapsed.

Returns:

message was submitted successfully or failed.

enqueueInWithRetry

boolean enqueueInWithRetry(java.lang.String queueName,
                           java.lang.Object message,
                           int retryCount,
                           long delayInMilliSecs)

Deprecated.

Enqueue a task that would be scheduled to run in the specified milli seconds.

Parameters:

queueName - on which queue message has to be send

message - message object it could be any arbitrary object.

retryCount - how many times a message would be retried, before it can be discarded or sent to dead letter queue configured using RqueueListener.numRetries() ()}

delayInMilliSecs - delay in milli seconds, this message would be only visible to the listener when number of millisecond has elapsed.

Returns:

message was submitted successfully or failed.

enqueueWithPriority

boolean enqueueWithPriority(java.lang.String queueName,
                            java.lang.String priority,
                            java.lang.Object message)

Deprecated.

Enqueue a message on given queue, that will be consumed as soon as possible.

Parameters:

queueName - on which queue message has to be send

priority - the priority name for this message

message - message object it could be any arbitrary object.

Returns:

message was submitted successfully or failed.

enqueueInWithPriority

boolean enqueueInWithPriority(java.lang.String queueName,
                              java.lang.String priority,
                              java.lang.Object message,
                              long delayInMilliSecs)

Deprecated.

Schedule a message on the given queue at the provided time. It will be executed as soon as the given delay is elapse.

Parameters:

queueName - on which queue message has to be send

priority - the name of the priority level

message - message object it could be any arbitrary object.

delayInMilliSecs - delay in milli seconds

Returns:

message was submitted successfully or failed.

enqueueInWithPriority

default boolean enqueueInWithPriority(java.lang.String queueName,
                                      java.lang.String priority,
                                      java.lang.Object message,
                                      java.time.Duration delay)

Deprecated.

Schedule a message on the given queue at the provided time. It will be executed as soon as the given delay is elapse.

Parameters:

queueName - on which queue message has to be send

priority - the name of the priority level

message - message object it could be any arbitrary object.

delay - time to wait before it can be consumed.

Returns:

message was submitted successfully or failed.

enqueueInWithPriority

default boolean enqueueInWithPriority(java.lang.String queueName,
                                      java.lang.String priority,
                                      java.lang.Object message,
                                      long delay,
                                      java.util.concurrent.TimeUnit unit)

Deprecated.

Schedule a message on the given queue at the provided time. It will be executed as soon as the given delay is elapse.

Parameters:

queueName - on which queue message has to be send

priority - the name of the priority level

message - message object it could be any arbitrary object.

delay - time to wait before it can be consumed.

unit - unit of the delay

Returns:

message was submitted successfully or failed.

enqueueAtWithPriority

default boolean enqueueAtWithPriority(java.lang.String queueName,
                                      java.lang.String priority,
                                      java.lang.Object message,
                                      long startTimeInMilliSecond)

Deprecated.

Schedule a message on the given queue at the provided time. It will be executed as soon as the given time is reached, time must be in the future.

Parameters:

queueName - on which queue message has to be send

priority - the name of the priority level

message - message object it could be any arbitrary object.

startTimeInMilliSecond - time at which the message would be consumed.

Returns:

message was submitted successfully or failed.

enqueueAtWithPriority

default boolean enqueueAtWithPriority(java.lang.String queueName,
                                      java.lang.String priority,
                                      java.lang.Object message,
                                      java.time.Instant startTime)

Deprecated.

Schedule a message on the given queue at the provided time. It will be executed as soon as the given time is reached, time must be in the future.

Parameters:

queueName - on which queue message has to be send

priority - the name of the priority level

message - message object it could be any arbitrary object.

startTime - time at which message is supposed to consume

Returns:

message was submitted successfully or failed.

enqueueAtWithPriority

default boolean enqueueAtWithPriority(java.lang.String queueName,
                                      java.lang.String priority,
                                      java.lang.Object message,
                                      java.util.Date startTime)

Deprecated.

Schedule a message on the given queue at the provided time. It will be executed as soon as the given time is reached, time must be in the future.

Parameters:

queueName - on which queue message has to be send

priority - the name of the priority level

message - message object it could be any arbitrary object.

startTime - time at which message would be consumed.

Returns:

message was submitted successfully or failed.

moveMessageFromDeadLetterToQueue

boolean moveMessageFromDeadLetterToQueue(java.lang.String deadLetterQueueName,
                                         java.lang.String queueName,
                                         java.lang.Integer maxMessages)

Deprecated.

Move messages from Dead Letter queue to the destination queue. This push the messages at the FRONT of destination queue, so that it can be reprocessed as soon as possible.

Parameters:

deadLetterQueueName - dead letter queue name

queueName - queue name

maxMessages - number of messages to be moved by default move Constants.MAX_MESSAGES messages

Returns:

success or failure.

moveMessageFromDeadLetterToQueue

boolean moveMessageFromDeadLetterToQueue(java.lang.String deadLetterQueueName,
                                         java.lang.String queueName)

Deprecated.

A shortcut to the method moveMessageFromDeadLetterToQueue(String, String, Integer)

Parameters:

deadLetterQueueName - dead letter queue name

queueName - queue name

Returns:

success or failure

deleteAllMessages

boolean deleteAllMessages(java.lang.String queueName)

Deprecated.

Very dangerous method it will delete all messages in a queue

Parameters:

queueName - queue name

Returns:

fail/success

getMessageConverters

java.lang.Iterable<? extends org.springframework.messaging.converter.MessageConverter> getMessageConverters()

Deprecated.

Get one or more registered message converters.

Returns:

registered message converters.

getAllMessages

java.util.List<java.lang.Object> getAllMessages(java.lang.String queueName)

Deprecated.

Find all messages stored on a given queue, it considers all the messages including delayed and non-delayed.

Parameters:

queueName - queue name to be query for

Returns:

list of messages.

getMessageConverter

org.springframework.messaging.converter.MessageConverter getMessageConverter()

Deprecated.

Get all registered message converters.

Returns:

list of message converters.

registerQueue

void registerQueue(java.lang.String name,
                   java.lang.String... priorities)

Deprecated.

Use this method to register any queue, that's only used for sending message.

Parameters:

name - name of the queue

priorities - list of priorities to be used while sending message on this queue.