org.gvsig.installer.lib.api.execution

Interface InstallPackageService

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultInstallPackageService

public interface InstallPackageService
extends Service

This service is used to read a bundle file and install the packages contained in it. It has methods to read the packages contained in a bundle and to install one of them.

The bundle is a file that has been created using the MakePluginPackageService service. It is possible to create an installer manually, but it has to have the structure defined by the InstallerManager class.

Method Summary

Modifier and Type	Method and Description
void	addBundle(java.io.File bundleFile, SimpleTaskStatus taskStatus) Adds a the URI of a bundle that contains some packages to install.
void	addBundle(java.net.URL bundleURL, SimpleTaskStatus taskStatus) Adds a URL of a bundle that contains some packages to install.
void	addBundlesFromDirectory(java.io.File bundlesDirectory, SimpleTaskStatus taskStatus) In reads a directory and reads all the bundles.
void	downloadPackage(PackageInfo packageInfo, SimpleTaskStatus taskStatus) Download the package and register it in the manager.
java.util.List<java.lang.String>	getCategories() Gets the list of all the categories of *all* the packages.
java.util.List<java.lang.String>	getDefaultSelectedPackagesIDs()
int	getPackageCount()
PackageInfo	getPackageInfo(int index) Return the package information for a concrete position.
PackageInfo	getPackageInfo(java.lang.String packageCode) Return the package information for a concrete position.
java.util.Properties	getProperties() Get the proprties associates to this bundle.
java.util.List<java.lang.String>	getTypes() Gets the list of different the types of *all* the packages.
void	installPackage(java.io.File applicationDirectory, PackageInfo packageInfo) Install a package in a concrete gvSIG installation directory.
void	installPackage(java.io.File applicationDirectory, java.lang.String packageCode) Install a package in a concrete gvSIG installation directory.
void	installPackageProviders(SimpleTaskStatus taskStatus)
boolean	needInstallPackageProviders()
void	reset()

Methods inherited from interface org.gvsig.tools.service.Service

getManager

Method Detail

reset

void reset()

addBundle

void addBundle(java.io.File bundleFile,
               SimpleTaskStatus taskStatus)
        throws InstallPackageServiceException

Adds a the URI of a bundle that contains some packages to install. A bundle is a compressed zip file with a structure defined in the InstallerManager class.

Parameters:

bundleFile -

taskStatus -

Throws:

InstallPackageServiceException - it is thrown if there is an exception reading the URI.

addBundle

void addBundle(java.net.URL bundleURL,
               SimpleTaskStatus taskStatus)
        throws InstallPackageServiceException

Adds a URL of a bundle that contains some packages to install. A bundle is a compressed zip file with a structure defined in the InstallerManager class.

Parameters:

bundleURL - the URL of a bundle.

taskStatus -

Throws:

InstallPackageServiceException - it is thrown if there is an exception reading the URL .

addBundlesFromDirectory

void addBundlesFromDirectory(java.io.File bundlesDirectory,
                             SimpleTaskStatus taskStatus)
                      throws InstallPackageServiceException

In reads a directory and reads all the bundles. This method retrieve all the information of the packages located in the bundles and allows to the user to show this information.

Parameters:

bundlesDirectory - a directory that contains bundles.

taskStatus -

Throws:

InstallPackageServiceException - If there is any problem reading the directory of bundles.

installPackage

void installPackage(java.io.File applicationDirectory,
                    PackageInfo packageInfo)
             throws InstallPackageServiceException

Install a package in a concrete gvSIG installation directory. The selected package has to be contained in one of the bundles that has been previously added using the #addBundle(File) or the #addBundlesFromDirectory(File) method.

Parameters:

applicationDirectory - a valid root directory where an instance og gvSIG is installed.

packageInfo - the package to install.

Throws:

InstallPackageServiceException - If there is an error installing the package.

installPackage

void installPackage(java.io.File applicationDirectory,
                    java.lang.String packageCode)
             throws InstallPackageServiceException

Install a package in a concrete gvSIG installation directory. The selected package has to be contained in one of the bundles that has been previously added using the #addBundle(File) or the #addBundlesFromDirectory(File) method.

Parameters:

applicationDirectory - a valid root directory where an instance og gvSIG is installed.

packageCode - the code of the package.

Throws:

InstallPackageServiceException - if there is an error installing the PackageInfo#

getPackageCount

int getPackageCount()

Returns:

the number of packages that has been loaded form one or more bundles using the #addBundle(File) or the #addBundlesFromDirectory(File) method.

getPackageInfo

PackageInfo getPackageInfo(int index)

Return the package information for a concrete position. All the packages has been loaded form one or more bundles using the #addBundle(File) or the #addBundlesFromDirectory(File) method.

Parameters:

index - the position of the package.

Returns:

the information of a package. returns null if the package doesn't exist.

getPackageInfo

PackageInfo getPackageInfo(java.lang.String packageCode)

Return the package information for a concrete position. All the packages has been loaded form one or more bundles using the #addBundle(File) or the #addBundlesFromDirectory(File) method.

Parameters:

packageCode - the code of the package.

Returns:

the information of a package. returns null if the package doesn't exist.

downloadPackage

void downloadPackage(PackageInfo packageInfo,
                     SimpleTaskStatus taskStatus)
              throws InstallPackageServiceException

Download the package and register it in the manager.

Parameters:

packageInfo -

Throws:

InstallPackageServiceException

getDefaultSelectedPackagesIDs

java.util.List<java.lang.String> getDefaultSelectedPackagesIDs()

Returns:

getProperties

java.util.Properties getProperties()

Get the proprties associates to this bundle. Return an empty Propertis if the bundle dont have a properties.

Returns:

getCategories

java.util.List<java.lang.String> getCategories()

Gets the list of all the categories of *all* the packages.

Returns:

a list with the categories of all the packages.

getTypes

java.util.List<java.lang.String> getTypes()

Gets the list of different the types of *all* the packages.

Returns:

a list with the types of packages.

needInstallPackageProviders

boolean needInstallPackageProviders()

installPackageProviders

void installPackageProviders(SimpleTaskStatus taskStatus)