Revision 32498 branches/v2_0_0_prep/extensions/org.gvsig.installer/org.gvsig.installer.lib/org.gvsig.installer.lib.spi/src/main/java/org/gvsig/installer/lib/spi/InstallerProviderManager.java

View differences:

InstallerProviderManager.java
27 27
 
28 28
package org.gvsig.installer.lib.spi;
29 29

  
30
import org.gvsig.installer.lib.api.InstallerInfo;
30 31
import org.gvsig.installer.lib.spi.execution.InstallerExecutionProvider;
31 32
import org.gvsig.tools.service.ServiceException;
32 33
import org.gvsig.tools.service.spi.ProviderManager;
33 34

  
34 35
/**
36
 * <p>
37
 * This manager offers to the providers that are executed in an installation process 
38
 * of some functionalities that they need to complete their task. It also offers
39
 * the functionality to create a new provider using the provider name.
40
 * </p>
41
 * <p>
42
 * All the plugins to install have to have some install properties defined
43
 * by the {@link InstallerInfo} class. This class is just a set of properties 
44
 * and there is a property named <b>type</b> that can be retrieved by the
45
 * {@link InstallerInfo#getType()} method that defines the plugin type 
46
 * (a new plugin, theme...). This property is used to create a {@link InstallerExecutionProvider}
47
 * that is used to install the selected plugin.
48
 * </p>
49
 * <p>
50
 * For each different type of plugin a new provider has to be
51
 * registered using the plugin type.
52
 * </p>
53
 * 
35 54
 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>
36 55
 */
37 56
public interface InstallerProviderManager extends ProviderManager {
38 57
	
39
	
58
	/**
59
	 * Creates a new provider to execute an installer to add a new plugin in gvSIG. 
60
	 * @param providerName
61
	 * The provider name used on the registration of the provider. This name is the
62
	 * type attribute defined by {@link InstallerInfo}.
63
	 * @return
64
	 * A porvider that can be used to install a plugin.
65
	 * @throws ServiceException
66
	 * If the provider doesn't exist or if there is a problem creating the provider.
67
	 */
40 68
	public InstallerExecutionProvider createExecutionProvider(String providerName) throws ServiceException;
41 69
	
70
	/**
71
	 * Creates the services that be used for the providers to execute or
72
	 * create a new installer.
73
	 * @return
74
	 * The services used to create or execute an installer.
75
	 */
42 76
	public InstallerProviderServices createInstallerProviderServices();
43 77
	
44 78
}

Also available in: Unified diff