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;

import java.io.File;

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

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

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

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

import org.gvsig.tools.service.Manager;

/**

 * <p>

 * This manager is used to register and create the services that are used

 * to manage the creation and the execution of installers. An installer is

 * a file called <b>bundle</b> that is composed of a set <b>packages</b>.

 * </p>

 * <p>

 * A package has some information that is defined by the {@link PackageInfo} 

 * class and is composed of a set of attributes. One of these attributes, 

 * the type, denotes if the package is a plugin, theme, translation, etc.

 * </p> 

 * <p>

 * In practice a bundle is just a compressed zip file that has a compressed zip file

 * for every package to install. The structure of a bundle file with two

 * packages of type plugin could be:

 * </p>

 * <pre>

 * - bundle (compressed file)

 *                 - org.gvsig.plugin1-1_0_0-23 (compressed file)

 *                         - org.gvsig.plugin1

 *                                   - package.info                           

 *          - org.gvsig.plugin2-2_0_1-35 (compressed file)

 *                  - org.gvsig.plugin1

 *                          - package.info                     

 * </pre>

 * <p>

 * bundle is the compressed file that contains a zip entry for every

 * package to install. The name of the zip entry follows next pattern:

 * </p>

 * <pre>

 *                 [package code]-[version]-[build] 

 * </pre>

 * <p>

 * Every zip entry contains a main folder inside that contains all the

 * package files that are used in the installation process. Depending of the

 * type of packages, the information inside this folder can be different,

 * but all the types of packages have to have the <b>package.info</b> that

 * has all the package information. To see the <b>package.info</b> description

 * see {@link PackageInfo}.

 * <p> 

 * </p>

 * The services that offers this managers are basically two: the creation of 

 * bundles for just one package of type plugin and a service for the 

 * installation of packages.

 * service.

 * </p>

 * 

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

 */

public interface InstallerManager extends Manager {

        /**

         * It registers a class that implements the service for the creation of

         * installers. It has to implement the {@link MakePluginPackageService} interface.

         * 

         * @param clazz

         * Class that implements the {@link MakePluginPackageService} interface.

         */

        @SuppressWarnings(value = "unchecked")

        public void registerMakePluginPackageService(Class clazz);

        /**

         * It creates and returns an object that is used to create an installer for

         * a selected plugin. All the parameters are set using the {@link MakePluginPackageService} 

         * interface.

         * 

         * @return

         * An object that is used to create a plugin installer 

         * @throws MakePluginPackageServiceException

         * When there is a problem creating the service

         */

        public MakePluginPackageService getMakePluginPackageService(File pluginsDirectory) throws MakePluginPackageServiceException;

        /**

         * It registers a class that implements the service for the execution of

         * installers. It has to implement the {@link InstallPackageService} interface.

         * 

         * @param clazz

         * Class that implements the {@link InstallPackageService} interface.

         */

        @SuppressWarnings("unchecked")

        public void registerInstallPackageService(Class clazz);

        /**

         * It creates and returns an object that is used to execute an installer for

         * the installation of plugins in gvSIG. All the parameters are set using the

         * {@link InstallPackageService} interface.

         * 

         * @return

         * An object that is used to install the installer file 

         * @throws InstallPackageServiceException

         * When there is a problem creating the service

         */

        public InstallPackageService getInstallPackageService() throws InstallPackageServiceException;

}