org.apache.sling.distribution.queue.impl.jobhandling

Class JobHandlingDistributionQueue

java.lang.Object

org.apache.sling.distribution.queue.impl.jobhandling.JobHandlingDistributionQueue

All Implemented Interfaces:

DistributionQueue

public class JobHandlingDistributionQueue
extends Object
implements DistributionQueue

a DistributionQueue based on Sling Job Handling facilities

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISTRIBUTION_QUEUE_TOPIC

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 id) gets an item from the queue by specifying its id
@NotNull List<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
DistributionQueueType	getType() get the type of this queue
DistributionQueueEntry	remove(@NotNull String id) 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

Field Detail

DISTRIBUTION_QUEUE_TOPIC

public static final String DISTRIBUTION_QUEUE_TOPIC

See Also:

Constant Field Values

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 List<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 id)

Description copied from interface: DistributionQueue

gets an item from the queue by specifying its id

Specified by:

getItem in interface DistributionQueue

Parameters:

id - 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 id)

Description copied from interface: DistributionQueue

remove an item from the queue by specifying its id

Specified by:

remove in interface DistributionQueue

Parameters:

id - 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

getType

public DistributionQueueType getType()

Description copied from interface: DistributionQueue

get the type of this queue

Specified by:

getType in interface DistributionQueue

Returns:

the type