com.adobe.cq.screens

Interface DeviceMessageQueue

public interface DeviceMessageQueue

The device message queue allows to queue messages unidirectional to the devices

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DeviceMessageQueue.Entry Entry that can be added to the queue.
static interface	DeviceMessageQueue.EntryBuilder Builder for device message queue entries.

Method Summary

Modifier and Type	Method and Description
DeviceMessageQueue.EntryBuilder	createEntryBuilder(java.lang.String message) Creates a new device message queue entry builder with the given message.
java.lang.String	dequeue(java.lang.String path) Dequeue message
DeviceMessageQueue.Entry	dequeueDeliverableEntry(java.lang.String path) Dequeue message and payload to be delivered.
DeviceMessageQueue.Entry	dequeueEntry(java.lang.String path) Dequeue message and payload
java.util.List<DeviceMessageQueue.Entry>	getEntriesRequiringAck(java.lang.String path) Get entities for a device that require ack
void	markAcknowledged(java.lang.String path, java.lang.String message) Mark the entry containing the message as acknowledged
void	markDeliveredOrRemove(java.lang.String path, java.lang.String message) Mark the entry containing the message as delivered and, if not requiring acknowledgement or already acknowledged, remove it from the queue given by the path
void	queue(java.lang.String path, java.lang.String message) Queue message
void	queue(java.lang.String path, java.lang.String message, boolean requiresAck) Queue message
void	queueEntry(java.lang.String path, DeviceMessageQueue.Entry entry) Queue message and payload
void	remove(java.lang.String path, java.lang.String message) Remove the specified message from the queue defined by the path

Method Detail

queueEntry

void queueEntry(java.lang.String path,
                DeviceMessageQueue.Entry entry)

Queue message and payload

Parameters:

path - The path of the resource that this message belongs.

entry - The message queue entry.

dequeueEntry

DeviceMessageQueue.Entry dequeueEntry(java.lang.String path)

Dequeue message and payload

Parameters:

path - The path of the resource that this message belongs.

Returns:

the next entry or null if the queue is empty.

createEntryBuilder

DeviceMessageQueue.EntryBuilder createEntryBuilder(java.lang.String message)

Creates a new device message queue entry builder with the given message.

Parameters:

message - the message for the entry.

Returns:

the builder.

queue

void queue(java.lang.String path,
           java.lang.String message)

Queue message

Parameters:

path - The path of the resource that this message belongs.

message - A simple message with no payload.

queue

void queue(java.lang.String path,
           java.lang.String message,
           boolean requiresAck)

Queue message

Parameters:

path - The path of the resource that this message belongs.

message - A simple message with no payload.

requiresAck - Whether acknowledgement for the message is required.

dequeue

java.lang.String dequeue(java.lang.String path)

Dequeue message

Parameters:

path - The path of the resource that this message belongs.

Returns:

the next message or null if the queue is empty.

getEntriesRequiringAck

java.util.List<DeviceMessageQueue.Entry> getEntriesRequiringAck(java.lang.String path)

Get entities for a device that require ack

Parameters:

path - The path of the resource that this message belongs.

Returns:

list of entities requiring ack

remove

void remove(java.lang.String path,
            java.lang.String message)

Remove the specified message from the queue defined by the path

Parameters:

path - The path of the resource that this message belongs.

message - The specific message to remove.

dequeueDeliverableEntry

DeviceMessageQueue.Entry dequeueDeliverableEntry(java.lang.String path)

Dequeue message and payload to be delivered. If the entry being dequeued requires acknowledgement, then it is marked as delivered and still kept in the queue until acknowledged; otherwise, it is simply removed from the queue.

Parameters:

path - The path of the resource that this message belongs.

Returns:

the next entry not delivered or null if none is found.

markDeliveredOrRemove

void markDeliveredOrRemove(java.lang.String path,
                           java.lang.String message)

Mark the entry containing the message as delivered and, if not requiring acknowledgement or already acknowledged, remove it from the queue given by the path

Parameters:

path - The path of the resource that this message belongs.

message - The message for which to handle delivery.

markAcknowledged

void markAcknowledged(java.lang.String path,
                      java.lang.String message)

Mark the entry containing the message as acknowledged

Parameters:

path - The path of the resource that this message belongs.

message - The message to mark acknowledged.