@ConsumerType
public interface DistributionAgent
DistributionRequest
s.
This means executing actions of e.g.: a specific DistributionRequestType
s on
specific path(s) which will resume pulling resources from a certain Sling instance and / or pushing resources to
other instances.Modifier and Type | Method and Description |
---|---|
@NotNull DistributionResponse |
execute(@NotNull ResourceResolver resourceResolver,
@NotNull DistributionRequest distributionRequest)
Perform a
DistributionRequest to distribute content from a source
instance to a target instance. |
@NotNull DistributionLog |
getLog()
Get the agent log
|
@Nullable DistributionQueue |
getQueue(@NotNull String name)
Get the agent queue with the given name
|
@NotNull Iterable<String> |
getQueueNames()
Retrieves the names of the queues for this agent.
|
@NotNull DistributionAgentState |
getState()
returns the state of the agent
|
@NotNull @NotNull Iterable<String> getQueueNames()
@Nullable @Nullable DistributionQueue getQueue(@NotNull @NotNull String name)
name
- a queue nameDistributionQueue
with the given name bound to this agent, if it exists,
null
otherwise@NotNull @NotNull DistributionLog getLog()
@NotNull @NotNull DistributionAgentState getState()
@NotNull @NotNull DistributionResponse execute(@NotNull @NotNull ResourceResolver resourceResolver, @NotNull @NotNull DistributionRequest distributionRequest) throws DistributionException
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 DistributionAgent
s 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.distributionRequest
- the distribution requestresourceResolver
- the resource resolver used for authorizing the request,DistributionResponse
DistributionException
- if any error happens during the execution of the request or if the authentication failsCopyright © 2010 - 2020 Adobe. All Rights Reserved