org.apache.sling.distribution.agent.impl

Class SimpleDistributionAgent

java.lang.Object

org.apache.sling.distribution.agent.impl.SimpleDistributionAgent

All Implemented Interfaces:

DistributionAgent

public class SimpleDistributionAgent
extends Object
implements DistributionAgent

Basic implementation of a DistributionAgent

Constructor Summary

Constructors

Constructor and Description

SimpleDistributionAgent(String name, boolean queueProcessingEnabled, Set<String> processingQueues, String subServiceName, DistributionPackageImporter distributionPackageImporter, DistributionPackageExporter distributionPackageExporter, DistributionRequestAuthorizationStrategy distributionRequestAuthorizationStrategy, DistributionQueueProvider queueProvider, DistributionQueueDispatchingStrategy scheduleQueueStrategy, DistributionQueueDispatchingStrategy errorQueueStrategy, DistributionEventFactory distributionEventFactory, org.apache.sling.api.resource.ResourceResolverFactory resourceResolverFactory, org.apache.sling.jcr.api.SlingRepository slingRepository, DefaultDistributionLog log, org.apache.sling.distribution.DistributionRequestType[] allowedRequests, String[] allowedRoots, int retryAttempts)

Method Summary

Modifier and Type	Method and Description
void	disable()
void	disableTrigger(DistributionTrigger trigger)
void	enable()
void	enableTrigger(DistributionTrigger trigger)
@NotNull org.apache.sling.distribution.DistributionResponse	execute(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull org.apache.sling.distribution.DistributionRequest distributionRequest) Perform a DistributionRequest to distribute content from a source instance to a target instance.
@NotNull DistributionLog	getLog() Get the agent log
DistributionQueue	getQueue(@NotNull String queueName) Get the agent queue with the given name
@NotNull Set<String>	getQueueNames() Retrieves the names of the queues for this agent.
@NotNull DistributionAgentState	getState() returns the state of the agent

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDistributionAgent

public SimpleDistributionAgent(String name,
                               boolean queueProcessingEnabled,
                               Set<String> processingQueues,
                               String subServiceName,
                               DistributionPackageImporter distributionPackageImporter,
                               DistributionPackageExporter distributionPackageExporter,
                               DistributionRequestAuthorizationStrategy distributionRequestAuthorizationStrategy,
                               DistributionQueueProvider queueProvider,
                               DistributionQueueDispatchingStrategy scheduleQueueStrategy,
                               DistributionQueueDispatchingStrategy errorQueueStrategy,
                               DistributionEventFactory distributionEventFactory,
                               org.apache.sling.api.resource.ResourceResolverFactory resourceResolverFactory,
                               org.apache.sling.jcr.api.SlingRepository slingRepository,
                               DefaultDistributionLog log,
                               org.apache.sling.distribution.DistributionRequestType[] allowedRequests,
                               String[] allowedRoots,
                               int retryAttempts)

Method Detail

execute

@NotNull
public @NotNull org.apache.sling.distribution.DistributionResponse execute(@NotNull
                                                                                    @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                                                    @NotNull
                                                                                    @NotNull org.apache.sling.distribution.DistributionRequest distributionRequest)
                                                                             throws DistributionException

Description copied from interface: DistributionAgent

Perform a DistributionRequest to distribute content from a source instance to a target instance. The content to be sent will be assembled according to the information contained in the request. A DistributionResponse holding the DistributionRequestState of the provided request will be returned. Synchronous DistributionAgents will usually block until the execution has finished while asynchronous agents will usually return the response as soon as the content to be distributed has been assembled and scheduled for distribution.

Specified by:

execute in interface DistributionAgent

Parameters:

resourceResolver - the resource resolver used for authorizing the request,

distributionRequest - the distribution request

Returns:

a DistributionResponse

Throws:

DistributionException - if any error happens during the execution of the request or if the authentication fails

getQueueNames

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

Description copied from interface: DistributionAgent

Retrieves the names of the queues for this agent.

Specified by:

getQueueNames in interface DistributionAgent

Returns:

the list of queue names

getQueue

public DistributionQueue getQueue(@NotNull
                                  @NotNull String queueName)

Description copied from interface: DistributionAgent

Get the agent queue with the given name

Specified by:

getQueue in interface DistributionAgent

Parameters:

queueName - a queue name

Returns:

a DistributionQueue with the given name bound to this agent, if it exists, null otherwise

getLog

@NotNull
public @NotNull DistributionLog getLog()

Description copied from interface: DistributionAgent

Get the agent log

Specified by:

getLog in interface DistributionAgent

Returns:

the log for this agent

getState

@NotNull
public @NotNull DistributionAgentState getState()

Description copied from interface: DistributionAgent

returns the state of the agent

Specified by:

getState in interface DistributionAgent

Returns:

the agent state

enable

public void enable()

enableTrigger

public void enableTrigger(DistributionTrigger trigger)

disableTrigger

public void disableTrigger(DistributionTrigger trigger)

disable

public void disable()