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

Class LocalDistributionPackageExporterFactory

java.lang.Object

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

All Implemented Interfaces:

DistributionPackageExporter

@Service(value=DistributionPackageExporter.class)
 @Property(name="webconsole.configurationFactory.nameHint",
          value="Exporter name: {name}")
public class LocalDistributionPackageExporterFactory
extends Object
implements DistributionPackageExporter

OSGi configuration factory for LocalDistributionPackageExporters.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME name of this exporter.

Constructor Summary

Constructors

Constructor and Description
LocalDistributionPackageExporterFactory()

Method Summary

Modifier and Type	Method and Description
void	activate(Map<String,Object> config)
void	exportPackages(org.apache.sling.api.resource.ResourceResolver resourceResolver, org.apache.sling.distribution.DistributionRequest distributionRequest, DistributionPackageProcessor packageProcessor) Exports the DistributionPackages built from the passed DistributionRequest.
DistributionPackage	getPackage(org.apache.sling.api.resource.ResourceResolver resourceResolver, 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

Field Detail

NAME

@Property(label="Name",
          description="The name of the exporter.")
public static final String NAME

name of this exporter.

See Also:

Constant Field Values

Constructor Detail

LocalDistributionPackageExporterFactory

public LocalDistributionPackageExporterFactory()

Method Detail

activate

@Activate
public void activate(Map<String,Object> config)

exportPackages

public void exportPackages(@Nonnull
                           org.apache.sling.api.resource.ResourceResolver resourceResolver,
                           @Nonnull
                           org.apache.sling.distribution.DistributionRequest distributionRequest,
                           @Nonnull
                           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(@Nonnull
                                      org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                      @Nonnull
                                      String distributionPackageId)
                               throws DistributionException

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

Throws:

DistributionException