Module dk.cloudcreate.essentials.components.foundation

Package dk.cloudcreate.essentials.components.foundation.messaging.queue.operations

Class GetQueuedMessages

java.lang.Object

dk.cloudcreate.essentials.components.foundation.messaging.queue.operations.GetQueuedMessages

public class GetQueuedMessages
extends Object

Query Queued Messages (i.e. not including Dead Letter Messages) for the given Queue
Operation also matched DurableQueuesInterceptor.intercept(GetQueuedMessages, InterceptorChain)

Field Summary

Fields

Modifier and Type	Field	Description
final QueueName	queueName

Constructor Summary

Constructors

Constructor	Description
GetQueuedMessages(QueueName queueName, DurableQueues.QueueingSortOrder queueingSortOrder, long startIndex, long pageSize)	Query Queued Messages (i.e.

Method Summary

Modifier and Type	Method	Description
static GetQueuedMessagesBuilder	builder()	Create a new builder that produces a new GetQueuedMessages instance
long	getPageSize()
DurableQueues.QueueingSortOrder	getQueueingSortOrder()
QueueName	getQueueName()
long	getStartIndex()
void	setPageSize(long pageSize)
void	setQueueingSortOrder(DurableQueues.QueueingSortOrder queueingSortOrder)
void	setStartIndex(long startIndex)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

queueName

public final QueueName queueName

Constructor Details

GetQueuedMessages

public GetQueuedMessages(QueueName queueName,
 DurableQueues.QueueingSortOrder queueingSortOrder,
 long startIndex,
 long pageSize)

Query Queued Messages (i.e. not including any Dead Letter Messages) for the given Queue

Parameters:

queueName - the name of the Queue where we will query for queued messages

queueingSortOrder - the sort order for the QueuedMessage.getId()

startIndex - the index of the first message to include in the result (used for pagination)

pageSize - how many messages to include in the result (used for pagination)

Method Details

builder

public static GetQueuedMessagesBuilder builder()

Create a new builder that produces a new GetQueuedMessages instance

Returns:

a new GetQueuedMessagesBuilder instance

getQueueName

public QueueName getQueueName()

Returns:

the name of the Queue where we will query for queued messages

getQueueingSortOrder

public DurableQueues.QueueingSortOrder getQueueingSortOrder()

Returns:

the sort order for the QueuedMessage.getId()

setQueueingSortOrder

public void setQueueingSortOrder(DurableQueues.QueueingSortOrder queueingSortOrder)

Parameters:

queueingSortOrder - the sort order for the QueuedMessage.getId()

getStartIndex

public long getStartIndex()

Returns:

the index of the first message to include in the result (used for pagination)

setStartIndex

public void setStartIndex(long startIndex)

Parameters:

startIndex - the index of the first message to include in the result (used for pagination)

getPageSize

public long getPageSize()

Returns:

how many messages to include in the result (used for pagination)

setPageSize

public void setPageSize(long pageSize)

Parameters:

pageSize - how many messages to include in the result (used for pagination)

toString

public String toString()

Overrides:

toString in class Object