org.gvsig.installer.lib.spi

Interface InstallPackageProviderServices

All Superinterfaces:

ProviderServices

All Known Implementing Classes:

DefaultInstallerProviderServices

public interface InstallPackageProviderServices
extends ProviderServices

Services that can be used by the providers to create or exceute the bundle. It contains methods to compress and to decompress files and methods to read an install a package file from a directory.

Method Summary

Modifier and Type	Method and Description
void	compressPackage(java.io.File folder, java.io.OutputStream os) Compress a plugin folder using the plugin's name as a package.
void	compressPackageIndex(java.io.File folder, java.io.OutputStream os) Compress a plugin folder using the plugin's name as a package, only with the files needed by the package index.
void	compressPackageSet(java.io.File folder, java.lang.String fileName, java.io.OutputStream os) Compress a folder as a zipped package set in the given outputstream with a concrete name.
void	decompress(java.io.InputStream is, java.io.File outputDirectory) It decompress an input stream and write it on a directory.
java.util.List<java.lang.String>	getDefaultSelectedPackagesIDs()
java.util.Properties	getProperties()
PackageInfo	readCompressedPackageInfo(java.io.InputStream is) It reads a compressed file and retrieve the package information.
void	readPackageInfo(java.io.File directory, PackageInfo installerInfo) Reads the package.info file from a directory a fills the the properties of the PackageInfo object.
void	readPackageInfo(java.io.InputStream is, java.util.List<PackageInfo> packageInfos, java.util.Map<PackageInfo,java.lang.String> zipEntriesMap, java.lang.String name, SimpleTaskStatus taskStatus) Reads the package.info file from a bundle fills the the properties of the PackageInfo objects.
void	readPackageSetInfo(java.io.InputStream is, java.util.List<PackageInfo> packageInfos, java.util.Map<PackageInfo,java.lang.String> zipEntriesMap, SimpleTaskStatus taskStatus) Reads the package.info file from a package set and fills the the properties of the PackageInfo objects.
java.io.InputStream	searchPackage(java.io.InputStream is, java.lang.String zipEntry) It search a package inside an installer file by the zip name and returns the stream in this position ready to decompres.
void	writePackageInfo(java.io.File directory, PackageInfo packageInfo) Writes the package.info file in a concrete directory.
void	writePackageInfoForIndex(java.io.File directory, PackageInfo packageInfo) Writes the package.info file in a concrete directory to be used in a package index.

Methods inherited from interface org.gvsig.tools.service.spi.ProviderServices

getParameters, getService

Method Detail

decompress

void decompress(java.io.InputStream is,
                java.io.File outputDirectory)
         throws InstallPackageServiceException

It decompress an input stream and write it on a directory.

Parameters:

is - The input stream to decompress

outputDirectory - . The output directory.

Throws:

InstallPackageServiceException - If there is a problem decompressing the stream.

compressPackageSet

void compressPackageSet(java.io.File folder,
                        java.lang.String fileName,
                        java.io.OutputStream os)
                 throws MakePluginPackageServiceException

Compress a folder as a zipped package set in the given outputstream with a concrete name.

Parameters:

folder - the folder to compress.

fileName - name of the zip entry that has the output file. The name that have to have

os - output stream to write the output.

Throws:

MakePluginPackageServiceException - if there is any problem compressing.

compressPackage

void compressPackage(java.io.File folder,
                     java.io.OutputStream os)
              throws MakePluginPackageServiceException

Compress a plugin folder using the plugin's name as a package.

Parameters:

folder - the directory to compress.

os - output stream to write the output.

Throws:

MakePluginPackageServiceException - if there is any problem compressing.

compressPackageIndex

void compressPackageIndex(java.io.File folder,
                          java.io.OutputStream os)
                   throws MakePluginPackageServiceException

Compress a plugin folder using the plugin's name as a package, only with the files needed by the package index.

Parameters:

folder - the directory to compress.

os - output stream to write the output.

Throws:

MakePluginPackageServiceException - if there is any problem compressing.

readPackageInfo

void readPackageInfo(java.io.File directory,
                     PackageInfo installerInfo)
              throws InstallerInfoFileException

Reads the package.info file from a directory a fills the the properties of the PackageInfo object.

Parameters:

directory - the root directory that contains the installinfo file

installInfo - the installinfo file that has to be filled.

Throws:

InstallerInfoFileException. - if there is any problem reading the file

InstallerInfoFileException

readPackageSetInfo

void readPackageSetInfo(java.io.InputStream is,
                        java.util.List<PackageInfo> packageInfos,
                        java.util.Map<PackageInfo,java.lang.String> zipEntriesMap,
                        SimpleTaskStatus taskStatus)
                 throws InstallPackageServiceException

Reads the package.info file from a package set and fills the the properties of the PackageInfo objects.

Parameters:

is - the input stream of a bundle.

packageInfos - a list of the information of the packages to install.

zipEntriesMap - a map to retrieve the zipEntry for every package. This information is necessary to select the plugin to decompress.

Throws:

InstallPackageServiceException - if there is a problem reading the bundle.

readPackageInfo

void readPackageInfo(java.io.InputStream is,
                     java.util.List<PackageInfo> packageInfos,
                     java.util.Map<PackageInfo,java.lang.String> zipEntriesMap,
                     java.lang.String name,
                     SimpleTaskStatus taskStatus)
              throws InstallPackageServiceException

Reads the package.info file from a bundle fills the the properties of the PackageInfo objects.

Parameters:

is - the input stream of a bundle.

packageInfos - a list of the information of the packages to install.

zipEntriesMap - a map to retrieve the zipEntry for every package. This information is necessary to select the plugin to decompress.

Throws:

InstallPackageServiceException - if there is a problem reading the bundle.

writePackageInfo

void writePackageInfo(java.io.File directory,
                      PackageInfo packageInfo)
               throws InstallerInfoFileException

Writes the package.info file in a concrete directory.

Parameters:

directory - the directory.

packageInfo - the information to write.

Throws:

InstallerInfoFileException - if there is any problem writing the package.info file.

writePackageInfoForIndex

void writePackageInfoForIndex(java.io.File directory,
                              PackageInfo packageInfo)
                       throws InstallerInfoFileException

Writes the package.info file in a concrete directory to be used in a package index.

Parameters:

directory - the directory.

packageInfo - the information to write.

Throws:

InstallerInfoFileException - if there is any problem writing the package.info file.

searchPackage

java.io.InputStream searchPackage(java.io.InputStream is,
                                  java.lang.String zipEntry)
                           throws InstallPackageServiceException

It search a package inside an installer file by the zip name and returns the stream in this position ready to decompres.

Parameters:

is - the input stream of a bundle.

zipEntry - the name of the zip entry.

Returns:

the input stream ready to install.

Throws:

InstallPackageServiceException - if there is a problem reading the stream

readCompressedPackageInfo

PackageInfo readCompressedPackageInfo(java.io.InputStream is)
                               throws InstallPackageServiceException

It reads a compressed file and retrieve the package information.

Parameters:

is - the compressed file

Returns:

the information of the package

Throws:

InstallPackageServiceException - if there is a problem decompressing the file.

getDefaultSelectedPackagesIDs

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

getProperties

java.util.Properties getProperties()