org.apache.sling.distribution.packaging.impl.exporter

Class AgentDistributionPackageExporter

java.lang.Object

org.apache.sling.distribution.packaging.impl.exporter.AgentDistributionPackageExporter

All Implemented Interfaces:

DistributionPackageExporter

public class AgentDistributionPackageExporter
extends Object
implements DistributionPackageExporter

a DistributionPackageExporter that picks DistributionPackage from a specific DistributionAgent's queue.

Constructor Summary

Constructors

Constructor and Description
AgentDistributionPackageExporter(String queueName, DistributionAgent agent, DistributionPackageBuilderProvider packageBuilderProvider, String name, boolean dropInvalidItems)

Method Summary

Modifier and Type	Method and Description
void	exportPackages(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull org.apache.sling.distribution.DistributionRequest distributionRequest, @NotNull DistributionPackageProcessor packageProcessor) Exports the DistributionPackages built from the passed DistributionRequest.
DistributionPackage	getPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull String distributionPackageId) Retrieves a DistributionPackage given its identifier, if it already exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentDistributionPackageExporter

public AgentDistributionPackageExporter(String queueName,
                                        DistributionAgent agent,
                                        DistributionPackageBuilderProvider packageBuilderProvider,
                                        String name,
                                        boolean dropInvalidItems)

Method Detail

exportPackages

public void exportPackages(@NotNull
                           @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                           @NotNull
                           @NotNull org.apache.sling.distribution.DistributionRequest distributionRequest,
                           @NotNull
                           @NotNull DistributionPackageProcessor packageProcessor)
                    throws DistributionException

Description copied from interface: DistributionPackageExporter

Exports the DistributionPackages built from the passed DistributionRequest.

Specified by:

exportPackages in interface DistributionPackageExporter

Parameters:

resourceResolver - the resource resolver used to export the packages, for example a 'local' exporter will use the resource resolver to read the content and assemble the binary in a certain location in the repository while a 'remote' exporter will use the resolver just to store the binary of the remotely fetched packages in the repository.

distributionRequest - the request containing the needed information for content to be exported

packageProcessor - a callback to process the exported package

Throws:

DistributionException

getPackage

public DistributionPackage getPackage(@NotNull
                                      @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                      @NotNull
                                      @NotNull String distributionPackageId)

Description copied from interface: DistributionPackageExporter

Retrieves a DistributionPackage given its identifier, if it already exists. This will be used for example to get already created (and cached) packages that were not yet distributed to the target instance.

Specified by:

getPackage in interface DistributionPackageExporter

Parameters:

resourceResolver - - the resource resolver use to obtain the package.

distributionPackageId - - the id of the package to be retrieved

Returns:

a DistributionPackage if available, null otherwise