org.apache.sling.distribution.queue.impl

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(@NotNull DistributionQueueProcessor queueProcessor, String... queueNames) enables queue processing
@NotNull DistributionQueue	getQueue(@NotNull String queueName) provide an DistributionQueueType.ORDERED queue with the given name
@NotNull DistributionQueue	getQueue(@NotNull String queueName, @NotNull DistributionQueueType type) provde a queue of the given type with the given name

Method Detail

getQueue

@NotNull
@NotNull DistributionQueue getQueue(@NotNull
                                             @NotNull 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

@NotNull
@NotNull DistributionQueue getQueue(@NotNull
                                             @NotNull String queueName,
                                             @NotNull
                                             @NotNull 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(@NotNull
                           @NotNull 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