DefaultPackageManager (weka-dev r12729 API)

java.lang.Object
- weka.core.packageManagement.PackageManager
- - weka.core.packageManagement.DefaultPackageManager

```
public class DefaultPackageManager
extends PackageManager
```
A concrete implementation of PackageManager that uses Java properties files/class to manage package meta data. Assumes that meta data for individual packages is stored on the central repository (accessible via http) in properties files that live in a subdirectory with the same name as the package. Furthermore, each property file is assumed to be named as the version number of the package in question with a ".props" extension. A "Latest.props" file should exist for each package and should always hold meta data on the latest version of a package.

Version:

$Revision: 52515 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

Constructor Summary

Constructors
Constructor and Description

DefaultPackageManager()
Constructor

Constructors
Constructor and Description
`DefaultPackageManager()` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applySettings(Settings settings)` Apply settings.
`static void`	`deleteDir(File dir, PrintStream... progress)`
`List<Dependency>`	`getAllDependenciesForPackage(Package target, Map<String,List<Dependency>> conflicts)` Gets a full list of packages (encapsulated in Dependency objects) that are required by directly and indirectly by the named target package.
`List<Package>`	`getAllPackages(PrintStream... progress)` Get all packages that the system knows about (i.e.
`List<Package>`	`getAvailablePackages()` Get a list of packages that are not currently installed.
`Defaults`	`getDefaultSettings()` Get the default settings for the default package manager
`Package`	`getInstalledPackageInfo(String packageName)` Get package information on the named installed package.
`List<Package>`	`getInstalledPackages()` Get a list of installed packages.
`Package`	`getPackageArchiveInfo(String packageArchivePath)` Get package information from the supplied package archive file.
`Package`	`getRepositoryPackageInfo(String packageName)` Get package information on the named package from the repository.
`Package`	`getRepositoryPackageInfo(String packageName, Object version)` Get package information on the named package from the repository.
`byte[]`	`getRepositoryPackageMetaDataOnlyAsZip(PrintStream... progress)` Gets an array of bytes containing a zip of all the repository meta data and supporting files.
`byte[]`	`getRepositoryPackageMetaDataOnlyAsZipLegacy(PrintStream... progress)` Gets an array of bytes containing a zip of all the repository meta data and supporting files using the legacy approach.
`List<Object>`	`getRepositoryPackageVersions(String packageName)` Get a list of available versions of the named package.
`Package`	`getURLPackageInfo(URL packageURL)` Get package information on the package at the given URL.
`String`	`installPackageFromArchive(String packageArchivePath, PrintStream... progress)` Install a package from an archive on the local file system.
`void`	`installPackageFromRepository(String packageName, Object version, PrintStream... progress)` Install a package sourced from the repository.
`String`	`installPackageFromURL(URL packageURL, PrintStream... progress)` Install a package sourced from a given URL.
`void`	`installPackages(List<Package> toInstall, PrintStream... progress)` Installs all the packages in the supplied list.
`static void`	`main(String[] args)`
`void`	`uninstallPackage(String packageName, PrintStream... progress)` Uninstall a package.

Methods inherited from class weka.core.packageManagement.PackageManager
create, establishProxy, getBaseSystemName, getBaseSystemVersion, getPackageHome, getPackageRepositoryURL, getProxy, setBaseSystemName, setBaseSystemVersion, setPackageHome, setPackageRepositoryURL, setProxy, setProxyAuthentication, setProxyPassword, setProxyUsername

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultPackageManager
```
public DefaultPackageManager()
```
    Constructor
- Method Detail
  - getDefaultSettings
```
public Defaults getDefaultSettings()
```
    Get the default settings for the default package manager
    
    Overrides:
    
    getDefaultSettings in class PackageManager
    
    Returns:
    
    the default settings
  - applySettings
```
public void applySettings(Settings settings)
```
    Apply settings.
    
    Overrides:
    
    applySettings in class PackageManager
    
    Parameters:
    
    settings - the settings to apply
  - getURLPackageInfo
```
public Package getURLPackageInfo(URL packageURL)
                          throws Exception
```
    Get package information on the package at the given URL.
    
    Specified by:
    
    getURLPackageInfo in class PackageManager
    
    Parameters:
    
    packageURL - the URL to the package.
    
    Returns:
    
    a Package object encapsulating the package meta data
    
    Throws:
    
    Exception - if the package meta data can't be retrieved.
  - getRepositoryPackageInfo
```
public Package getRepositoryPackageInfo(String packageName)
                                 throws Exception
