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;

/**

 * <p>

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

 * plugins contained in it. It has methods to set the installer file,

 * 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 {

        /**

         * 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 setInstaller(InputStream inputStream) throws InstallerExecutionServiceException;

        /**

         * It 

         * @param outputDirectory

         * @throws InstallerExecutionServiceException

         */

        public void executeInstaller(File outputDirectory) throws InstallerExecutionServiceException;

        public void selectPluginToInstall(int index);

        public int getPluginsSize();

        public InstallerInfo getPluginInfoAt(int index);

}