Application: gvSIG desktop

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* This program is free software; you can redistribute it and/or

* modify it under the terms of the GNU General Public License

* as published by the Free Software Foundation; either version 2

* of the License, or (at your option) any later version.

* 

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

* GNU General Public License for more details.

* 

* You should have received a copy of the GNU General Public License

* along with this program; if not, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

/*

* AUTHORS (In addition to CIT):

* 2010 {Prodevelop}   {Task}

*/

package org.gvsig.installer.lib.spi;

import java.io.File;

import java.io.InputStream;

import java.io.OutputStream;

import java.util.List;

import java.util.Map;

import org.gvsig.installer.lib.api.PackageInfo;

import org.gvsig.installer.lib.api.creation.MakePluginPackageServiceException;

import org.gvsig.installer.lib.api.execution.InstallPackageServiceException;

import org.gvsig.tools.service.spi.ProviderServices;

/**

 * Services that can be used by the providers to create the installer. It

 * contains methods to compress and to decompress files and methods to 

 * read an install info file from a directory.

 * 

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>

 */

public interface InstallerProviderServices extends ProviderServices{

        /**

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

         * @param is

         * The input stream to decompress

         * @param outputDirectory.

         * The output directory.

         * @throws InstallPackageServiceException

         * If there is a problem decompressing the stream.

         */

        public void decompress(InputStream is, File outputDirectory) throws InstallPackageServiceException;

        /**

         * Compress a directory like an zipped outputstream with a concrete name.

         * @param directory

         * The directory to compress.

         * @param fileName

         * Name of the zip entry that has the output file.

         * The name that have to have 

         * @param os

         * Output stream to write the output.

         * @throws MakePluginPackageServiceException

         * If there is any problem compressing. 

         */

        public void compress(File directory, String fileName, OutputStream os) throws MakePluginPackageServiceException;

        /**

         * Reads an installer info from a directory a fills the the properties

         * of an installerinfo.

         * @param directory

         * The root directory that contains the installinfo file

         * @param installInfo

         * The installinfo file that has to be filled.

         * @throws InstallerInfoFileException.

         * If there is any problem reading the file

         */

        public void readInstallInfo(File directory, PackageInfo installerInfo) throws InstallerInfoFileException;

        /**

         * It reads an installer and parses all the install.info files.

         * @param is

         * The installer.

         * @param installerInfos

         * A list of the information of the plugins to install.

         * @param zipEntriesMap

         * A map to retrieve the zipEntry name for each plugin. This information is necessary to

         * select the plugin to decompress.

         * @throws InstallPackageServiceException

         * If there is a problem reading the installer.

         */

        public void readInstallInfo(InputStream is, List<PackageInfo> installerInfos, Map<PackageInfo, String> zipEntriesMap) throws InstallPackageServiceException;

        /**

         * Writes the install.info file in a concrete directory.

         * @param directory

         * The directory.

         * @param installerInfo

         * The information to write.

         * @throws InstallerInfoFileException

         * If there is any problem writing the install.info file. 

         */

        public void writeInstallInfo(File directory, PackageInfo installerInfo) throws InstallerInfoFileException;

        /**

         * It search a plugin inside an installer file by the zip name and returns

         * the stream in this position ready to decompres.

         * @param is

         * The installer.

         * @param zipEntry

         * The name of the zip entry.

         * @return

         * The input stream ready to install.

         * @throws InstallPackageServiceException

         * If there is a problem reading the stream 

         */

        public InputStream searchPlugin(InputStream is, String zipEntry) throws InstallPackageServiceException; 

        /**

         * It reads a compressed file and retrieve the installer information.

         * @param is

         * The compressed file

         * @return

         * The information of the installer

         * @throws InstallPackageServiceException

         * If there is a problem decompressing the file.

         */

        public PackageInfo readCompressedInstallInfo(InputStream is) throws InstallPackageServiceException; 

}