org.apache.sling.distribution.packaging

Interface DistributionPackageImporter

All Known Implementing Classes:

LocalDistributionPackageImporter, LocalDistributionPackageImporterFactory, RemoteDistributionPackageImporter, RemoteDistributionPackageImporterFactory, RepositoryDistributionPackageImporter, RepositoryDistributionPackageImporterFactory

public interface DistributionPackageImporter

A DistributionPackageImporter is responsible for importing DistributionPackages into either a local or remote Sling instance. Importing a DistributionPackage means persisting its stream into a Sling instance.

Method Summary

Modifier and Type	Method and Description
void	importPackage(org.apache.sling.api.resource.ResourceResolver resourceResolver, DistributionPackage distributionPackage) Imports the given distribution package into the underlying system
DistributionPackageInfo	importStream(org.apache.sling.api.resource.ResourceResolver resourceResolver, InputStream stream) Tries to convert an InputStream to a DistributionPackage and then imports it into the underlying system

Method Detail

importPackage

void importPackage(@Nonnull
                   org.apache.sling.api.resource.ResourceResolver resourceResolver,
                   @Nonnull
                   DistributionPackage distributionPackage)
            throws DistributionException

Imports the given distribution package into the underlying system

Parameters:

resourceResolver - - the resource resolver used to import the resources

distributionPackage - - the package to be imported

Throws:

DistributionException - if any error occurs during import

importStream

@Nonnull
DistributionPackageInfo importStream(@Nonnull
                                              org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                              @Nonnull
                                              InputStream stream)
                                       throws DistributionException

Tries to convert an InputStream to a DistributionPackage and then imports it into the underlying system

Parameters:

resourceResolver - - the resource resolver used to read the package

stream - the InputStream of the package to be converted and imported

Returns:

a DistributionPackageInfo if the stream has been successfully converted and imported

Throws:

DistributionException - when the stream cannot be read as a DistributionPackage and imported