org.expath.pkg.repo

Class ClasspathStorage

java.lang.Object

org.expath.pkg.repo.Storage

org.expath.pkg.repo.ClasspathStorage

public class ClasspathStorage
extends Storage

Storage using the classpath.

Author:

Florent Georges

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClasspathStorage.ClasspathResolver

Nested classes/interfaces inherited from class org.expath.pkg.repo.Storage

Storage.NotExistException, Storage.PackageResolver

Constructor Summary

Constructors

Constructor and Description
ClasspathStorage(java.lang.String root)

Method Summary

Modifier and Type	Method and Description
void	beforeInstall(boolean force, UserInteractionStrategy interact) The opportunity to do anything before the install of a package.
boolean	isReadOnly() Return whether this storage is read-only.
java.util.Set<java.lang.String>	listPackageDirectories() Return the list of installed packages.
Storage.PackageResolver	makePackageResolver(java.lang.String rsrc_name, java.lang.String abbrev) Return a resolver for a specific package.
java.nio.file.Path	makeTempDir(java.lang.String prefix) Create a temporary directory.
boolean	packageKeyExists(java.lang.String key) Each package in a repository can be identified by a unique key.
void	remove(Package pkg) Remove a package.
void	storeInstallDir(java.nio.file.Path dir, java.lang.String key, Package pkg) Actually store the package in the storage.
java.lang.String	toString()
void	updatePackageLists(Package pkg) The package has just been install, record the information if needed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathStorage

public ClasspathStorage(java.lang.String root)

Parameters:

root - The common prefix for all resources.

Method Detail

isReadOnly

public boolean isReadOnly()

Description copied from class: Storage

Return whether this storage is read-only.

Specified by:

isReadOnly in class Storage

Returns:

true if read only

makePackageResolver

public Storage.PackageResolver makePackageResolver(java.lang.String rsrc_name,
                                                   java.lang.String abbrev)
                                            throws PackageException

Description copied from class: Storage

Return a resolver for a specific package.

Specified by:

makePackageResolver in class Storage

Parameters:

rsrc_name - is the name of the resource representing the package. For instance, on the filesystem that is the name of the root directory, and in the classpath that is the name of the root package (in the Java sense).

abbrev - is the abbrev of the package (as in the package descriptor, and must match the module dir within the package).

Returns:

the package resolver

Throws:

PackageException - if an error occurs

listPackageDirectories

public java.util.Set<java.lang.String> listPackageDirectories()
                                                       throws PackageException

Description copied from class: Storage

Return the list of installed packages. The returned list is the list of the package directories within the repository.

Specified by:

listPackageDirectories in class Storage

Returns:

the list of installed packages

Throws:

PackageException - if an error occurs

beforeInstall

public void beforeInstall(boolean force,
                          UserInteractionStrategy interact)
                   throws PackageException

Description copied from class: Storage

The opportunity to do anything before the install of a package. If installation is not supported (because the storage is read-only), this method must throw an exception.

Specified by:

beforeInstall in class Storage

Parameters:

force - true to force

interact - the user interaction strategy

Throws:

PackageException - if an error occurs

makeTempDir

public java.nio.file.Path makeTempDir(java.lang.String prefix)
                               throws PackageException

Description copied from class: Storage

Create a temporary directory.

Specified by:

makeTempDir in class Storage

Parameters:

prefix - prefix for the temporary directory

Returns:

the path to the temporary directory

Throws:

PackageException - if an error occurs

packageKeyExists

public boolean packageKeyExists(java.lang.String key)
                         throws PackageException

Description copied from class: Storage

Each package in a repository can be identified by a unique key. The key is computed based on the package abbrev, and is unique. Typically it is used to create a directory or a collection, which requires to have a unique string without '/'.

Specified by:

packageKeyExists in class Storage

Parameters:

key - the package key to check for.

Returns:

true of the package key exists.

Throws:

PackageException - if an error occurs

storeInstallDir

public void storeInstallDir(java.nio.file.Path dir,
                            java.lang.String key,
                            Package pkg)
                     throws PackageException

Description copied from class: Storage

Actually store the package in the storage. During install, the package is unzipped in a temporary directory on the file system. This method receives that directory and the package key to use, and actually take control over the temporary directory. It can rename the directory to its final place (does not need to copy it). If it is not using the temporary directory anymore, it must delete it.

Specified by:

storeInstallDir in class Storage

Parameters:

dir - the temporary directory where the package was unzipped

key - the package key

pkg - the package descriptor

Throws:

PackageException - if an error occurs

updatePackageLists

public void updatePackageLists(Package pkg)
                        throws PackageException

Description copied from class: Storage

The package has just been install, record the information if needed.

Specified by:

updatePackageLists in class Storage

Parameters:

pkg - the package descriptor

Throws:

PackageException - if an error occurs

remove

public void remove(Package pkg)
            throws PackageException

Description copied from class: Storage

Remove a package.

Specified by:

remove in class Storage

Parameters:

pkg - the package descriptor.

Throws:

PackageException - if an error occurs

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object