org.expath.pkg.repo

Class Repository

java.lang.Object

org.expath.pkg.repo.Repository

All Implemented Interfaces:

Universe

@ThreadSafe
public class Repository
extends java.lang.Object
implements Universe

Represent a standard EXPath package repository structure on the disk. TODO: Because we have a repository descriptor with the list of installed packages (by the spec: .expath-pkg/packages.txt and .expath-pkg/packages.xml), we don't have to parse all the package descriptors in the repository at the instantiation of the object. We can instead create "fake" packages with only the information from the repository descriptor, and parse the whole package descriptor only when the user ask for that package. That way, the creation of a Repository object just needs to parse the repository descriptor, and parses the package descriptors only as needed.

Author:

Florent Georges

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Repository.AlreadyInstalledException Exception raised when trying to install a package already installed.
static class	Repository.HttpException Exception raised when receiving 404 when trying to read a package on the web.
static class	Repository.NotFoundException Exception raised when receiving 404 when trying to read a package on the web.
static class	Repository.OnlineException Exception raised when receiving an error when trying to read a package on the web.

Constructor Summary

Constructors

Constructor and Description
Repository(Storage storage)

Method Summary

Modifier and Type	Method and Description
static Repository	createRepository(java.nio.file.Path dir) Create a repository.
Packages	getPackages(java.lang.String name)
Storage	getStorage() Get the repository storage.
java.util.List<PackageException>	init() Initialise the repository.
Package	installPackage(java.net.URI pkg, boolean force, UserInteractionStrategy interact) Install a XAR package into this repository, from a URI location.
Package	installPackage(XarSource xarSource, boolean force, UserInteractionStrategy interact) Install a XAR package into this repository.
java.util.Collection<Packages>	listPackages()
static Repository	makeDefaultRepo() Shortcut for makeDefaultRepo(null).
static Repository	makeDefaultRepo(java.lang.String dir) Return a repository instantiated from default location.
void	registerExtension(Extension ext) Register an extension.
java.util.List<PackageException>	reload() Reload the repository configuration, so parse again the package descriptors.
boolean	removePackage(java.lang.String pkg, boolean force, UserInteractionStrategy interact) Remove a package from the repository, by name.
boolean	removePackage(java.lang.String pkg, java.lang.String version, boolean force, UserInteractionStrategy interact) Remove a package from the repository, by name and version.
javax.xml.transform.Source	resolve(java.lang.String href, URISpace space) Resolve a URI in this repository, in the specified space, return a File.
javax.xml.transform.Source	resolve(java.lang.String href, URISpace space, boolean transitive) Resolve a specific URI, in a specific space, into a stream source.

Methods inherited from class java.lang.Object

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

Constructor Detail

Repository

public Repository(Storage storage)

Method Detail

init

public java.util.List<PackageException> init()

Initialise the repository.

Returns:

any package exceptions that occur whilst trying to find the packages.

makeDefaultRepo

public static Repository makeDefaultRepo()
                                  throws PackageException

Shortcut for makeDefaultRepo(null).

Returns:

the repository

Throws:

PackageException - if an error occurs

makeDefaultRepo

public static Repository makeDefaultRepo(java.lang.String dir)
                                  throws PackageException

Return a repository instantiated from default location. If the parameter is not null, it uses it. If not, then looks at the system property expath.repo, and if it is not set at the environment variable EXPATH_REPO. This string is interpreted as a directory path, which must point to a repository. It throws an exception if the the directory does not exist (or is not a directory), or if there is any error creating the repository object from it.

Parameters:

dir - the repository dir

Returns:

the repository

Throws:

PackageException - if an error occurs

registerExtension

public final void registerExtension(Extension ext)
                             throws PackageException

Register an extension.

Parameters:

ext - the extension

Throws:

PackageException - if an error occurs

reload

public java.util.List<PackageException> reload()

Reload the repository configuration, so parse again the package descriptors.

Returns:

any package exceptions that occur whilst trying to find the packages.

getStorage

