Class ResourceQueueProvider
- java.lang.Object
-
- org.apache.sling.distribution.queue.impl.resource.ResourceQueueProvider
-
- All Implemented Interfaces:
org.apache.sling.distribution.queue.impl.DistributionQueueProvider
public class ResourceQueueProvider extends Object implements org.apache.sling.distribution.queue.impl.DistributionQueueProvider
-
-
Field Summary
Fields Modifier and Type Field Description static StringQUEUES_ROOTstatic StringTYPE
-
Constructor Summary
Constructors Constructor Description ResourceQueueProvider(org.osgi.framework.BundleContext context, org.apache.sling.api.resource.ResourceResolverFactory resolverFactory, String serviceName, String agentName, org.apache.sling.commons.scheduler.Scheduler scheduler, boolean isActive)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()voiddisableQueueProcessing()disables queue processingvoidenableQueueProcessing(@NotNull org.apache.sling.distribution.queue.impl.DistributionQueueProcessor queueProcessor, String... queueNames)enables queue processing@NotNull DistributionQueuegetQueue(@NotNull String queueName)provide anDistributionQueueType.ORDEREDqueue with the given name@NotNull DistributionQueuegetQueue(@NotNull String queueName, @NotNull DistributionQueueType type)provde a queue of the given type with the given name
-
-
-
Field Detail
-
TYPE
public static final String TYPE
- See Also:
- Constant Field Values
-
QUEUES_ROOT
public static final String QUEUES_ROOT
- See Also:
- Constant Field Values
-
-
Method Detail
-
getQueue
@NotNull public @NotNull DistributionQueue getQueue(@NotNull @NotNull String queueName) throws DistributionException
Description copied from interface:org.apache.sling.distribution.queue.impl.DistributionQueueProviderprovide anDistributionQueueType.ORDEREDqueue with the given name- Specified by:
getQueuein interfaceorg.apache.sling.distribution.queue.impl.DistributionQueueProvider- Parameters:
queueName- the name of the queue to retrieve- Returns:
- a
DistributionQueue - Throws:
DistributionException
-
getQueue
@NotNull public @NotNull DistributionQueue getQueue(@NotNull @NotNull String queueName, @NotNull @NotNull DistributionQueueType type)
Description copied from interface:org.apache.sling.distribution.queue.impl.DistributionQueueProviderprovde a queue of the given type with the given name- Specified by:
getQueuein interfaceorg.apache.sling.distribution.queue.impl.DistributionQueueProvider- Parameters:
queueName- the name of the queuetype- the type of the queue- Returns:
- a
DistributionQueue
-
enableQueueProcessing
public void enableQueueProcessing(@NotNull @NotNull org.apache.sling.distribution.queue.impl.DistributionQueueProcessor queueProcessor, String... queueNames) throws DistributionExceptionDescription copied from interface:org.apache.sling.distribution.queue.impl.DistributionQueueProviderenables queue processing- Specified by:
enableQueueProcessingin interfaceorg.apache.sling.distribution.queue.impl.DistributionQueueProvider- Parameters:
queueProcessor- the queue processor to be used- Throws:
DistributionException
-
disableQueueProcessing
public void disableQueueProcessing() throws DistributionExceptionDescription copied from interface:org.apache.sling.distribution.queue.impl.DistributionQueueProviderdisables queue processing- Specified by:
disableQueueProcessingin interfaceorg.apache.sling.distribution.queue.impl.DistributionQueueProvider- Throws:
DistributionException
-
close
public void close()
-
-