| gvSIG desktop 1

/* 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 org.gvsig.installer.lib.api.InstallerInfo;

import org.gvsig.installer.lib.spi.execution.InstallerExecutionProvider;

import org.gvsig.tools.service.ServiceException;

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

/**

 * <p>

 * This manager offers to the providers that are executed in an installation process 

 * of some functionalities that they need to complete their task. It also offers

 * the functionality to create a new provider using the provider name.

 * </p>

 * <p>

 * All the plugins to install have to have some install properties defined

 * by the {@link InstallerInfo} class. This class is just a set of properties 

 * and there is a property named <b>type</b> that can be retrieved by the

 * {@link InstallerInfo#getType()} method that defines the plugin type 

 * (a new plugin, theme...). This property is used to create a {@link InstallerExecutionProvider}

 * that is used to install the selected plugin.

 * </p>

 * <p>

 * For each different type of plugin a new provider has to be

 * registered using the plugin type.

 * </p>

 * 

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

 */

public interface InstallerProviderManager extends ProviderManager {

        /**

         * Creates a new provider to execute an installer to add a new plugin in gvSIG. 

         * @param providerName

         * The provider name used on the registration of the provider. This name is the

         * type attribute defined by {@link InstallerInfo}.

         * @return

         * A porvider that can be used to install a plugin.

         * @throws ServiceException

         * If the provider doesn't exist or if there is a problem creating the provider.

         */

        public InstallerExecutionProvider createExecutionProvider(String providerName) throws ServiceException;

        /**

         * Creates the services that be used for the providers to execute or

         * create a new installer.

         * @return

         * The services used to create or execute an installer.

         */

        public InstallerProviderServices createInstallerProviderServices();

}