org.apache.sling.distribution.queue.impl

Interface DistributionQueueDispatchingStrategy

All Known Implementing Classes:

AsyncDeliveryDispatchingStrategy, ErrorQueueDispatchingStrategy, MultipleQueueDispatchingStrategy, PriorityQueueDispatchingStrategy, SingleQueueDispatchingStrategy

public interface DistributionQueueDispatchingStrategy

a DistributionQueueDispatchingStrategy implements an algorithm for dispatching DistributionPackages among the available queues.

Usually a DistributionPackage will be dispatched to a single DistributionQueue but it would also be possible to dispatch the same package to multiple queues, resulting in obtaining multiple states (one for each queue) for a certain package.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_QUEUE_NAME

Method Summary

Modifier and Type	Method and Description
Iterable<DistributionQueueItemStatus>	add(DistributionPackage distributionPackage, DistributionQueueProvider queueProvider) synchronously distribute a DistributionPackage to one or more DistributionQueues provided by the given DistributionQueueProvider
List<String>	getQueueNames() Returns the queue names available for this strategy.

Field Detail

DEFAULT_QUEUE_NAME

static final String DEFAULT_QUEUE_NAME

See Also:

Constant Field Values

Method Detail

add

Iterable<DistributionQueueItemStatus> add(@Nonnull
                                          DistributionPackage distributionPackage,
                                          @Nonnull
                                          DistributionQueueProvider queueProvider)
                                   throws DistributionException

synchronously distribute a DistributionPackage to one or more DistributionQueues provided by the given DistributionQueueProvider

Parameters:

distributionPackage - a DistributionPackage to distribute

queueProvider - the DistributionQueueProvider used to provide the queues to be used for the given package

Returns:

an Iterable of DistributionQueueItemStatuss representing the states of the DistributionQueueItems added to one or more DistributionQueues

Throws:

DistributionException - if any internal error happens during distribution

getQueueNames

@Nonnull
List<String> getQueueNames()

Returns the queue names available for this strategy.

Returns:

a list of queue names