public interface DistributionQueue
DistributionPackage
s
exported by a DistributionAgent
in
order to be able to process them also when there are multiple (concurrent)
DistributionRequest
s 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 DistributionQueueProcessor
s.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
|
@NotNull @NotNull String getName()
@Nullable @Nullable DistributionQueueEntry add(@NotNull @NotNull DistributionQueueItem item)
item
- a distribution item, typically representing a DistributionPackage
to distributenoll
if none is created@Nullable @Nullable DistributionQueueEntry getHead()
null
if the queue is empty@NotNull @NotNull Iterable<DistributionQueueEntry> getItems(int skip, int limit)
skip
- the number of items to skiplimit
- the maximum number of items to return. use -1 to return all items.Iterable
of DistributionQueueItem
s@Nullable @Nullable DistributionQueueEntry getItem(@NotNull @NotNull String itemId)
itemId
- the id of the item as returned by DistributionQueueItem.getPackageId()
null
if the item with the given id
doesn't exist@Nullable @Nullable DistributionQueueEntry remove(@NotNull @NotNull String itemId)
itemId
- the id the item as returned by DistributionQueueItem.getPackageId()
null
if the item with the given id
doesn't exist@NotNull @NotNull DistributionQueueStatus getStatus()
@NotNull @NotNull DistributionQueueType getType()
Copyright © 2007–2018 The Apache Software Foundation. All rights reserved.