```
    Get package information on the named package from the repository. If multiple versions of the package are available, it assumes that the most recent is required.
    
    Specified by:
    
    getRepositoryPackageInfo in class PackageManager
    
    Parameters:
    
    packageName - the name of the package to get information about.
    
    Returns:
    
    a Package object encapsulating the package meta data.
    
    Throws:
    
    Exception - if the package meta data can't be retrieved.
  - getRepositoryPackageVersions
```
public List<Object> getRepositoryPackageVersions(String packageName)
                                          throws Exception
```
    Get a list of available versions of the named package.
    
    Specified by:
    
    getRepositoryPackageVersions in class PackageManager
    
    Parameters:
    
    packageName - the name of the package to get versions.
    
    Returns:
    
    a list of available versions (or null if not applicable)
    
    Throws:
    
    Exception - if something goes wrong while trying to retrieve the list of versions.
  - getRepositoryPackageInfo
```
public Package getRepositoryPackageInfo(String packageName,
                                        Object version)
                                 throws Exception
```
    Get package information on the named package from the repository.
    
    Specified by:
    
    getRepositoryPackageInfo in class PackageManager
    
    Parameters:
    
    packageName - the name of the package to get information about.
    
    version - the version of the package to retrieve (may be null if not applicable).
    
    Returns:
    
    a Package object encapsulating the package meta data.
    
    Throws:
    
    Exception - if the package meta data can't be retrieved.
  - getPackageArchiveInfo
```
public Package getPackageArchiveInfo(String packageArchivePath)
                              throws Exception
```
    Get package information from the supplied package archive file.
    
    Specified by:
    
    getPackageArchiveInfo in class PackageManager
    
    Parameters:
    
    packageArchivePath - the path to the package archive file
    
    Returns:
    
    a Package object encapsulating the package meta data.
    
    Throws:
    
    Exception - if the package meta data can't be retrieved.
  - getInstalledPackageInfo
```
public Package getInstalledPackageInfo(String packageName)
                                throws Exception
```
    Get package information on the named installed package.
    
    Specified by:
    
    getInstalledPackageInfo in class PackageManager
    
    Parameters:
    
    packageName - the name of the package to get information about.
    
    Returns:
    
    a Package object encapsulating the package meta data or null if the package is not installed.
    
    Throws:
    
    Exception - if the package meta data can't be retrieved.
  - deleteDir
```
public static void deleteDir(File dir,
                             PrintStream... progress)
                      throws Exception
```
    Throws:
    
    Exception
  - uninstallPackage
```
public void uninstallPackage(String packageName,
                             PrintStream... progress)
                      throws Exception
```
    Uninstall a package.
    
    Specified by:
    
    uninstallPackage in class PackageManager
    
    Parameters:
    
    packageName - the package to uninstall.
    
    progress - optional varargs parameter, that, if supplied, is expected to contain one or more PrintStream objects to write progress to.
    
    Throws:
    
    Exception - if the named package could not be removed for some reason.
  - installPackageFromArchive
```
public String installPackageFromArchive(String packageArchivePath,
                                        PrintStream... progress)
                                 throws Exception
```
    Install a package from an archive on the local file system.
    
    Specified by:
    
    installPackageFromArchive in class PackageManager
    
    Parameters:
    
    packageArchivePath - the path to the package archive file.
    
    progress - optional varargs parameter, that, if supplied, is expected to contain one or more PrintStream objects to write progress to.
    
    Returns:
    
    the name of the package installed
    
    Throws:
    
    Exception - if the package can't be installed for some reason.
  - installPackages
```
public void installPackages(List<Package> toInstall,
                            PrintStream... progress)
                     throws Exception
```
    Installs all the packages in the supplied list.
    
    Specified by:
    
    installPackages in class PackageManager
    
    Parameters:
    
    toInstall - a list of Packages to install.
    
    progress - optional varargs parameter, that, if supplied, is expected to contain one or more PrintStream objects to write progress to.
    
    Throws:
    
    Exception - if something goes wrong during the installation process.
  - getAllDependenciesForPackage
```
public List<Dependency> getAllDependenciesForPackage(Package target,
                                                     Map<String,List<Dependency>> conflicts)
                                              throws Exception
```
    Gets a full list of packages (encapsulated in Dependency objects) that are required by directly and indirectly by the named target package. Also builds a Map of any packages that are required by more than one package and where there is a conflict of some sort (e.g. multiple conflicting versions). The keys of this map are package names (strings), and each associated value is a list of Dependency objects.
    
    Specified by:
    
    getAllDependenciesForPackage in class PackageManager
    
    Parameters:
    
    target - the package for which a list of dependencies is required.
    
    conflicts - will hold any conflicts that are discovered while building the full dependency list.
    
    Returns:
    
    a list of packages that are directly and indirectly required by the named target package.
    
    Throws:
    
    Exception - if a problem occurs while building the dependency list.
  - installPackageFromRepository
```
public void installPackageFromRepository(String packageName,
                                         Object version,
                                         PrintStream... progress)
                                  throws Exception
