Package org.apache.jackrabbit.vault.packaging.registry.impl

Class FSPackageRegistry

java.lang.Object

org.apache.jackrabbit.vault.packaging.registry.impl.AbstractPackageRegistry

org.apache.jackrabbit.vault.packaging.registry.impl.FSPackageRegistry

All Implemented Interfaces:

InternalPackageRegistry, PackageRegistry

public class FSPackageRegistry
extends AbstractPackageRegistry

FileSystem based registry not depending on a JCR Session. All metadata is stored in Filesystem and can be prepared and used without a running JCR repository Only methods to install or uninstall packages require an active Session object of running jcr instance to perform the actual installation tasks

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.jackrabbit.vault.packaging.registry.impl.AbstractPackageRegistry

AbstractPackageRegistry.SecurityConfig

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	REPOSITORY_HOME

Fields inherited from class org.apache.jackrabbit.vault.packaging.registry.impl.AbstractPackageRegistry

ARCHIVE_PACKAGE_ROOT_PATH, DEFAULT_PACKAGE_ROOT_PATH, DEFAULT_PACKAGE_ROOT_PATH_PREFIX, securityConfig

Constructor Summary

Constructors

Constructor	Description
FSPackageRegistry()	Default constructor for OSGi initialization (homeDir defined via activator)
FSPackageRegistry(@NotNull File homeDir)	Deprecated. Use FSPackageRegistry(File, InstallationScope, SecurityConfig, boolean, boolean, IdConflictPolicy) instead
FSPackageRegistry(@NotNull File homeDir, InstallationScope scope)	Deprecated. Use FSPackageRegistry(File, InstallationScope, SecurityConfig, boolean, boolean, IdConflictPolicy) instead
FSPackageRegistry(@NotNull File homeDir, InstallationScope scope, AbstractPackageRegistry.SecurityConfig securityConfig)	Deprecated. Use FSPackageRegistry(File, InstallationScope, SecurityConfig, boolean, boolean, IdConflictPolicy) instead
FSPackageRegistry(@NotNull File homeDir, InstallationScope scope, AbstractPackageRegistry.SecurityConfig securityConfig, boolean isStrict, boolean overwritePrimaryTypesOfFolders, IdConflictPolicy defaultIdConflictPolicy)

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.framework.BundleContext context, org.apache.jackrabbit.vault.packaging.registry.impl.FSPackageRegistry.Config config)
@NotNull DependencyReport	analyzeDependencies(@NotNull PackageId id, boolean onlyInstalled)	Creates a dependency report that lists the resolved and unresolved dependencies.
boolean	contains(@NotNull PackageId id)	Checks if this registry contains the package with the given id.
void	dispatch(PackageEvent.Type type, @NotNull PackageId id, @Nullable PackageId[] related)	Dispatches a package event using the configured dispatcher.
void	installPackage(@NotNull Session session, @NotNull RegisteredPackage pkg, @NotNull ImportOptions opts, boolean extract)
@Nullable RegisteredPackage	open(@NotNull PackageId id)	Opens the package with the given id.
protected @NotNull VaultPackage	openPackageFile(@NotNull PackageId id)	Opens the package of a file with the given Id.
@NotNull Set<PackageId>	packages()	Returns as set of all packages registered in this registry.
@NotNull PackageId	register(@NotNull File file, boolean replace)	Registers a package provided via a file.
@NotNull PackageId	register(@NotNull InputStream in, boolean replace)	Registers a package provided via an input stream.
@NotNull PackageId	registerExternal(@NotNull File file, boolean replace)	Registers a package provided via an external file.
void	remove(@NotNull PackageId id)	Removes the package from this registry.
PackageId	resolve(Dependency dependency, boolean onlyInstalled)	Tries to resolve the given dependency and returns the id of the package that matches the dependency filter best.
void	setDispatcher(@Nullable PackageEventDispatcher dispatcher)	Sets the event dispatcher
void	uninstallPackage(@NotNull Session session, @NotNull RegisteredPackage pkg, @NotNull ImportOptions opts)	Uninstallation not supported for FS based PackageRegistry
protected ZipVaultPackage	upload(InputStream in, boolean replace)

Methods inherited from class org.apache.jackrabbit.vault.packaging.registry.impl.AbstractPackageRegistry

createExecutionPlan, createRandomPid, getDefaultIdConflictPolicy, getRelativeInstallationPath, getSecurityConfig, isStrictByDefault, overwritePrimaryTypesOfFoldersByDefault, usage

Methods inherited from class java.lang.Object

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

Field Detail

