org.apache.sling.distribution.serialization.impl.vlt

Class VaultDistributionPackageBuilderFactory

java.lang.Object

org.apache.sling.distribution.serialization.impl.vlt.VaultDistributionPackageBuilderFactory

All Implemented Interfaces:

DistributionPackageBuilder

@Service(value=DistributionPackageBuilder.class)
 @Property(name="webconsole.configurationFactory.nameHint",
          value="Builder name: {name}")
public class VaultDistributionPackageBuilderFactory
extends Object
implements DistributionPackageBuilder

A package builder for Apache Jackrabbit FileVault based implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTOSAVE_THRESHOLD
static String	FILE_THRESHOLD
static String	STRICT_IMPORT_SETTINGS
static String	USE_BINARY_REFERENCES
static String	USE_OFF_HEAP_MEMORY

Constructor Summary

Constructors

Constructor and Description
VaultDistributionPackageBuilderFactory()

Method Summary

Modifier and Type	Method and Description
void	activate(org.osgi.framework.BundleContext context, Map<String,Object> config)
@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
void	deactivate()
@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
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
@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

Methods inherited from class java.lang.Object

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

Field Detail

USE_BINARY_REFERENCES

@Property(label="Use Binary References",
          description="If activated, it avoids sending binaries in the distribution package.",
          boolValue=false)
public static final String USE_BINARY_REFERENCES

See Also:

Constant Field Values

AUTOSAVE_THRESHOLD

@Property(label="Autosave threshold",
          description="The value after which autosave is triggered for intermediate changes.",
          intValue=-1)
public static final String AUTOSAVE_THRESHOLD

See Also:

Constant Field Values

FILE_THRESHOLD

@Property(label="File threshold (in bytes)",
          description="Once the data reaches the configurable size value, buffering to memory switches to file buffering.",
          intValue=1)
public static final String FILE_THRESHOLD

See Also:

Constant Field Values

USE_OFF_HEAP_MEMORY

@Property(label="Flag to enable/disable the off-heap memory",
          description="Flag to enable/disable the off-heap memory, false by default",
          boolValue=false)
public static final String USE_OFF_HEAP_MEMORY

See Also:

Constant Field Values

STRICT_IMPORT_SETTINGS

@Property(label="Install a content package in a strict mode",
          description="Flag to mark an error response will be thrown, if a content package will incorrectly installed",
          boolValue=true)
public static final String STRICT_IMPORT_SETTINGS

See Also:

Constant Field Values

Constructor Detail

VaultDistributionPackageBuilderFactory

public VaultDistributionPackageBuilderFactory()

Method Detail

activate

@Activate
public void activate(org.osgi.framework.BundleContext context,
                               Map<String,Object> config)

deactivate

@Deactivate
public void deactivate()

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

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: 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(@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