Interface DistributionPackageBuilder
-
- All Known Implementing Classes:
VaultDistributionPackageBuilderFactory
@ProviderType public interface DistributionPackageBuilderA builder forDistributionPackages
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Nullable DistributionPackagecreatePackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull org.apache.sling.distribution.DistributionRequest request)creates aDistributionPackagefor a specificDistributionRequest@Nullable DistributionPackagegetPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull String id)get an already created (and saved into the repository)DistributionPackageby its idStringgetType()returns the type of a package.@NotNull DistributionPackageInfoinstallPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull InputStream stream)install a stream and returns the associated to aDistributionPackageInfothis provider can read and installbooleaninstallPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull DistributionPackage distributionPackage)Installs the given distributionPackage into the repository@NotNull DistributionPackagereadPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull InputStream stream)reads a stream and tries to convert it to aDistributionPackagethis provider can read and install
-
-
-
Method Detail
-
getType
String getType()
returns the type of a package. Only packages of this type will be accepted by the package builder.- Returns:
- the package type.
-
createPackage
@Nullable @Nullable DistributionPackage createPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull org.apache.sling.distribution.DistributionRequest request) throws DistributionException
creates aDistributionPackagefor a specificDistributionRequest- Parameters:
resourceResolver- the resource resolver used to access the resources to be packagedrequest- theDistributionRequestto create the package for- Returns:
- a
DistributionPackageornullif it could not be created - Throws:
DistributionException- if any error occurs while creating the package, or if the resource resolver is not authorized to do that
-
readPackage
@NotNull @NotNull DistributionPackage readPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull InputStream stream) throws DistributionException
reads a stream and tries to convert it to aDistributionPackagethis provider can read and install- Parameters:
resourceResolver- resource resolver used to store the eventually created packagestream- theInputStreamof the package to read- Returns:
- a
DistributionPackageif it can read it from the stream - Throws:
DistributionException- when the stream cannot be read as aDistributionPackage
-
getPackage
@Nullable @Nullable DistributionPackage getPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull String id) throws DistributionException
get an already created (and saved into the repository)DistributionPackageby its id- Parameters:
resourceResolver- resource resolver used to access the package with the given idid- the unique identifier of an already createdDistributionPackage- Returns:
- a
DistributionPackageif one with such an id exists,nullotherwise - Throws:
DistributionException- when the stream the package with that id cannot be retrieved
-
installPackage
boolean installPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull DistributionPackage distributionPackage) throws DistributionExceptionInstalls the given distributionPackage into the repository- Parameters:
resourceResolver- the resource resolver used to install the packaged resourcesdistributionPackage- the distribution package to install- Returns:
trueif the package was installed successfully- Throws:
DistributionException- when installation fails
-
installPackage
@NotNull @NotNull DistributionPackageInfo installPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull InputStream stream) throws DistributionException
install a stream and returns the associated to aDistributionPackageInfothis provider can read and install- Parameters:
resourceResolver- resource resolver used to store the eventually created packagestream- theInputStreamof the package to read- Returns:
- a
DistributionPackageif it can read it from the stream - Throws:
DistributionException- when the stream cannot be read as aDistributionPackage
-
-