REPOSITORY_HOME

protected static final String REPOSITORY_HOME

See Also:

Constant Field Values

Constructor Detail

FSPackageRegistry

@Deprecated
public FSPackageRegistry(@NotNull
                         @NotNull File homeDir)
                  throws IOException

Deprecated.

Use FSPackageRegistry(File, InstallationScope, SecurityConfig, boolean, boolean, IdConflictPolicy) instead

Creates a new FSPackageRegistry based on the given home directory.

Parameters:

homeDir - the directory in which packages and their metadata is stored

Throws:

IOException - If an I/O error occurs.

FSPackageRegistry

@Deprecated
public FSPackageRegistry(@NotNull
                         @NotNull File homeDir,
                         InstallationScope scope)
                  throws IOException

Deprecated.

Use FSPackageRegistry(File, InstallationScope, SecurityConfig, boolean, boolean, IdConflictPolicy) instead

Creates a new FSPackageRegistry based on the given home directory.

Parameters:

homeDir - the directory in which packages and their metadata is stored

scope - to set a corresponding workspacefilter

Throws:

IOException - If an I/O error occurs.

FSPackageRegistry

@Deprecated
public FSPackageRegistry(@NotNull
                         @NotNull File homeDir,
                         InstallationScope scope,
                         @Nullable
                         AbstractPackageRegistry.SecurityConfig securityConfig)
                  throws IOException

Deprecated.

Use FSPackageRegistry(File, InstallationScope, SecurityConfig, boolean, boolean, IdConflictPolicy) instead

Parameters:

homeDir -

scope -

securityConfig -

Throws:

IOException

FSPackageRegistry

public FSPackageRegistry(@NotNull
                         @NotNull File homeDir,
                         InstallationScope scope,
                         @Nullable
                         AbstractPackageRegistry.SecurityConfig securityConfig,
                         boolean isStrict,
                         boolean overwritePrimaryTypesOfFolders,
                         IdConflictPolicy defaultIdConflictPolicy)
                  throws IOException

Throws:

IOException

FSPackageRegistry

public FSPackageRegistry()
                  throws IOException

Default constructor for OSGi initialization (homeDir defined via activator)

Throws:

IOException

Method Detail

activate

public void activate(org.osgi.framework.BundleContext context,
                     org.apache.jackrabbit.vault.packaging.registry.impl.FSPackageRegistry.Config config)
              throws IOException

Throws:

IOException

setDispatcher

public void setDispatcher(@Nullable
                          @Nullable PackageEventDispatcher dispatcher)

Sets the event dispatcher

Parameters:

dispatcher - the dispatcher.

dispatch

public void dispatch(@NotNull
                     PackageEvent.Type type,
                     @NotNull
                     @NotNull PackageId id,
                     @Nullable
                     @Nullable PackageId[] related)

Dispatches a package event using the configured dispatcher.

Parameters:

type - event type

id - package id

related - related packages

open

@Nullable
public @Nullable RegisteredPackage open(@NotNull
                                        @NotNull PackageId id)
                                 throws IOException

Description copied from class: AbstractPackageRegistry

Opens the package with the given id.

Specified by:

open in interface PackageRegistry

Specified by:

open in class AbstractPackageRegistry

Parameters:

id - the package id

Returns:

the package or null if it does not exists.

Throws:

IOException - if an I/O error occurs.

contains

public boolean contains(@NotNull
                        @NotNull PackageId id)
                 throws IOException

Description copied from class: AbstractPackageRegistry

Checks if this registry contains the package with the given id.

Specified by:

contains in interface PackageRegistry

Specified by:

contains in class AbstractPackageRegistry

Parameters:

id - the package id.

Returns:

true if the package is registered.

Throws:

IOException - if an I/O error occurs.

openPackageFile

@NotNull
protected @NotNull VaultPackage openPackageFile(@NotNull
                                                @NotNull PackageId id)
                                         throws IOException,
                                                NoSuchPackageException

Opens the package of a file with the given Id.

Parameters:

id - The Id of package file.

Returns:

the package

Throws:

IOException - if an I/O error occurs.

NoSuchPackageException

analyzeDependencies

@NotNull
public @NotNull DependencyReport analyzeDependencies(@NotNull
                                                     @NotNull PackageId id,
                                                     boolean onlyInstalled)
                                              throws IOException,
                                                     NoSuchPackageException

Creates a dependency report that lists the resolved and unresolved dependencies.

Specified by:

analyzeDependencies in interface PackageRegistry

Overrides:

analyzeDependencies in class AbstractPackageRegistry