```
    Install a package sourced from the repository.
    
    Specified by:
    
    installPackageFromRepository in class PackageManager
    
    Parameters:
    
    packageName - the name of the package to install
    
    version - the version of the package to install (may be null if not applicable).
    
    progress - optional varargs parameter, that, if supplied, is expected to contain one or more PrintStream objects to write progress to.
    
    Throws:
    
    Exception - if the package can't be installed for some reason.
  - installPackageFromURL
```
public String installPackageFromURL(URL packageURL,
                                    PrintStream... progress)
                             throws Exception
```
    Install a package sourced from a given URL.
    
    Specified by:
    
    installPackageFromURL in class PackageManager
    
    Parameters:
    
    packageURL - the URL to the package.
    
    progress - optional varargs parameter, that, if supplied, is expected to contain one or more PrintStream objects to write progress to.
    
    Returns:
    
    the name of the package installed
    
    Throws:
    
    Exception - if the package can't be installed for some reason.
  - getRepositoryPackageMetaDataOnlyAsZip
```
public byte[] getRepositoryPackageMetaDataOnlyAsZip(PrintStream... progress)
                                             throws Exception
```
    Gets an array of bytes containing a zip of all the repository meta data and supporting files. Does *not* contain any package archives etc., only a snapshot of the meta data. Could be used by clients to establish a cache of meta data.
    
    Specified by:
    
    getRepositoryPackageMetaDataOnlyAsZip in class PackageManager
    
    Parameters:
    
    progress - optional varargs parameter, that, if supplied, is expected to contain one or more PrintStream objects to write progress to.
    
    Returns:
    
    a zip compressed array of bytes.
    
    Throws:
    
    Exception - if the repository meta data can't be returned as a zip
  - getRepositoryPackageMetaDataOnlyAsZipLegacy
```
public byte[] getRepositoryPackageMetaDataOnlyAsZipLegacy(PrintStream... progress)
                                                   throws Exception
```
    Gets an array of bytes containing a zip of all the repository meta data and supporting files using the legacy approach. Does *not* contain any package archives etc., only a snapshot of the meta data. Could be used by clients to establish a cache of meta data.
    
    Returns:
    
    a zip compressed array of bytes.
    
    Throws:
    
    Exception
  - getAllPackages
```
public List<Package> getAllPackages(PrintStream... progress)
                             throws Exception
```
    Get all packages that the system knows about (i.e. all packages contained in the repository).
    
    Specified by:
    
    getAllPackages in class PackageManager
    
    Parameters:
    
    progress - optional varargs parameter, that, if supplied is expected to contain one or more PrintStream objects to write progress to.
    
    Returns:
    
    a list of all packages.
    
    Throws:
    
    Exception - if a list of packages can't be determined.
  - getAvailablePackages
```
public List<Package> getAvailablePackages()
                                   throws Exception
```
    Get a list of packages that are not currently installed.
    
    Specified by:
    
    getAvailablePackages in class PackageManager
    
    Returns:
    
    a list of packages that are not currently installed.
    
    Throws:
    
    Exception - if a list of packages can't be determined.
  - getInstalledPackages
```
public List<Package> getInstalledPackages()
                                   throws Exception
```
    Get a list of installed packages.
    
    Specified by:
    
    getInstalledPackages in class PackageManager
    
    Returns:
    
    a list of installed packages.
    
    Throws:
    
    Exception - if a list of packages can't be determined.
  - main
```
public static void main(String[] args)
```

Class DefaultPackageManager

Constructor Summary

Method Summary

Methods inherited from class weka.core.packageManagement.PackageManager

Methods inherited from class java.lang.Object

Constructor Detail

DefaultPackageManager

Method Detail

getDefaultSettings

applySettings

getURLPackageInfo

getRepositoryPackageInfo

getRepositoryPackageVersions

getRepositoryPackageInfo

getPackageArchiveInfo

getInstalledPackageInfo

deleteDir

uninstallPackage

installPackageFromArchive

installPackages

getAllDependenciesForPackage

installPackageFromRepository

installPackageFromURL

getRepositoryPackageMetaDataOnlyAsZip

getRepositoryPackageMetaDataOnlyAsZipLegacy

getAllPackages

getAvailablePackages

getInstalledPackages

main