/ - Diff - Application: gvSIG desktop - gvSIG

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     package org.gvsig.installer.lib.api;
     import java.util.Collection;
     import java.util.List;
     public interface DependenciesCalculator {
     	public void addPackageToInstall(PackageInfo packageInfo);
     	public void addPackageToInstall(Collection<PackageInfo> packages);
     	public void addInstalledPackage(PackageInfo packageInfo);
     	public void addInstalledPackage(PackageInfo[] packages);
     	public void calculate();
     	public List<PackageInfo> getRequiredPackages();
     	public List<PackageInfo> getConflictPackages();
     	public Dependencies getUnresolvedDependencies();
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     /*
      * AUTHORS (In addition to CIT):
      * 2010 {Prodevelop}   {Task}
      */
     package org.gvsig.installer.lib.api;
     import org.gvsig.tools.locator.AbstractLocator;
     import org.gvsig.tools.locator.Locator;
     import org.gvsig.tools.locator.LocatorException;
     /**
      * This Locator provides the entry point for the gvSIG {@link InstallerManager}
+     *
      * @see {@link Locator}
      * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>
      */
     public class InstallerLocator extends AbstractLocator {
     	private static final String LOCATOR_NAME = "InstallerLocator";
     	/**
     	 * InstallerManager name used by the locator to access the instance
     	 */
     	public static final String INSTALLER_MANAGER_NAME = "InstallerManager";
     	private static final String INSTALLER_MANAGER_DESCRIPTION = "InstallerManager of gvSIG";
     	/**
     	 * Unique instance.
     	 */
     	private static final InstallerLocator instance = new InstallerLocator();
     	/**
     	 * @see Locator#getLocatorName()
     	 */
     	public String getLocatorName() {
     		return LOCATOR_NAME;
+    	}
     	/**
     	 * Return a reference to {@link InstallerManager}.
+    	 *
     	 * @return a reference to InstallerManager
     	 * @throws LocatorException
     	 *             if there is no access to the class or the class cannot be
     	 *             instantiated
     	 * @see Locator#get(String)
     	 */
     	public static InstallerManager getInstallerManager()
     			throws LocatorException {
     		return (InstallerManager) getInstance().get(INSTALLER_MANAGER_NAME);
+    	}
     	/**
     	 * Return the singleton instance.
+    	 *
     	 * @return the singleton instance
     	 */
     	public static InstallerLocator getInstance() {
     		return instance;
+    	}
     	/**
     	 * Registers the Class implementing the {@link InstallerManager} interface.
+    	 *
     	 * @param clazz
     	 *            implementing the InstallerManager interface
     	 */
     	public static void registerInstallerManager(
     			Class<? extends InstallerManager> clazz) {
     		getInstance().register(INSTALLER_MANAGER_NAME,
     				INSTALLER_MANAGER_DESCRIPTION, clazz);
+    	}
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     /*
      * AUTHORS (In addition to CIT):
      * 2010 {Prodevelop}   {Task}
      */
     package org.gvsig.installer.lib.api;
     import org.gvsig.tools.ToolsLibrary;
     import org.gvsig.tools.library.AbstractLibrary;
     import org.gvsig.tools.library.LibraryException;
     /**
      * Library for the installer.
+     *
      * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>
      */
     public class InstallerLibrary extends AbstractLibrary {
     	@Override
     	public void doRegistration() {
     		registerAsAPI(InstallerLibrary.class);
     		this.require(ToolsLibrary.class);
+    	}
     	@Override
     	protected void doInitialize() throws LibraryException {
     		// Nothing to do
+    	}
     	@Override
     	protected void doPostInitialize() throws LibraryException {
     		// Nothing to do
+    	}
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     package org.gvsig.installer.lib.api;
     /**
      * @author gvSIG Team
      * @version $Id$
+     *
      */
     public interface SimpleProgressStatus {
     	public int getCompleted();
     	public String getLabel();
     	public void requestCancel();
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     /*
      * AUTHORS (In addition to CIT):
      * 2010 {Prodevelop}   {Task}
      */
     package org.gvsig.installer.lib.api.execution;
     import org.gvsig.tools.exception.BaseException;
     /**
      * Base exception for all the exceptions that are thrown by the process of
      * installation of a package. The {@link InstallPackageService} throws this
      * exception on its methods.
+     *
      * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>
      */
     public class InstallPackageServiceException extends BaseException {
     	private static final String message = "Error installing a package";
     	private static final long serialVersionUID = -7645352975209203727L;
     	private static final String KEY = "installer_execution_exception";
     	/**
     	 * @see BaseException#BaseException(String, long)
     	 */
     	public InstallPackageServiceException() {
     		super(message, KEY, serialVersionUID);
+    	}
     	/**
     	 * @see BaseException#BaseException(Throwable, String, long)
     	 */
     	public InstallPackageServiceException(Throwable cause) {
     		super(message, cause, KEY, serialVersionUID);
+    	}
     	protected InstallPackageServiceException(String message, Throwable cause,
     			String key, long code) {
     		super(message, cause, key, code);
+    	}
     	protected InstallPackageServiceException(String message, String key,
     			long code) {
     		super(message, key, code);
+    	}
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     /*
      * AUTHORS (In addition to CIT):
      * 2010 {Prodevelop}   {Task}
      */
     package org.gvsig.installer.lib.api.execution;
     import java.io.File;
     import java.net.URL;
     import java.util.List;
     import org.gvsig.installer.lib.api.InstallerManager;
     import org.gvsig.installer.lib.api.PackageInfo;
     import org.gvsig.installer.lib.api.creation.MakePluginPackageService;
     import org.gvsig.tools.service.Service;
     import org.gvsig.tools.task.SimpleTaskStatus;
     /**
      * <p>
      * This service is used to read a bundle file and install the packages contained
      * in it. It has methods to read the packages contained in a bundle and to
      * install one of them.
      * </p>
      * <p>
      * The bundle is a file that has been created using the
      * {@link MakePluginPackageService} service. It is possible to create an
      * installer manually, but it has to have the structure defined by the
      * {@link InstallerManager} class.
      * </p>
+     *
      * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>
      */
     public interface InstallPackageService extends Service {
     	public void reset();
     	/**
     	 * Adds a the URI of a bundle that contains some packages to install. A
     	 * bundle is a compressed zip file with a structure defined in the
     	 * {@link InstallerManager} class.
+    	 *
     	 * @param bundleURI
     	 *            the URI of a bundle.
     	 * @throws InstallPackageServiceException
     	 *             it is thrown if there is an exception reading the URI.
     	 */
     	public void addBundle(File bundleFile)
     			throws InstallPackageServiceException;
     	/**
     	 * Adds a URL of a bundle that contains some packages to install. A bundle
     	 * is a compressed zip file with a structure defined in the
     	 * {@link InstallerManager} class.
+    	 *
     	 * @param bundleURL
     	 *            the {@link URL} of a bundle.
     	 * @throws InstallPackageServiceException
     	 *             it is thrown if there is an exception reading the {@link URL}
     	 *             .
     	 */
     	public void addBundle(URL bundleURL) throws InstallPackageServiceException;
     	/**
     	 * In reads a directory and reads all the bundles. This method retrieve all
     	 * the information of the packages located in the bundles and allows to the
     	 * user to show this information.
+    	 *
     	 * @param bundlesDirectory
     	 *            a directory that contains bundles.
     	 * @throws InstallPackageServiceException
     	 *             If there is any problem reading the directory of bundles.
     	 */
     	public void addBundlesFromDirectory(File bundlesDirectory)
     			throws InstallPackageServiceException;
     	/**
     	 * Install a package in a concrete gvSIG installation directory. The
     	 * selected package has to be contained in one of the bundles that has been
     	 * previously added using the {@link #addBundle(File)} or the
     	 * {@link #addBundlesFromDirectory(File)} method.
+    	 *
     	 * @param applicationDirectory
     	 *            a valid root directory where an instance og gvSIG is
     	 *            installed.
     	 * @param packageInfo
     	 *            the package to install.
     	 * @throws InstallPackageServiceException
     	 *             If there is an error installing the package.
     	 */
     	public void installPackage(File applicationDirectory,
     			PackageInfo packageInfo) throws InstallPackageServiceException;
     	/**
     	 * Install a package in a concrete gvSIG installation directory. The
     	 * selected package has to be contained in one of the bundles that has been
     	 * previously added using the {@link #addBundle(File)} or the
     	 * {@link #addBundlesFromDirectory(File)} method.
+    	 *
     	 * @param applicationDirectory
     	 *            a valid root directory where an instance og gvSIG is
     	 *            installed.
     	 * @param packageCode
     	 *            the code of the package.
     	 * @throws InstallPackageServiceException
     	 *             if there is an error installing the {@link PackageInfo#}
     	 */
     	public void installPackage(File applicationDirectory, String packageCode)
     			throws InstallPackageServiceException;
     	/**
     	 * @return the number of packages that has been loaded form one or more
     	 *         bundles using the {@link #addBundle(File)} or the
     	 *         {@link #addBundlesFromDirectory(File)} method.
     	 */
     	public int getPackageCount();
     	/**
     	 * Return the package information for a concrete position. All the packages
     	 * has been loaded form one or more bundles using the
     	 * {@link #addBundle(File)} or the {@link #addBundlesFromDirectory(File)}
     	 * method.
+    	 *
     	 * @param index
     	 *            the position of the package.
     	 * @return the information of a package. returns <code>null</code> if the
     	 *         package doesn't exist.
     	 */
     	public PackageInfo getPackageInfo(int index);
     	/**
     	 * Return the package information for a concrete position. All the packages
     	 * has been loaded form one or more bundles using the
     	 * {@link #addBundle(File)} or the {@link #addBundlesFromDirectory(File)}
     	 * method.
+    	 *
     	 * @param packageCode
     	 *            the code of the package.
     	 * @return the information of a package. returns <code>null</code> if the
     	 *         package doesn't exist.
     	 */
     	public PackageInfo getPackageInfo(String packageCode);
     	/**
     	 * Download the package and register it in the manager.
+    	 *
     	 * @param packageInfo
     	 */
     	public void downloadPackage(PackageInfo packageInfo,
     			SimpleTaskStatus taskStatus) throws InstallPackageServiceException;
     	/**
+         *
          */
     	// public void resetPackages();
     	/**
     	 * @return
     	 */
     	public List<String> getDefaultSelectedPackagesIDs();
     	/**
     	 * Gets the list of all the categories of *all* the packages.
+    	 *
     	 * @return a list with the categories of all the packages.
     	 */
     	public List<String> getCategories();
     	/**
     	 * Gets the list of different the types of *all* the packages.
+    	 *
     	 * @return a list with the types of packages.
     	 */
     	public List<String> getTypes();
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     package org.gvsig.installer.lib.api;
     import java.io.OutputStream;
     import org.gvsig.tools.exception.BaseException;
     /**
      * @author gvSIG Team
      * @version $Id$
+     *
      */
     public interface PackageInfoWriter {
     	public void write(PackageInfo installInfo, OutputStream os)
     			throws BaseException;
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     /*
      * AUTHORS (In addition to CIT):
      * 2010 {Prodevelop}   {Task}
      */
     package org.gvsig.installer.lib.api.creation;
     import org.gvsig.tools.exception.BaseException;
     /**
      * Base exception for all the exceptions that are thrown by the process of
      * creation of an installer for a package of a plugin. The
      * {@link MakePluginPackageService} throws this exception on its methods.
+     *
      * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>
      */
     public class MakePluginPackageServiceException extends
     		MakePackageServiceException {
     	private static final long serialVersionUID = 4388665353519171171L;
     	private static final String KEY = "make_plugin_package_exception";
     	/**
     	 * @see BaseException#BaseException(String, String, long)
     	 */
     	public MakePluginPackageServiceException(String message) {
     		super(message, KEY, serialVersionUID);
+    	}
     	/**
     	 * @see BaseException#BaseException(String, Throwable, String, long)
     	 */
     	public MakePluginPackageServiceException(String message, Throwable cause) {
     		super(message, cause, KEY, serialVersionUID);
+    	}
     	/**
     	 * @see BaseException#BaseException(String, String, long)
     	 */
     	public MakePluginPackageServiceException(String message, String key,
     			long serialVersion) {
     		super(message, key, serialVersion);
+    	}
     	/**
     	 * @see BaseException#BaseException(String, Throwable, String, long)
     	 */
     	public MakePluginPackageServiceException(String message, Throwable cause,
     			String key, long serialVersion) {
     		super(message, cause, key, serialVersion);
+    	}
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     /*
      * AUTHORS (In addition to CIT):
      * 2010 {Prodevelop}   {Task}
      */
     package org.gvsig.installer.lib.api.creation;
     import org.gvsig.tools.exception.BaseException;
     /**
      * Base exception for all the exceptions that are thrown by the process of
      * creation of an installer for a package of a plugin. The
      * {@link MakePluginPackageService} throws this exception on its methods.
+     *
      * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>
      */
     public class MakePackageServiceException extends BaseException {
     	/**
+         *
          */
     	private static final long serialVersionUID = -5549105047582975720L;
     	private static final String KEY = "make_package_exception";
     	private static final String MSG = "_Cant_create_package";
     	/**
     	 * @see BaseException#BaseException(String, String, long)
     	 */
     	public MakePackageServiceException() {
     		super(MSG, KEY, serialVersionUID);
+    	}
     	/**
     	 * @see BaseException#BaseException(String, Throwable, String, long)
     	 */
     	public MakePackageServiceException(Throwable cause) {
     		super(MSG, cause, KEY, serialVersionUID);
+    	}
     	/**
     	 * @see BaseException#BaseException(String, String, long)
     	 */
     	protected MakePackageServiceException(String message, String key,
     			long serialVersion) {
     		super(message, key, serialVersion);
+    	}
     	/**
     	 * @see BaseException#BaseException(String, Throwable, String, long)
     	 */
     	protected MakePackageServiceException(String message, Throwable cause,
     			String key, long serialVersion) {
     		super(message, cause, key, serialVersion);
+    	}
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     /*
      * AUTHORS (In addition to CIT):
      * 2010 {Prodevelop}   {Task}
      */
     package org.gvsig.installer.lib.api.creation;
     import java.io.File;
     import java.io.OutputStream;
     import org.gvsig.installer.lib.api.InstallerManager;
     import org.gvsig.installer.lib.api.PackageInfo;
     import org.gvsig.tools.service.Service;
     /**
      * <p>
      * This service is used to create a bundle that contains a package of plugin
      * type. It supports just one package for every installer. It contains a method
      * to set the plugin path and some methods to set the installer information.
      * </p>
      * <p>
      * It has also methods to load the installed plugins from a directory (if
      * exists) and methods to create the bundle file in an {@link OutputStream}.
      * </p>
      * <p>
      * A plugin package has the same structure of a standard package defined in
      * {@link InstallerManager} but it adds some new files. An example of the
      * structure of a bundle with a plugin package could be:
      * </p>
+     *
      * <pre>
      * - bundle (compressed file)
      * 		- org.gvsig.plugin1-1_0_0-23 (compressed file)
      * 			- org.gvsig.plugin1
      * 			  	- package.info
      *  			- install.xml
      *  			- files
      *  				- gvSIG
      *  					- extensiones
      *  						- org.gvsig.plugin2
      *  							- file1
      *  							- file2
      * </pre>
      * <p>
      * This structure has some extra files:
      * </p>
      * <lu> <li><b>install.xml</b>: ant file that is executed in the execution of
      * the installer to do some extra actions in the installation process. One of
      * these actions is copy all the files located in the files directory</li> <li>
      * <b>files directory</b>: it contains some files of other extensions that have
      * to be copied using the ant script.</li> </lu>
      * <p>
      * The usage of the ant script to copy files from other plugins is not
      * recommended because it is possible that different installers overrides the
      * same file. The suggestion it that one plugin has to have all the files that
      * it needs to work inside the plugin and it never has to override some external
      * files.
      * </p>
      * <p>
      * The implementations of this interface have to have a constructor with a File
      * parameter that is the directory when the plugins are located. If the
      * directory doens't exists the creation throws an exception.
      * </p>
+     *
      * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>
      */
     public interface MakePluginPackageService extends Service {
     	/**
     	 * It creates a package set with a single plugin package inside.
+    	 *
     	 * @param packageInfo
     	 *            the information of the plugin that has to be included in the
     	 *            package set
     	 * @param packageStream
     	 *            the stream where the the package set will be created
     	 * @throws MakePluginPackageServiceException
     	 *             it is thrown when there is an exception creating the package
     	 *             set
     	 */
     	public void createPackageSet(PackageInfo packageInfo,
     			OutputStream packageStream)
     			throws MakePluginPackageServiceException;
     	/**
     	 * It creates a package of a plugin.
+    	 *
     	 * @param packageInfo
     	 *            the information of the plugin that has to be included in the
     	 *            package
     	 * @param packageStream
     	 *            the stream where the the package will be created
     	 * @throws MakePluginPackageServiceException
     	 *             it is thrown when there is an exception creating the package
     	 */
     	public void createPackage(PackageInfo packageInfo,
     			OutputStream packageStream)
     			throws MakePluginPackageServiceException;
     	/**
     	 * Prepares and copies the needed files for the package. It is used to copy
     	 * the ant build file and the additional external files to be included in
     	 * the package.
+    	 *
     	 * @param newPackageInfo
     	 *            the information of the new plugin.
     	 * @param originalPackageInfo
     	 *            the information of the original plugin.
     	 * @throws MakePluginPackageServiceException
     	 *             it is thrown when there is an exception preparing the package
     	 */
     	public void preparePackage(PackageInfo packageInfo,
     			File originalPackageFolder)
     			throws MakePluginPackageServiceException;
     	/**
     	 * It creates the index for a package of a plugin. This file may be used to
     	 * be included in the main gvSIG remote index, or downloaded as it is.
+    	 *
     	 * @param packageInfo
     	 *            the information of the plugin that has to be included in the
     	 *            package index
     	 * @param packageStream
     	 *            the stream where the the package index will be created
     	 * @throws MakePluginPackageServiceException
     	 *             it is thrown when there is an exception creating the package
     	 */
     	public void createPackageIndex(PackageInfo packageInfo,
     			OutputStream packageStream)
     			throws MakePluginPackageServiceException;
     	/**
     	 * Writes a package info file with the information provided.
+    	 *
     	 * @param packageInfo
     	 *            the package that has to be written into the file
     	 * @param folder
     	 *            the folder where the file is to be created
     	 * @throws MakePluginPackageServiceException
     	 *             it is thrown when there is an exception writing the file
     	 */
     	public void writePackageInfo(PackageInfo packageInfo, File folder)
     			throws MakePluginPackageServiceException;
     	/**
     	 * Writes a package info file with the information provided.
+    	 *
     	 * @param packageInfo
     	 *            the package that has to be written into the file
     	 * @param folder
     	 *            the folder where the file is to be created
     	 * @throws MakePluginPackageServiceException
     	 *             it is thrown when there is an exception writing the file
     	 */
     	public void writePackageInfoForIndex(PackageInfo packageInfo, File folder)
     			throws MakePluginPackageServiceException;
     	/**
     	 * It returns the number of plugin packages that are installed in the folder
     	 * that has been added using the constructor. It can be used in an iteration
     	 * process combined with the {@link #getPluginPackageInfo(int)} method to
     	 * know all the installed plugins.
+    	 *
     	 * @return the number of plugins installed in a directory.
     	 */
     	public int getPluginPackageCount();
     	/**
     	 * It returns an instance of an {@link PackageInfo} class, that is a class
     	 * that contains all the package information (name, version...).
+    	 *
     	 * @param index
     	 *            the position of the plugin that has to be retrieved.
     	 * @return the installer information of a plugin package. Returns
     	 *         <code>null</code> if the package doesn't exist.
     	 */
     	public PackageInfo getPluginPackageInfo(int index);
     	/**
     	 * It returns an instance of an {@link PackageInfo} class, that is a class
     	 * that contains all the package information (name, version...).
+    	 *
     	 * @param code
     	 *            code of the plugin, defined in the <b>package.info</b> file
     	 *            like a property.
     	 * @return the installer information of a plugin package. Returns
     	 *         <code>null</code> if the package doesn't exist.
     	 */
     	public PackageInfo getPluginPackageInfo(String code);
     	/**
     	 * This method returns the default ant script that will be used by some
     	 * plugins to copy some external files in the installation process.
+    	 *
     	 * @return a string that contains the standard ant script
     	 * @throws MakePluginPackageServiceException
     	 *             if there is a problem reading the file
     	 */
     	public String getDefaultAntScript()
     			throws MakePluginPackageServiceException;
     	/**
     	 * Returns the list of packages already installed in the application.
+    	 *
     	 * @return the list of packages already installed in the application
     	 * @throws MakePluginPackageServiceException
     	 *             if there is an error getting the installed packages
     	 */
     	public PackageInfo[] getInstalledPackages()
     			throws MakePluginPackageServiceException;
     	/**
     	 * Returns the folder where a plugin is located.
+    	 *
     	 * @param selectedPackageInfo
     	 *            the info of theplugin to look for
     	 * @return the plugin's folder
     	 * @throws MakePluginPackageServiceException
     	 *             if there is an error locating the folder
     	 */
     	public File getPluginFolder(PackageInfo packageInfo)
     			throws MakePluginPackageServiceException;
     	/**
     	 * @param folder
     	 * @return
     	 */
     	public boolean deleteDir(File folder);
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     package org.gvsig.installer.lib.api.creation;
     import java.io.OutputStream;
     import java.net.URL;
     import org.gvsig.tools.service.Manager;
     /**
      * @author gvSIG Team
      * @version $Id$
+     *
      */
     public interface MakePackageService {
     	public static final String ANT_FILE_NAME = "install.xml";
     	public abstract Manager getManager();
     	public abstract void preparePackage() throws MakePackageServiceException;
     	public abstract void createPackage(OutputStream packageStream)
     			throws MakePackageServiceException;
     	public abstract void createPackageIndex(URL downloadurl,
     			OutputStream packageStream) throws MakePackageServiceException;
     	public abstract void createPackageSet(OutputStream packageStream)
     			throws MakePackageServiceException;
     	public void createPackageIndexSet(URL downloadurl,
     			OutputStream packageStream) throws MakePackageServiceException;
     	public abstract String getDefaultAntScript()
     			throws MakePackageServiceException;
+    }

     /**
      * gvSIG. Desktop Geographic Information System.
+     *
      * Copyright (C) 2007-2013 gvSIG Association.
+     *
      * 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 3
      * 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.
+     *
      * For any additional information, do not hesitate to contact us
      * at info AT gvsig.com, or visit our website www.gvsig.com.
      */
     /*
      * AUTHORS (In addition to CIT):
      * 2010 {Prodevelop}   {Task}
      */
     package org.gvsig.installer.lib.api;
     import java.io.File;
     import java.io.IOException;
     import java.io.InputStream;
     import java.net.URL;
     import java.text.MessageFormat;
     import java.util.List;
     import org.gvsig.installer.lib.api.creation.MakePackageService;
     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.exception.BaseException;
     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>
      * <b>bundle</b> 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>file 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 plugin type and a service for the
      * installation of packages from a bundle. </p>
+     *
      * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodr&aacute;</a>
      */
     public interface InstallerManager extends Manager {
     	public static final String PACKAGE_INDEX_EXTENSION = ".gvspki";
     	public static final String PACKAGE_SET_EXTENSION = ".gvspks";
     	public static final String PACKAGE_EXTENSION = ".gvspkg";
             public static final String PACKAGE_INFO_FILE_NAME = "package.info";
     	/**
     	 * Package state default values.
     	 */
     	public static interface STATE {
     		static final String DEVEL = "devel";
     		static final String TESTING = "testing";
     		static final String PILOT = "pilot";
     		static final String PROTOTYPE = "prototype";
     		static final String ALPHA = "alpha";
     		static final String BETA = "beta";
     		static final String RC = "RC";
     		static final String FINAL = "final";
+    	}
     	/**
     	 * Supported operating system default values.
     	 */
     	public static interface OS {
     		static final String ALL = "all";
     		static final String LINUX = "lin";
     		static final String WINDOWS = "win";
     		static final String DARWIN = "darwin";
+    	}
     	/**
     	 * Supported architecture default values.
     	 */
     	public static interface ARCH {
     		static final String ALL = "all";
     		static final String X86 = "x86";
     		static final String X86_64 = "x86_64";
+    	}
     	/**
     	 * Supported Java virtual machine version default values.
     	 */
     	public static interface JVM {
     		static final String J1_5 = "j1_5";
     		static final String J1_6 = "j1_6";
     		static final String J1_7 = "j1_7";
     		static final String J1_8 = "j1_8";
     		static final String J1_9 = "j1_9";
+    	}
     	/**
     	 * Fields into the bundle file name message format.
+    	 *
     	 * @see InstallerManager#getPackageSetNameFormat()
     	 * @see InstallerManager#setPackageSetNameFormat(String)
     	 */
     	public static interface PACKAGE_FILE_NAME_FIELDS {
     		static final int GVSIG_VERSION = 0;
     		static final int NAME = 1;
     		static final int VERSION = 2;
     		static final int BUILD = 3;
     		static final int STATE = 4;
     		static final int OS = 5;
     		static final int ARCH = 6;
     		static final int JVM = 7;
+    	}
     	/**
     	 * It registers a class that implements the service for the creation of
     	 * bundle that contains inside a package of type plugin. The registered
     	 * class have to implement the {@link MakePluginPackageService} interface.
+    	 *
     	 * @param clazz
     	 *            class that implements the {@link MakePluginPackageService}
     	 *            interface.
     	 */
     	public void registerMakePluginPackageService(
     			Class<? extends MakePluginPackageService> clazz);
     	// /**
     	// * It creates and returns an object that is used to create a bundle that
     	// * contains inside a package of type 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 creates and returns an object that is used to create a bundle that
     	 * contains inside a package of type plugin. All the parameters are set
     	 * using the {@link MakePluginPackageService} interface. *
+    	 *
     	 * @return an object that is used to create a plugin installer
     	 * @throws MakePluginPackageServiceException
     	 * @throws MakePluginPackageServiceException
     	 *             when there is a problem creating the service
     	 */
     	public MakePluginPackageService getMakePluginPackageService()
     			throws MakePluginPackageServiceException;
     	/**
     	 * Returns a list of package infos for the already installed plugins.
+    	 *
     	 * @param pluginsDirectory
     	 *            where to look for the installed plugins
     	 * @return the list of package infos for the already installed plugins
     	 * @throws MakePluginPackageServiceException
     	 *             if there is an error loading the information of the installed
     	 *             plugins
              * @deprecated use getInstalledPackages() without parameters
     	 */
     	public PackageInfo[] getInstalledPackages(File pluginsDirectory)
     			throws MakePluginPackageServiceException;
     	/**
     	 * Returns a list of package infos for the already installed plugins.
+    	 *
     	 * @return the list of package infos for the already installed plugins
     	 * @throws MakePluginPackageServiceException
     	 *             if there is an error loading the information of the installed
     	 *             plugins
     	 */
     	public PackageInfo[] getInstalledPackages()
     			throws MakePluginPackageServiceException;
     	/**
     	 * Returns the package bundle file name format.
     	 * <p>
     	 * The string has to use a suitable {@link MessageFormat} format, and the
     	 * available field numbers are the ones defined in the
     	 * BUNDLE_FILE_NAME_FIELDS interface.
     	 * </p>
+    	 *
     	 * @return the package bundle file name format.
     	 */
     	public String getPackageSetNameFormat();
     	/**
     	 * Sets the package bundle file name format.
+    	 *
     	 * @see InstallerManager#getPackageSetNameFormat()
     	 * @param packageBundleNameFormat
     	 *            the package bundle file name format.
     	 */
     	public void setPackageSetNameFormat(String packageBundleNameFormat);
     	/**
     	 * Returns the name of the package set file for a given package info.
+    	 *
     	 * @param info
     	 *            of the plugin
     	 * @return the name of the package set file
     	 */
     	public String getPackageSetFileName(PackageInfo info);
     	/**
     	 * Returns the name of the package file for a given package info.
+    	 *
     	 * @param info
     	 *            of the plugin
     	 * @return the name of the package file
     	 */
     	public String getPackageFileName(PackageInfo info);
     	/**
     	 * Returns the name of the package index file for a given package info.
+    	 *
     	 * @param info
     	 *            of the plugin
     	 * @return the name of the package index file
     	 */
     	public String getPackageIndexFileName(PackageInfo info);
     	/**
     	 * It registers a class that implements the service for the installation of
     	 * a package that is inside a bundle. This class has to implement the
     	 * {@link InstallPackageService} interface.
+    	 *
     	 * @param clazz
     	 *            class that implements the {@link InstallPackageService}
     	 *            interface.
     	 */
     	public void registerInstallPackageService(
     			Class<? extends InstallPackageService> clazz);
     	/**
     	 * It creates and returns an object that is used to install a package in
     	 * gvSIG. All the parameters are set using the {@link InstallPackageService}
     	 * interface.
+    	 *
     	 * @return an object that is used to install the package.
     	 * @throws InstallPackageServiceException
     	 *             when there is a problem creating the service.
     	 */
     	public InstallPackageService getInstallPackageService()
     			throws InstallPackageServiceException;
     	/**
     	 * Returns the default extensions of the package files.
+    	 *
     	 * @return the default extensions of the package files
     	 */
     	public String getDefaultPackageFileExtension();
     	/**
     	 * Returns the default extensions of the package set files.
+    	 *
     	 * @return the default extensions of the package set files
     	 */
     	public String getDefaultPackageSetFileExtension();
     	/**
     	 * Returns the default extensions of the index set files.
+    	 *
     	 * @return the default extensions of the index set files
     	 */
     	public String getDefaultIndexSetFileExtension();
     	/**
     	 * Return the OS code of the system
+    	 *
     	 * @return os code of the system
     	 */
     	public String getOperatingSystem();
             public String getOperatingSystemFamily();
     	public String getOperatingSystemName();
     	public String getOperatingSystemVersion();
     	/**
     	 * Returns the Architecture code of the system
+    	 *
     	 * @return architecture code of the system
     	 */
     	public String getArchitecture();
     	/**
     	 * Create a empty dependency object.
+    	 *
     	 * @return the dependency
     	 */
     	public Dependency createDependency();
     	/**
     	 * Create a dependency instance with the data of the package.
+    	 *
     	 * @param packageInfo
     	 * @return a dependency of the package
     	 */
     	public Dependency createDependency(PackageInfo packageInfo);
     	/**
     	 * Create a dependencies calculator.
+    	 *
     	 * @return the dependencias calculator

Application: gvSIG desktop

Revision 42955