org.apache.sling.distribution.queue

Interface DistributionQueueProvider

All Known Implementing Classes:

JobHandlingDistributionQueueProvider, MonitoringDistributionQueueProvider, SimpleDistributionQueueProvider

public interface DistributionQueueProvider

A provider for DistributionQueues

Method Summary

Modifier and Type	Method and Description
void	disableQueueProcessing() disables queue processing
void	enableQueueProcessing(DistributionQueueProcessor queueProcessor, String... queueNames) enables queue processing
DistributionQueue	getQueue(String queueName) provide an DistributionQueueType.ORDERED queue with the given name
DistributionQueue	getQueue(String queueName, DistributionQueueType type) provde a queue of the given type with the given name

Method Detail

getQueue

@Nonnull
DistributionQueue getQueue(@Nonnull
                                    String queueName)
                             throws DistributionException

provide an DistributionQueueType.ORDERED queue with the given name

Parameters:

queueName - the name of the queue to retrieve

Returns:

a DistributionQueue

Throws:

DistributionException

getQueue

DistributionQueue getQueue(@Nonnull
                           String queueName,
                           @Nonnull
                           DistributionQueueType type)

provde a queue of the given type with the given name

Parameters:

queueName - the name of the queue

type - the type of the queue

Returns:

a DistributionQueue

enableQueueProcessing

void enableQueueProcessing(@Nonnull
                           DistributionQueueProcessor queueProcessor,
                           String... queueNames)
                    throws DistributionException

enables queue processing

Parameters:

queueProcessor - the queue processor to be used

Throws:

DistributionException

disableQueueProcessing

void disableQueueProcessing()
                     throws DistributionException

disables queue processing

Throws:

DistributionException