Class VaultDistributionPackageBuilderFactory
- java.lang.Object
-
- org.apache.sling.distribution.serialization.impl.vlt.VaultDistributionPackageBuilderFactory
-
- All Implemented Interfaces:
DistributionPackageBuilder
public class VaultDistributionPackageBuilderFactory extends Object implements DistributionPackageBuilder
A package builder for Apache Jackrabbit FileVault based implementations.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceVaultDistributionPackageBuilderFactory.Config
-
Constructor Summary
Constructors Constructor Description VaultDistributionPackageBuilderFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidactivate(org.osgi.framework.BundleContext context, VaultDistributionPackageBuilderFactory.Config conf)@NotNull DistributionPackagecreatePackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull org.apache.sling.distribution.DistributionRequest request)creates aDistributionPackagefor a specificDistributionRequestvoiddeactivate()@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
-
activate
public void activate(org.osgi.framework.BundleContext context, VaultDistributionPackageBuilderFactory.Config conf)
-
deactivate
public void deactivate()
-
getType
public String getType()
Description copied from interface:DistributionPackageBuilderreturns the type of a package. Only packages of this type will be accepted by the package builder.- Specified by:
getTypein interfaceDistributionPackageBuilder- Returns:
- the package type.
-
createPackage
@NotNull public @NotNull DistributionPackage createPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull org.apache.sling.distribution.DistributionRequest request) throws DistributionException
Description copied from interface:DistributionPackageBuildercreates aDistributionPackagefor a specificDistributionRequest- Specified by:
createPackagein interfaceDistributionPackageBuilder- 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 public @NotNull DistributionPackage readPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull InputStream stream) throws DistributionException
Description copied from interface:DistributionPackageBuilderreads a stream and tries to convert it to aDistributionPackagethis provider can read and install- Specified by:
readPackagein interfaceDistributionPackageBuilder- 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 public @Nullable DistributionPackage getPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull String id) throws DistributionException
Description copied from interface:DistributionPackageBuilderget an already created (and saved into the repository)DistributionPackageby its id- Specified by:
getPackagein interfaceDistributionPackageBuilder- 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
public boolean installPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull DistributionPackage distributionPackage) throws DistributionExceptionDescription copied from interface:DistributionPackageBuilderInstalls the given distributionPackage into the repository- Specified by:
installPackagein interfaceDistributionPackageBuilder- 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 public @NotNull DistributionPackageInfo installPackage(@NotNull @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull @NotNull InputStream stream) throws DistributionException
Description copied from interface:DistributionPackageBuilderinstall a stream and returns the associated to aDistributionPackageInfothis provider can read and install- Specified by:
installPackagein interfaceDistributionPackageBuilder- 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
-
-