public class ResourceQueue extends Object implements DistributionQueue
Modifier and Type | Field and Description |
---|---|
protected String |
queueName |
protected String |
queueRootPath |
protected org.apache.sling.api.resource.ResourceResolverFactory |
resolverFactory |
protected String |
serviceName |
Constructor and Description |
---|
ResourceQueue(org.apache.sling.api.resource.ResourceResolverFactory resolverFactory,
String serviceName,
String queueName,
String rootPath) |
Modifier and Type | Method and Description |
---|---|
@Nullable DistributionQueueEntry |
add(@NotNull DistributionQueueItem item)
add a distribution item to this queue
|
@NotNull Iterable<DistributionQueueEntry> |
clear(int limit)
Clear a range of entries from the queue.
|
@NotNull Iterable<DistributionQueueEntry> |
getEntries(int skip,
int limit)
get all the entries in the queue
|
@Nullable DistributionQueueEntry |
getEntry(@NotNull String itemId)
gets an entry from the queue by specifying its id
|
DistributionQueueEntry |
getHead()
get the first entry (in a FIFO strategy, the next to be processed) from 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
|
boolean |
hasCapability(@NotNull String capability) |
@NotNull Iterable<DistributionQueueEntry> |
remove(@NotNull Set<String> entryIds)
Remove a set entries from the queue by specifying their identifiers.
|
@Nullable DistributionQueueEntry |
remove(@NotNull String itemId)
remove an entry from the queue by specifying its id
|
protected final org.apache.sling.api.resource.ResourceResolverFactory resolverFactory
protected final String queueRootPath
protected String serviceName
protected String queueName
@NotNull public @NotNull String getName()
DistributionQueue
getName
in interface DistributionQueue
@Nullable public @Nullable DistributionQueueEntry add(@NotNull @NotNull DistributionQueueItem item)
DistributionQueue
add
in interface DistributionQueue
item
- a distribution item, typically representing a DistributionPackage
to distributenoll
if none is createdpublic DistributionQueueEntry getHead()
DistributionQueue
getHead
in interface DistributionQueue
null
if the queue is empty@NotNull public @NotNull Iterable<DistributionQueueEntry> getEntries(int skip, int limit)
DistributionQueue
getEntries
in interface DistributionQueue
skip
- the number of entries to skiplimit
- the maximum number of entries to return. use -1 to return all entries.Iterable
of DistributionQueueEntry
entries@Nullable public @Nullable DistributionQueueEntry getEntry(@NotNull @NotNull String itemId)
DistributionQueue
getEntry
in interface DistributionQueue
itemId
- the entry identifiernull
if the entry with the given id
doesn't exist@NotNull public @NotNull Iterable<DistributionQueueEntry> remove(@NotNull @NotNull Set<String> entryIds)
DistributionQueue
remove
in interface DistributionQueue
entryIds
- The identifiers of the entries to be removed@Nullable public @Nullable DistributionQueueEntry remove(@NotNull @NotNull String itemId)
DistributionQueue
remove
in interface DistributionQueue
itemId
- the entry identifiernull
if the entry with the given id
doesn't exist@NotNull public @NotNull DistributionQueueStatus getStatus()
DistributionQueue
getStatus
in interface DistributionQueue
@NotNull public @NotNull DistributionQueueType getType()
DistributionQueue
getType
in interface DistributionQueue
@NotNull public @NotNull Iterable<DistributionQueueEntry> clear(int limit)
DistributionQueue
clear
in interface DistributionQueue
limit
- The maximum number of entries to remove. All entries
are removed when the limit is -1
.public boolean hasCapability(@NotNull @NotNull String capability)
hasCapability
in interface DistributionQueue
true
if the queue supports the capability ;
false
otherwiseCopyright © 2007–2021 The Apache Software Foundation. All rights reserved.