org.apache.sling.distribution.queue.impl

Class CachingDistributionQueue

java.lang.Object

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

org.apache.sling.distribution.queue.impl.CachingDistributionQueue

All Implemented Interfaces:

DistributionQueue

public class CachingDistributionQueue
extends DistributionQueueWrapper

DistributionQueueWrapper that caches entries for 30s.

Constructor Summary

Constructors

Constructor and Description
CachingDistributionQueue(String cacheKey, DistributionQueue wrappedQueue)

Method Summary

Modifier and Type	Method and Description
DistributionQueueEntry	add(@NotNull DistributionQueueItem item) add a distribution item to this queue
@NotNull DistributionQueueStatus	getStatus() get the status of the queue
DistributionQueueType	getType() get the type of this queue
DistributionQueueEntry	remove(@NotNull String itemId) remove an item from the queue by specifying its id

Methods inherited from class org.apache.sling.distribution.queue.impl.DistributionQueueWrapper

getHead, getItem, getItems, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingDistributionQueue

public CachingDistributionQueue(String cacheKey,
                                DistributionQueue wrappedQueue)

Method Detail

getStatus

@NotNull
public @NotNull DistributionQueueStatus getStatus()

Description copied from interface: DistributionQueue

get the status of the queue

Specified by:

getStatus in interface DistributionQueue

Overrides:

getStatus in class DistributionQueueWrapper

Returns:

the queue status

getType

public DistributionQueueType getType()

Description copied from interface: DistributionQueue

get the type of this queue

Returns:

the type

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

Overrides:

add in class DistributionQueueWrapper

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

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

Overrides:

remove in class DistributionQueueWrapper

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