org.apache.sling.distribution.monitor.impl

Class MonitoringDistributionPackageBuilder

java.lang.Object

org.apache.sling.distribution.monitor.impl.MonitoringDistributionPackageBuilder

All Implemented Interfaces:

DistributionPackageBuilder

public final class MonitoringDistributionPackageBuilder
extends Object
implements DistributionPackageBuilder

Constructor Summary

Constructors

Constructor and Description
MonitoringDistributionPackageBuilder(int queueCapacity, DistributionPackageBuilder wrapped, org.osgi.framework.BundleContext context)

Method Summary

Modifier and Type	Method and Description
void	clear()
DistributionPackage	createPackage(org.apache.sling.api.resource.ResourceResolver resourceResolver, org.apache.sling.distribution.DistributionRequest request) creates a DistributionPackage for a specific DistributionRequest
DistributionPackage	getPackage(org.apache.sling.api.resource.ResourceResolver resourceResolver, 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(org.apache.sling.api.resource.ResourceResolver resourceResolver, DistributionPackage distributionPackage) Installs the given distributionPackage into the repository
DistributionPackageInfo	installPackage(org.apache.sling.api.resource.ResourceResolver resourceResolver, InputStream stream) install a stream and returns the associated to a DistributionPackageInfo this provider can read and install
DistributionPackage	readPackage(org.apache.sling.api.resource.ResourceResolver resourceResolver, InputStream stream) reads a stream and tries to convert it to a DistributionPackage this provider can read and install

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitoringDistributionPackageBuilder

public MonitoringDistributionPackageBuilder(int queueCapacity,
                                            DistributionPackageBuilder wrapped,
                                            org.osgi.framework.BundleContext context)

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

@Nonnull
public DistributionPackage createPackage(@Nonnull
                                                  org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                  @Nonnull
                                                  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

@Nonnull
public DistributionPackage readPackage(@Nonnull
                                                org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                @Nonnull
                                                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

getPackage

public DistributionPackage getPackage(@Nonnull
                                      org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                      @Nonnull
                                      String id)
                               throws DistributionException

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

Throws:

DistributionException - when the stream the package with that id cannot be retrieved

installPackage

public boolean installPackage(@Nonnull
                              org.apache.sling.api.resource.ResourceResolver resourceResolver,
                              @Nonnull
                              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

@Nonnull
public DistributionPackageInfo installPackage(@Nonnull
                                                       org.apache.sling.api.resource.ResourceResolver resourceResolver,
                                                       @Nonnull
                                                       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

clear

public void clear()