org.apache.sling.distribution.agent.spi

Interface DistributionAgent

public interface DistributionAgent

A distribution agent is responsible for handling DistributionRequests.

This means executing actions of e.g.: a specific DistributionRequestTypes on specific path(s) which will resume pulling resources from a certain Sling instance and / or pushing resources to other instances.

Method Summary

Modifier and Type	Method and Description
DistributionResponse	execute(ResourceResolver resourceResolver, DistributionRequest distributionRequest) Perform a DistributionRequest to distribute content from a source instance to a target instance.
DistributionLog	getLog() Get the agent log
DistributionQueue	getQueue(java.lang.String name) Get the agent queue with the given name
java.lang.Iterable<java.lang.String>	getQueueNames() Retrieves the names of the queues for this agent.
DistributionAgentState	getState() returns the state of the agent

Method Detail

getQueueNames

java.lang.Iterable<java.lang.String> getQueueNames()

Retrieves the names of the queues for this agent.

Returns:

the list of queue names

getQueue

DistributionQueue getQueue(java.lang.String name)

Get the agent queue with the given name

Parameters:

name - a queue name

Returns:

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

getLog

DistributionLog getLog()

Get the agent log

Returns:

the log for this agent

getState

DistributionAgentState getState()

returns the state of the agent

Returns:

the agent state

execute

DistributionResponse execute(ResourceResolver resourceResolver,
                             DistributionRequest distributionRequest)
                      throws DistributionException

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.

Parameters:

distributionRequest - the distribution request

resourceResolver - the resource resolver used for authorizing the request,

Returns:

a DistributionResponse

Throws:

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