org.apache.sling.distribution.queue.impl

Class DistributionQueueWrapper

java.lang.Object

org.apache.sling.distribution.queue.impl.DistributionQueueWrapper

All Implemented Interfaces:

DistributionQueue

Direct Known Subclasses:

CachingDistributionQueue, SimpleAgentDistributionQueue

public abstract class DistributionQueueWrapper
extends Object
implements DistributionQueue

Method Summary

Modifier and Type	Method and Description
DistributionQueueEntry	add(@NotNull DistributionQueueItem item) add a distribution item to this queue
DistributionQueueEntry	getHead() get the first item (in a FIFO strategy, the next to be processed) from the queue
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
DistributionQueueEntry	remove(@NotNull String itemId) remove an item from the queue by specifying its id

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sling.distribution.queue.spi.DistributionQueue

getType

Method Detail

getName

@NotNull
public @NotNull String getName()

Description copied from interface: DistributionQueue

get this queue name

Specified by:

getName in interface DistributionQueue

Returns:

the queue name

add

public DistributionQueueEntry add(@NotNull
                                  @NotNull DistributionQueueItem item)

Description copied from interface: DistributionQueue

add a distribution item to this queue

Specified by:

add in interface DistributionQueue

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

public DistributionQueueEntry getHead()

Description copied from interface: DistributionQueue

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

Specified by:

getHead in interface DistributionQueue

Returns:

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

getItems

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

Description copied from interface: DistributionQueue

get all the items in the queue

Specified by:

getItems in interface DistributionQueue

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

public DistributionQueueEntry getItem(@NotNull
                                      @NotNull String itemId)

Description copied from interface: DistributionQueue

gets an item from the queue by specifying its id

Specified by:

getItem in interface DistributionQueue

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

public DistributionQueueEntry remove(@NotNull
                                     @NotNull String itemId)

Description copied from interface: DistributionQueue

remove an item from the queue by specifying its id

Specified by:

remove in interface DistributionQueue

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
public @NotNull DistributionQueueStatus getStatus()

Description copied from interface: DistributionQueue

get the status of the queue

Specified by:

getStatus in interface DistributionQueue

Returns:

the queue status