Parameters:

id - the package id.

onlyInstalled - if true only installed packages are used for resolution

Returns:

the report

Throws:

IOException - if an error accessing the repository occurrs

NoSuchPackageException - if the package with the given id does not exist.

resolve

public PackageId resolve(Dependency dependency,
                         boolean onlyInstalled)
                  throws IOException

Tries to resolve the given dependency and returns the id of the package that matches the dependency filter best.

Specified by:

resolve in interface PackageRegistry

Specified by:

resolve in class AbstractPackageRegistry

Parameters:

dependency - the dependency to resolve against.

onlyInstalled - if true only installed packages are respected.

Returns:

the package id or null

Throws:

IOException - if an I/O error occurrs.

register

@NotNull
public @NotNull PackageId register(@NotNull
                                   @NotNull InputStream in,
                                   boolean replace)
                            throws IOException,
                                   PackageExistsException

Registers a package provided via an input stream. The method fails, if a package with the same id already exists, and replace is set to false. otherwise the existing package is replaced.

Specified by:

register in interface PackageRegistry

Specified by:

register in class AbstractPackageRegistry

Parameters:

in - the input stream to the package data

replace - true if existing package should be replaced.

Returns:

the new package id.

Throws:

IOException - if an I/O error occurs.

PackageExistsException - if the package exists and replace is false.

upload

protected ZipVaultPackage upload(InputStream in,
                                 boolean replace)
                          throws IOException,
                                 PackageExistsException

Throws:

IOException

PackageExistsException

register

@NotNull
public @NotNull PackageId register(@NotNull
                                   @NotNull File file,
                                   boolean replace)
                            throws IOException,
                                   PackageExistsException

Registers a package provided via a file. The method fails, if a package with the same id already exists, and replace is set to false; otherwise the existing package is replaced.

Specified by:

register in interface PackageRegistry

Specified by:

register in class AbstractPackageRegistry

Parameters:

file - the file to the package data

replace - true if existing package should be replaced.

Returns:

the new package id.

Throws:

IOException - if an I/O error occurrs.

PackageExistsException - if the package exists and replace is false.

registerExternal

@NotNull
public @NotNull PackageId registerExternal(@NotNull
                                           @NotNull File file,
                                           boolean replace)
                                    throws IOException,
                                           PackageExistsException

Description copied from class: AbstractPackageRegistry

Registers a package provided via an external file. The binary data of the package will not be copied into the underlying persistence but only be referenced. Removing such a linked package afterwards will not delete the original file. The method fails, if a package with the same id already exists, and replace is set to false; otherwise the existing package is replaced.

Specified by:

registerExternal in interface PackageRegistry

Specified by:

registerExternal in class AbstractPackageRegistry

Parameters:

file - the file to the package data.

replace - true if existing package should be replaced.

Returns:

the new package id.

Throws:

IOException - if an I/O error occurrs.

PackageExistsException - if the package exists and replace is false.

remove

public void remove(@NotNull
                   @NotNull PackageId id)
            throws IOException,
                   NoSuchPackageException

Removes the package from this registry.

Specified by:

remove in interface PackageRegistry

Specified by:

remove in class AbstractPackageRegistry

Parameters:

id - the id of the package to remove

Throws:

IOException - if an I/O error occurrs.

NoSuchPackageException - if the package does not exist

packages

@NotNull
public @NotNull Set<PackageId> packages()
                                 throws IOException

Returns as set of all packages registered in this registry.

Specified by:

packages in interface PackageRegistry

Specified by:

packages in class AbstractPackageRegistry

Returns:

a set of package ids.

Throws:

IOException - if an I/O error occurs.

installPackage

public void installPackage(@NotNull
                           @NotNull Session session,
                           @NotNull
                           @NotNull RegisteredPackage pkg,
                           @NotNull
                           @NotNull ImportOptions opts,
                           boolean extract)
                    throws IOException,
                           PackageException

Specified by:

installPackage in interface InternalPackageRegistry

Specified by:

installPackage in class AbstractPackageRegistry

Throws:

IOException

PackageException

uninstallPackage

public void uninstallPackage(@NotNull
                             @NotNull Session session,
                             @NotNull
                             @NotNull RegisteredPackage pkg,
                             @NotNull
                             @NotNull ImportOptions opts)
                      throws IOException,
                             PackageException

Uninstallation not supported for FS based PackageRegistry

Specified by:

uninstallPackage in interface InternalPackageRegistry

Specified by:

uninstallPackage in class AbstractPackageRegistry

Throws:

IOException

PackageException