public Storage getStorage()

Get the repository storage.

Returns:

The Storage object this repository is based upon.

listPackages

public java.util.Collection<Packages> listPackages()

getPackages

public Packages getPackages(java.lang.String name)

createRepository

public static Repository createRepository(java.nio.file.Path dir)
                                   throws PackageException

Create a repository. TODO: Must be delegated to the storage!

Parameters:

dir - the repository dir

Returns:

the repository

Throws:

PackageException - if an error occurs

installPackage

public Package installPackage(java.net.URI pkg,
                              boolean force,
                              UserInteractionStrategy interact)
                       throws PackageException

Install a XAR package into this repository, from a URI location. TODO: Anything to delegate to the storage?

Parameters:

pkg - The package file (typically a *.xar or *.xaw file).

force - If force is false, this is an error if the same package has already been installed in the repository. If it is true, it is first deleted if existing.

interact - How the repository interacts with the user.

Returns:

The freshly installed package.

Throws:

PackageException - If any error occurs.

installPackage

public Package installPackage(XarSource xarSource,
                              boolean force,
                              UserInteractionStrategy interact)
                       throws PackageException

Install a XAR package into this repository. TODO: In case of exception, the temporary dir is not removed, solve that.

Parameters:

xarSource - A source for the package file (typically a *.xar or *.xaw file).

force - If force is false, this is an error if the same package has already been installed in the repository. If it is true, it is first deleted if existing.

interact - How the repository interacts with the user.

Returns:

The freshly installed package.

Throws:

PackageException - If any error occurs.

removePackage

public boolean removePackage(java.lang.String pkg,
                             boolean force,
                             UserInteractionStrategy interact)
                      throws PackageException

Remove a package from the repository, by name. If a package with that name does not exist, or if there are several versions installed, this is an error (except if the package does not exist and force is true, then simply returns false).

Parameters:

pkg - The package name.

force - To silently ignore a non existing package (simply returns false in that case).

interact - How the repository interacts with the user.

Returns:

True if the package has been successfully removed, false if not (false is returned when the user canceled removing interactively, or if the package does not exist and force is true).

Throws:

PackageException - If any error occurs during removal.

removePackage

public boolean removePackage(java.lang.String pkg,
                             java.lang.String version,
                             boolean force,
                             UserInteractionStrategy interact)
                      throws PackageException

Remove a package from the repository, by name and version. If a package with that name and that version does not exist, this is an error, except if the package does not exist and force is true (then it simply returns false).

Parameters:

pkg - The package name.

version - The package version.

force - To silently ignore a non existing package (simply returns false in that case).

interact - How the repository interacts with the user.

Returns:

True if the package has been successfully removed, false if not (false is returned when the user canceled removing interactively, or if the package does not exist and force is true).

Throws:

PackageException - If any error occurs during removal.

resolve

public javax.xml.transform.Source resolve(java.lang.String href,
                                          URISpace space)
                                   throws PackageException

Resolve a URI in this repository, in the specified space, return a File. For each package, use only the latest version. TODO: What about the packages with a versionning scheme which does NOT follow SemVer? (because basically those are not ordered) TODO: And when we want to resolve into a specific version? For instance when we are evaluating within the context of a specific package, and we want to resolve only in its declared dependencies? Or at least to use the versionning of its dependencies to guide within which package we should search (instead of taking always the latest systematically). Same comments for SaxonRepository.

Specified by:

resolve in interface Universe

Parameters:

href - the URI

space - the URI space

Returns:

the source

Throws:

PackageException - if an error occurs

resolve

public javax.xml.transform.Source resolve(java.lang.String href,
                                          URISpace space,
                                          boolean transitive)
                                   throws PackageException

Description copied from interface: Universe

Resolve a specific URI, in a specific space, into a stream source.

Specified by:

resolve in interface Universe

Parameters:

href - the URI

space - the URI space

transitive - true if package dependencies are used to resolve the href

Returns:

the source

Throws:

PackageException - if an error occurs