org.apache.sling.distribution.packaging.impl

Class AbstractDistributionPackageBuilder

java.lang.Object

org.apache.sling.distribution.packaging.impl.AbstractDistributionPackageBuilder

All Implemented Interfaces:

DistributionPackageBuilder

Direct Known Subclasses:

FileDistributionPackageBuilder, InMemoryDistributionPackageBuilder, ResourceDistributionPackageBuilder

public abstract class AbstractDistributionPackageBuilder
extends Object
implements DistributionPackageBuilder

base abstract implementation of a JCR based DistributionPackageBuilder

Method Summary

Modifier and Type	Method and Description
@NotNull DistributionPackage	createPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull org.apache.sling.distribution.DistributionRequest request) creates a DistributionPackage for a specific DistributionRequest
protected abstract @Nullable DistributionPackage	createPackageForAdd(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull org.apache.sling.distribution.DistributionRequest request)
@Nullable DistributionPackage	getPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull String id) get an already created (and saved into the repository) DistributionPackage by its id
protected abstract @Nullable DistributionPackage	getPackageInternal(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull String id)
String	getType() returns the type of a package.
boolean	installPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull DistributionPackage distributionPackage) Installs the given distributionPackage into the repository
@NotNull DistributionPackageInfo	installPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull InputStream stream) install a stream and returns the associated to a DistributionPackageInfo this provider can read and install
protected abstract boolean	installPackageInternal(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull InputStream stream)
@NotNull DistributionPackage	readPackage(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull InputStream stream) reads a stream and tries to convert it to a DistributionPackage this provider can read and install
protected abstract @Nullable DistributionPackage	readPackageInternal(@NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver, @NotNull InputStream stream)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getType

public String getType()

Description copied from interface: DistributionPackageBuilder

returns the type of a package. Only packages of this type will be accepted by the package builder.

Specified by:

getType in interface DistributionPackageBuilder

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: DistributionPackageBuilder

creates a DistributionPackage for a specific DistributionRequest

Specified by:

createPackage in interface DistributionPackageBuilder

Parameters:

resourceResolver - the resource resolver used to access the resources to be packaged

request - the DistributionRequest to create the package for

Returns:

a DistributionPackage or null if 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: DistributionPackageBuilder

reads a stream and tries to convert it to a DistributionPackage this provider can read and install

Specified by:

readPackage in interface DistributionPackageBuilder

Parameters:

resourceResolver - resource resolver used to store the eventually created package

stream - the InputStream of the package to read

Returns:

a DistributionPackage if it can read it from the stream

Throws:

DistributionException - when the stream cannot be read as a DistributionPackage

installPackage

public boolean installPackage(@NotNull
                              @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                              @NotNull
                              @NotNull DistributionPackage distributionPackage)
                       throws DistributionException

Description copied from interface: DistributionPackageBuilder

Installs the given distributionPackage into the repository

Specified by:

installPackage in interface DistributionPackageBuilder

Parameters:

resourceResolver - the resource resolver used to install the packaged resources

distributionPackage - the distribution package to install

Returns:

true if the package was installed successfully

Throws:

DistributionException

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: DistributionPackageBuilder

install a stream and returns the associated to a DistributionPackageInfo this provider can read and install

Specified by:

installPackage in interface DistributionPackageBuilder

Parameters:

resourceResolver - resource resolver used to store the eventually created package

stream - the InputStream of the package to read

Returns:

a DistributionPackage if it can read it from the stream

Throws:

DistributionException - when the stream cannot be read as a DistributionPackage

getPackage

@Nullable
public @Nullable DistributionPackage getPackage(@NotNull
                                                          @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                          @NotNull
                                                          @NotNull String id)

Description copied from interface: DistributionPackageBuilder

get an already created (and saved into the repository) DistributionPackage by its id

Specified by:

getPackage in interface DistributionPackageBuilder

Parameters:

resourceResolver - resource resolver used to access the package with the given id

id - the unique identifier of an already created DistributionPackage

Returns:

a DistributionPackage if one with such an id exists, null otherwise

createPackageForAdd

@Nullable
protected abstract @Nullable DistributionPackage createPackageForAdd(@NotNull
                                                                               @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                                               @NotNull
                                                                               @NotNull org.apache.sling.distribution.DistributionRequest request)
                                                                        throws DistributionException

Throws:

DistributionException

readPackageInternal

@Nullable
protected abstract @Nullable DistributionPackage readPackageInternal(@NotNull
                                                                               @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                                               @NotNull
                                                                               @NotNull InputStream stream)
                                                                        throws DistributionException

Throws:

DistributionException

installPackageInternal

protected abstract boolean installPackageInternal(@NotNull
                                                  @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                  @NotNull
                                                  @NotNull InputStream stream)
                                           throws DistributionException

Throws:

DistributionException

getPackageInternal

@Nullable
protected abstract @Nullable DistributionPackage getPackageInternal(@NotNull
                                                                              @NotNull org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                                              @NotNull
                                                                              @NotNull String id)