org.apache.sling.distribution.queue.impl

Class AsyncDeliveryDispatchingStrategy

java.lang.Object

org.apache.sling.distribution.queue.impl.AsyncDeliveryDispatchingStrategy

All Implemented Interfaces:

DistributionQueueDispatchingStrategy

public class AsyncDeliveryDispatchingStrategy
extends Object
implements DistributionQueueDispatchingStrategy

Dispatching strategy that delivers items to their target queue unless the queue contains too many items (beyond MAX_QUEUE_ITEMS_THRESHOLD), in such a case a reference package is created and put into that queue while the actual package is sent using a different queue for storage at the receiving side so that it'll be installed only once the reference is processed. This guarantees delivery order while maximizing the network throughput when there're many items in the queues.

Field Summary

Fields inherited from interface org.apache.sling.distribution.queue.impl.DistributionQueueDispatchingStrategy

DEFAULT_QUEUE_NAME

Constructor Summary

Constructors

Constructor and Description
AsyncDeliveryDispatchingStrategy(Map<String,String> deliveryMappings) create an async delivery strategy

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncDeliveryDispatchingStrategy

public AsyncDeliveryDispatchingStrategy(Map<String,String> deliveryMappings)

create an async delivery strategy

Parameters:

deliveryMappings - the mappings (by name) between the default queue for a certain endpoint and its respective delivery queue

Method Detail

add

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

Description copied from interface: DistributionQueueDispatchingStrategy

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

Specified by:

add in interface DistributionQueueDispatchingStrategy

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

@NotNull
public @NotNull List<String> getQueueNames()

Description copied from interface: DistributionQueueDispatchingStrategy

Returns the queue names available for this strategy.

Specified by:

getQueueNames in interface DistributionQueueDispatchingStrategy

Returns:

a list of queue names