weka.core

Class WekaPackageManager

java.lang.Object

weka.core.WekaPackageManager

public class WekaPackageManager
extends Object

Class providing package management and manipulation routines. Also provides a command line interface for package management.

Version:

$Revision: 9875 $

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	m_initialPackageLoadingInProcess
static boolean	m_noPackageMetaDataAvailable
static boolean	m_offline
static File	PACKAGES_DIR
static File	PROPERTIES_DIR
static File	WEKA_HOME

Constructor Summary

Constructors

Constructor and Description
WekaPackageManager()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkForMissingClasses(org.pentaho.packageManagement.Package toLoad, PrintStream... progress) Checks to see if there are any classes that we should try to instantiate before allowing this package to be loaded.
static boolean	checkForMissingFiles(org.pentaho.packageManagement.Package toLoad, File packageRoot, PrintStream... progress) Checks to see if there are any missing files/directories for a given package.
static Exception	checkForNewPackages(PrintStream... progress)
static boolean	checkForUnsetEnvVar(org.pentaho.packageManagement.Package toLoad, PrintStream... progress) Checks to see if there are any environment variables or properties that should be set at startup before allowing this package to be loaded.
static Exception	establishCacheIfNeeded(PrintStream... progress)
static List<org.pentaho.packageManagement.Dependency>	getAllDependenciesForPackage(org.pentaho.packageManagement.Package target, Map<String,List<org.pentaho.packageManagement.Dependency>> conflicts)
static List<org.pentaho.packageManagement.Package>	getAllPackages()
static List<org.pentaho.packageManagement.Package>	getAvailablePackages()
static org.pentaho.packageManagement.Package	getInstalledPackageInfo(String packageName)
static List<org.pentaho.packageManagement.Package>	getInstalledPackages()
static org.pentaho.packageManagement.Package	getPackageArchiveInfo(String packageArchivePath)
static File	getPackageHome()
static Map<String,String>	getPackageList(boolean local) Just get a list of the package names.
static URL	getPackageRepositoryURL()
static org.pentaho.packageManagement.Package	getRepositoryPackageInfo(String packageName)
static org.pentaho.packageManagement.Package	getRepositoryPackageInfo(String packageName, String version)
static List<Object>	getRepositoryPackageVersions(String packageName)
static org.pentaho.packageManagement.PackageManager	getUnderlyingPackageManager() Get the underlying package manager implementation
static boolean	installedPackageResourceExists(String packageName, String resourceName)
static String	installPackageFromArchive(String packageArchivePath, PrintStream... progress)
static boolean	installPackageFromRepository(String packageName, String version, PrintStream... progress)
static String	installPackageFromURL(URL packageURL, PrintStream... progress)
static boolean	installPackages(List<org.pentaho.packageManagement.Package> toInstall, PrintStream... progress)
static boolean	loadCheck(org.pentaho.packageManagement.Package toLoad, File packageRoot, PrintStream... progress)
static void	loadPackages(boolean verbose)
static void	loadPackages(boolean verbose, boolean refreshGOEProperties)
static void	main(String[] args)
static org.pentaho.packageManagement.Package	mostRecentVersionWithRespectToConstraint(org.pentaho.packageManagement.PackageConstraint toCheck) Find the most recent version of the package encapsulated in the supplied PackageConstraint argument that satisfies the constraint
static int	numRepositoryPackages() Get the number of packages that are available at the repository.
static Exception	refreshCache(PrintStream... progress)
static void	refreshGOEProperties()
static void	removeExplorerProps(String installedPackageName)
static int	repoZipArchiveSize() Retrieves the size (in KB) of the repository zip archive stored on the server.
static void	uninstallPackage(String packageName, boolean updateKnowledgeFlow, PrintStream... progress)

Methods inherited from class java.lang.Object

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

Field Detail

WEKA_HOME

public static File WEKA_HOME

PACKAGES_DIR

public static File PACKAGES_DIR

PROPERTIES_DIR

public static File PROPERTIES_DIR

m_offline

public static boolean m_offline

m_initialPackageLoadingInProcess

public static boolean m_initialPackageLoadingInProcess

m_noPackageMetaDataAvailable

public static boolean m_noPackageMetaDataAvailable

Constructor Detail

WekaPackageManager

public WekaPackageManager()

Method Detail

removeExplorerProps

public static void removeExplorerProps(String installedPackageName)

loadCheck

public static boolean loadCheck(org.pentaho.packageManagement.Package toLoad,
                File packageRoot,
                PrintStream... progress)

checkForUnsetEnvVar

public static boolean checkForUnsetEnvVar(org.pentaho.packageManagement.Package toLoad,
                          PrintStream... progress)

Checks to see if there are any environment variables or properties that should be set at startup before allowing this package to be loaded. This is useful for packages that might not be able to function correctly if certain variables are not set correctly.

Parameters:

toLoad - the package to check

Returns:

true if good to go

checkForMissingClasses

public static boolean checkForMissingClasses(org.pentaho.packageManagement.Package toLoad,
                             PrintStream... progress)

Checks to see if there are any classes that we should try to instantiate before allowing this package to be loaded. This is useful for checking to see if third-party classes are accessible. An example would be Java3D, which has an installer that installs into the JRE/JDK.

