@ProviderType
public interface DistributionPackageBuilder
DistributionPackage
sModifier and Type | Method and Description |
---|---|
@NotNull DistributionPackage |
createPackage(@NotNull ResourceResolver resourceResolver,
@NotNull DistributionRequest request)
creates a
DistributionPackage for a specific DistributionRequest |
@Nullable DistributionPackage |
getPackage(@NotNull ResourceResolver resourceResolver,
@NotNull String id)
get an already created (and saved into the repository)
DistributionPackage by its id |
String |
getType()
returns the type of a package.
|
boolean |
installPackage(@NotNull ResourceResolver resourceResolver,
@NotNull DistributionPackage distributionPackage)
Installs the given distributionPackage into the repository
|
@NotNull DistributionPackageInfo |
installPackage(@NotNull ResourceResolver resourceResolver,
@NotNull InputStream stream)
install a stream and returns the associated to a
DistributionPackageInfo this provider can read and install |
@NotNull DistributionPackage |
readPackage(@NotNull ResourceResolver resourceResolver,
@NotNull InputStream stream)
reads a stream and tries to convert it to a
DistributionPackage this provider can read and install |
String getType()
@NotNull @NotNull DistributionPackage createPackage(@NotNull @NotNull ResourceResolver resourceResolver, @NotNull @NotNull DistributionRequest request) throws DistributionException
DistributionPackage
for a specific DistributionRequest
resourceResolver
- the resource resolver used to access the resources to be packagedrequest
- the DistributionRequest
to create the package forDistributionPackage
or null
if it could not be createdDistributionException
- if any error occurs while creating the package, or if the resource resolver is not authorized to do that@NotNull @NotNull DistributionPackage readPackage(@NotNull @NotNull ResourceResolver resourceResolver, @NotNull @NotNull InputStream stream) throws DistributionException
DistributionPackage
this provider can read and installresourceResolver
- resource resolver used to store the eventually created packagestream
- the InputStream
of the package to readDistributionPackage
if it can read it from the streamDistributionException
- when the stream cannot be read as a DistributionPackage
@Nullable @Nullable DistributionPackage getPackage(@NotNull @NotNull ResourceResolver resourceResolver, @NotNull @NotNull String id) throws DistributionException
DistributionPackage
by its idresourceResolver
- resource resolver used to access the package with the given idid
- the unique identifier of an already created DistributionPackage
DistributionPackage
if one with such an id exists, null
otherwiseDistributionException
- when the stream the package with that id cannot be retrievedboolean installPackage(@NotNull @NotNull ResourceResolver resourceResolver, @NotNull @NotNull DistributionPackage distributionPackage) throws DistributionException
resourceResolver
- the resource resolver used to install the packaged resourcesdistributionPackage
- the distribution package to installtrue
if the package was installed successfullyDistributionException
@NotNull @NotNull DistributionPackageInfo installPackage(@NotNull @NotNull ResourceResolver resourceResolver, @NotNull @NotNull InputStream stream) throws DistributionException
DistributionPackageInfo
this provider can read and installresourceResolver
- resource resolver used to store the eventually created packagestream
- the InputStream
of the package to readDistributionPackage
if it can read it from the streamDistributionException
- when the stream cannot be read as a DistributionPackage
Copyright © 2010 - 2020 Adobe. All Rights Reserved