org.expath.pkg.repo

Class Extension

java.lang.Object

org.expath.pkg.repo.Extension

Direct Known Subclasses:

DescriptorExtension

public abstract class Extension
extends java.lang.Object

An extension to the packaging system. This abstract class represents the various callback points where a specific extension can perform steps specific to the extension, both to initialize a Package object in memory, and to store additional information in the repository at install time.

Author:

Florent Georges

Constructor Summary

Constructors

Constructor and Description
Extension(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
void	init(Repository repo, java.util.Map<java.lang.String,Packages> packages) Deprecated.
abstract void	init(Repository repo, Package pkg) Initialize a package for a specific extension.
abstract void	install(Repository repo, Package pkg) Additional installation actions needed by a specific extension.

Methods inherited from class java.lang.Object

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

Constructor Detail

Extension

public Extension(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

init

@Deprecated
public void init(Repository repo,
                             java.util.Map<java.lang.String,Packages> packages)
                      throws PackageException

Deprecated.

Throws:

PackageException

init

public abstract void init(Repository repo,
                          Package pkg)
                   throws PackageException

Initialize a package for a specific extension. When loading a package from the repository, an extension has a chance to initialize it. For instance by parsing an extension-specific descriptor. This function is not supposed to modify the state of the repository, like install() does.

Parameters:

repo - the repository

pkg - the package descriptor

Throws:

PackageException - if an error occurs

install

public abstract void install(Repository repo,
                             Package pkg)
                      throws PackageException

Additional installation actions needed by a specific extension. When installing a new package in the repository, an extension has a chance to perform additional actions. For instance caching additional management information in extension-specific files in the repository. This function is supposed to initialize the Package object as well, like init() does.

Parameters:

repo - the repository

pkg - the package descriptor

Throws:

PackageException - if an error occurs