Parameters:

toLoad - the package to check

Returns:

true if good to go

checkForMissingFiles

public static boolean checkForMissingFiles(org.pentaho.packageManagement.Package toLoad,
                           File packageRoot,
                           PrintStream... progress)

Checks to see if there are any missing files/directories for a given package. If there are missing files, then the package can't be loaded. An example would be a connector package that, for whatever reason, can't include a necessary third-party jar file in its lib folder, and requires the user to download and install this jar file manually.

Parameters:

toLoad - the package to check

packageRoot - the root directory of the package

Returns:

true if good to go

loadPackages

public static void loadPackages(boolean verbose)

loadPackages

public static void loadPackages(boolean verbose,
                boolean refreshGOEProperties)

refreshGOEProperties

public static void refreshGOEProperties()

getUnderlyingPackageManager

public static org.pentaho.packageManagement.PackageManager getUnderlyingPackageManager()

Get the underlying package manager implementation

Returns:

the underlying concrete package management implementation.

repoZipArchiveSize

public static int repoZipArchiveSize()

Retrieves the size (in KB) of the repository zip archive stored on the server.

Returns:

the size of the repository zip archive in KB.

numRepositoryPackages

public static int numRepositoryPackages()

Get the number of packages that are available at the repository.

Returns:

the number of packages that are available (or -1 if this can't be determined for some reason.

getPackageList

public static Map<String,String> getPackageList(boolean local)

Just get a list of the package names. This is faster than calling getAllPackages(), especially if fetching from the online repository, since the full meta data for each package doesn't have to be read.

Parameters:

local - true if the local package list in the cache should be read rather than the online repository

Returns:

a Map of all the package names available either locally or at the repository

establishCacheIfNeeded

public static Exception establishCacheIfNeeded(PrintStream... progress)

checkForNewPackages

public static Exception checkForNewPackages(PrintStream... progress)

refreshCache

public static Exception refreshCache(PrintStream... progress)

installedPackageResourceExists

public static boolean installedPackageResourceExists(String packageName,
                                     String resourceName)

getPackageHome

public static File getPackageHome()

mostRecentVersionWithRespectToConstraint

public static org.pentaho.packageManagement.Package mostRecentVersionWithRespectToConstraint(org.pentaho.packageManagement.PackageConstraint toCheck)
                                                                                      throws Exception

Find the most recent version of the package encapsulated in the supplied PackageConstraint argument that satisfies the constraint

Parameters:

toCheck - the PackageConstraint containing the package in question

Returns:

the most recent version of the package satisfying the constraint

Throws:

Exception - if a version can't be found that satisfies the constraint or an error occurs while communicating with the respository

installPackages

public static boolean installPackages(List<org.pentaho.packageManagement.Package> toInstall,
                      PrintStream... progress)
                               throws Exception

Throws:

Exception

getRepositoryPackageVersions

public static List<Object> getRepositoryPackageVersions(String packageName)
                                                 throws Exception

Throws:

Exception

getPackageRepositoryURL

public static URL getPackageRepositoryURL()

getAllPackages

public static List<org.pentaho.packageManagement.Package> getAllPackages()
                                                                  throws Exception

Throws:

Exception

getAvailablePackages

public static List<org.pentaho.packageManagement.Package> getAvailablePackages()
                                                                        throws Exception

Throws:

Exception

getInstalledPackages

public static List<org.pentaho.packageManagement.Package> getInstalledPackages()
                                                                        throws Exception

Throws:

Exception

getAllDependenciesForPackage

public static List<org.pentaho.packageManagement.Dependency> getAllDependenciesForPackage(org.pentaho.packageManagement.Package target,
                                                                          Map<String,List<org.pentaho.packageManagement.Dependency>> conflicts)
                                                                                   throws Exception

Throws:

Exception

getPackageArchiveInfo

public static org.pentaho.packageManagement.Package getPackageArchiveInfo(String packageArchivePath)
                                                                   throws Exception

Throws:

Exception

getInstalledPackageInfo

public static org.pentaho.packageManagement.Package getInstalledPackageInfo(String packageName)
                                                                     throws Exception

Throws:

Exception

getRepositoryPackageInfo

public static org.pentaho.packageManagement.Package getRepositoryPackageInfo(String packageName)
                                                                      throws Exception

Throws:

Exception

getRepositoryPackageInfo

public static org.pentaho.packageManagement.Package getRepositoryPackageInfo(String packageName,
                                                             String version)
                                                                      throws Exception

Throws:

Exception

installPackageFromRepository

public static boolean installPackageFromRepository(String packageName,
                                   String version,
                                   PrintStream... progress)
                                            throws Exception

Throws:

Exception

installPackageFromArchive

public static String installPackageFromArchive(String packageArchivePath,
                               PrintStream... progress)
                                        throws Exception

Throws:

Exception

installPackageFromURL

public static String installPackageFromURL(URL packageURL,
                           PrintStream... progress)
                                    throws Exception

Throws:

Exception

uninstallPackage

public static void uninstallPackage(String packageName,
                    boolean updateKnowledgeFlow,
                    PrintStream... progress)
                             throws Exception

Throws:

Exception

main

public static void main(String[] args)