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.api.execution;

import java.io.File;

import java.io.InputStream;

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

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

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

import org.gvsig.tools.service.Service;

/**

 * <p>

 * This service is used to read an installer file and install the

 * plugins contained in it. It has methods to add installers,

 * to read the plugins that can be installed, to select the plugins

 * to install and to install them.  

 * </p>

 * <p>

 * The installer stream is a normally a file that has been created using

 * the {@link InstallerCreationService} service. It is possible to create

 * an installer manually, but it has to have the structure defined by the

 * {@link InstallerCreationService} class.

 * </p>

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

 */

public interface InstallerExecutionService extends Service{

        /**

         * Sets the stream that contains the installer that contains the 

         * information to install some plugins. This stream is a zip file

         * that has to have the structure defined in the {@link InstallerCreationService}

         * documentation.         

         * @param inputStream

         * The stream that contains the installer information.

         * @throws InstallerExecutionServiceException

         * It is thrown if there is an exception reading the stream

         */

        public void addInstaller(InputStream inputStream) throws InstallerExecutionServiceException;

        /**

         * It sets the directory where the application is located, that it has to

         * be a valid gvSIG root directory. This directory is used to install the plugins.

         * @param applicationDirectory

         * The directory where the gvSIG is located.

         * @throws InstallerExecutionServiceException

         * This exception is thrown when the directory doesn't exist or the directory is

         * not a valid gvSIG root directory.

         */

        public void setApplicationDirectory(File applicationDirectory) throws InstallerExecutionServiceException;

        /**

         * In the main gvSIG directory there is a directory named <b>install</b> that could

         * have some installers that can be used to install new plugins. This method retrieve

         * all the information of the installers located in this directory and allows to the 

         * user to show this information.

         * @throws InstallerExecutionServiceException

         * If there is any problem reading the directory or the installers.

         */

        public void addInstallersFromInstallDirectory() throws InstallerExecutionServiceException;

        /**

         * Deletes all the information of the previous loaded installers.

         */

        public void deleteInstallers();        

        /**

         * Sets the plugin to install.

         * @param index

         * Position of the plugin to install.

         * @throws InstallerExecutionServiceException

         * If the plugin doesn't exist. 

         */

        public void setPluginToInstall(int index) throws InstallerExecutionServiceException;

        /**

         * Sets the plugin to install.

         * @param code

         * Code of the plugin to install.

         * @throws InstallerExecutionServiceException

         * If the plugin doesn't exist. 

         */

        public void setPluginToInstall(String code) throws InstallerExecutionServiceException;

        /**

         * Install the selected plugin. This method only can be executed if the 

         * selected plugin is located on the <b>install</b> directory of gvSIG.

         * Otherwise the method to use is {{@link #executeInstaller(InputStream)} that

         * provides the strem used to install the plugin.

         * @throws InstallerExecutionServiceException

         * If there is an error installing the plugin.

         */

        public void executeInstaller() throws InstallerExecutionServiceException;

        /**

         * Install the selected plugin. This method provides of a stream that has been

         * added before using the {{@link #addInstaller(InputStream)}} method. This stream

         * is needed other time because there are some {@link InputStream}'s that don't

         * support the {@link InputStream#reset()} method.         * 

         * @throws InstallerExecutionServiceException

         * If there is an error installing the plugin.         * 

         */

        public void executeInstaller(InputStream is) throws InstallerExecutionServiceException;

        /**

         * @return

         * The number of plugins that can be selected to install.

         */

        public int getPluginsSize();

        /**

         * Return the information of a plugin from a concrete position. 

         * @param index

         * The position of the plugin.

         * @return

         * The information of a plugin.

         */

        public InstallerInfo getPluginInfoAt(int index);

}