org.apache.sling.distribution.queue.spi

Interface DistributionQueue

All Known Implementing Classes:

CachingDistributionQueue, DistributionQueueWrapper, JobHandlingDistributionQueue, SimpleAgentDistributionQueue, SimpleDistributionQueue

public interface DistributionQueue

A queue is responsible for collecting the DistributionPackages exported by a DistributionAgent in order to be able to process them also when there are multiple (concurrent) DistributionRequests executed on that same agent.

The items (packages) in the queue can then get processed according to a FIFO strategy or in parallel, or some other way, via DistributionQueueProcessors.

Method Summary

Modifier and Type	Method and Description
@Nullable DistributionQueueEntry	add(@NotNull DistributionQueueItem item) add a distribution item to this queue
@Nullable DistributionQueueEntry	getHead() get the first item (in a FIFO strategy, the next to be processed) from the queue
@Nullable DistributionQueueEntry	getItem(@NotNull String itemId) gets an item from the queue by specifying its id
@NotNull Iterable<DistributionQueueEntry>	getItems(int skip, int limit) get all the items in the queue
@NotNull String	getName() get this queue name
@NotNull DistributionQueueStatus	getStatus() get the status of the queue
@NotNull DistributionQueueType	getType() get the type of this queue
@Nullable DistributionQueueEntry	remove(@NotNull String itemId) remove an item from the queue by specifying its id

Method Detail

getName

@NotNull
@NotNull String getName()

get this queue name

Returns:

the queue name

add

@Nullable
@Nullable DistributionQueueEntry add(@NotNull
                                               @NotNull DistributionQueueItem item)

add a distribution item to this queue

Parameters:

item - a distribution item, typically representing a DistributionPackage to distribute

Returns:

the queue entry created for this item or noll if none is created

getHead

@Nullable
@Nullable DistributionQueueEntry getHead()

get the first item (in a FIFO strategy, the next to be processed) from the queue

Returns:

the first item into the queue or null if the queue is empty

getItems

@NotNull
@NotNull Iterable<DistributionQueueEntry> getItems(int skip,
                                                            int limit)

get all the items in the queue

Parameters:

skip - the number of items to skip

limit - the maximum number of items to return. use -1 to return all items.

Returns:

a Iterable of DistributionQueueItems

getItem

@Nullable
@Nullable DistributionQueueEntry getItem(@NotNull
                                                   @NotNull String itemId)

gets an item from the queue by specifying its id

Parameters:

itemId - the id of the item as returned by DistributionQueueItem.getPackageId()

Returns:

the item, or null if the item with the given id doesn't exist

remove

@Nullable
@Nullable DistributionQueueEntry remove(@NotNull
                                                  @NotNull String itemId)

remove an item from the queue by specifying its id

Parameters:

itemId - the id the item as returned by DistributionQueueItem.getPackageId()

Returns:

the removed item, or null if the item with the given id doesn't exist

getStatus

@NotNull
@NotNull DistributionQueueStatus getStatus()

get the status of the queue

Returns:

the queue status

getType

@NotNull
@NotNull DistributionQueueType getType()

get the type of this queue

Returns:

the type