Application: gvSIG desktop

 * Information of a package that is used on the installation process.

 * This information is composed by next fields:

 * </br> <li>

    /**

     * @return

     *         Gets the code of the package.

     */

    public String getCode();

    public void setCode(String code);

    public String getID();

    /**

     * @return

     *         Gets the name of the package.

     */

    public String getName();

    public void setName(String name);

    /**

     * @return

     *         Gets the description of the package.

     */

    public String getDescription();

    public void setDescription(String description);

    /**

     * @return

     *         Gets the version of the package.

     */

    public Version getVersion();

    public void setVersion(String version);

    public void setVersion(Version version);

    /**

     * @return

     *         Gets the build number of the package.

     */

    public int getBuild();

    public void setBuild(int build);

    /**

     * @return

     *         Gets the state of the package.

     * @see STATE

     */

    public String getState();

    /**

     * Sets the state of the package

     * 

     * @param state

     * @see STATE

     */

    public void setState(String state);

    /**

     * @return

     *         Gets if the package is official.

     */

    public boolean isOfficial();

    public void setOfficial(boolean official);

    /**

     * @return

     *         Gets the type of the package.

     */

    public String getType();

    public void setType(String type);

    /**

     * Returns the supported operating system.

     * 

     * @return the supported operating system

     * @see OS

     */

    public String getOperatingSystem();

    /**

     * Sets the supported operating system.

     * 

     * @param operatingSystem

     *            the supported operating system

     * @see OS

     */

    public void setOperatingSystem(String operatingSystem);

    /**

     * Returns the supported hardware architecture.

     * 

     * @return the supported hardware architecture

     * @see ARCH

     */

    public String getArchitecture();

    /**

     * Sets the supported hardware architecture.

     * 

     * @param architecture

     *            the supported hardware architecture

     * @see ARCH

     */

    public void setArchitecture(String architecture);

    /**

     * Returns the supported java vm version.

     * 

     * @return the supported java vm version

     * @see JVM

     */

    public String getJavaVM();

    /**

     * Sets the supported java vm version.

     * 

     * @param javaVM

     *            the supported java vm version

     * @see JVM

     */

    public void setJavaVM(String javaVM);

    /**

     * Returns the supported gvSIG version.

     * 

     * @return the supported gvSIG version

     */

    public String getGvSIGVersion();

    /**

     * Sets the supported gvSIG version.

     * 

     * @param gvSIGVersion

     *            the supported gvSIG version

     */

    public void setGvSIGVersion(String gvSIGVersion);

    /**

     * Returns the package bundle download {@link URL}.

     * 

     * May be null if there is no remote URL to download the bundle.

     * 

     * @return the package bundle download {@link URL}

     */

    public URL getDownloadURL();

    public String getDownloadURLAsString();

//    /**

//     * Returns the package bundle download {@link URL}.

//     * 

//     * May be null if there is no remote URL to download the bundle.

//     * 

//     * @return the package bundle download {@link URL}

//     */

    public URL getDownloadURL(URL baseURL);

    /**

     * Sets the package bundle download {@link URL}. Optional.

     * 

     * @param defaultURL

     *            the package bundle download {@link URL}

     */

    public void setDownloadURL(URL defaultURL);

    public void setDownloadURL(String defaultDownloadURL);

    /**

     * Returns the package info model version.

     * 

     * @return the package info model version

     */

    public String getModelVersion();

    /**

     * Sets the package info model version.

     * 

     * @param modelVersion

     *            the package info model version

     */

    public void setModelVersion(String modelVersion);

    public String getOwner();

    /**

     * Sets the package owner.

     * 

     * @param owner

     *            the package owner

     */

    public void setOwner(String owner);

    /**

     * Returns the package source files url {@link URL}.

     * 

     * @return the package source files url {@link URL}

     */

    public URL getSourcesURL();

    /**

     * Sets the package sources.

     * 

     * @param sources

     *            the package sources

     */

    public void setSourcesURL(URL sources);

    /**

     * Returns the package web url {@link URL}.

     * 

     * @return the package web url {@link URL}

     */

    public URL getWebURL();

    /**

     * Sets the package web url {@link URL}.

     * 

     * @param webURL

     *            the package web url {@link URL}

     */

    public void setWebURL(URL webURL);

    /**

     * Gets the ant script that has to be executed in the

     * installation process.

     * 

     * @return

     *         the script.

     */

    public String getAntScript();

    /**

     * Sets the ant script that can be executed in the

     * installation process.

     * 

     * @param antScript

     *            The ant script to copy.

     */

    public void setAntScript(String antScript);

    public File downloadFile() throws InstallPackageServiceException;

    public File downloadFile(SimpleTaskStatus taskStatus)

        throws InstallPackageServiceException;

    /**

     * @return

     */

    public void addFileToCopy(File file);

    public File getFileToCopy(int i);

    public void removeFileToCopy(File file);

    public void clearFilesToCopy();

    public List<File> getFilesToCopy();

    /**

     * @param folder

     * @return

     */

    public boolean removeInstallFolder(File folder);

    public boolean removeFilesFolder(File folder);

    /**

     * @param string

     * @return

     */

    public boolean matchID(String string);

    public Dependencies getDependencies();

    public void setDependencies(String dependencies);

    public void setDependencies(Dependencies dependencies);

    public String toStringCompact();

    public List<String> getCategories();

    public void setCategories(List<String> categoriesList);

    public String getCategoriesAsString();

    public void addCategoriesAsString(String categoriesString);

 * installation of packages from a bundle.

 * </p>

    /**

     * 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 OSX_10_4 = "osx_10_4";

        static final String OSX_10_5 = "osx_10_5";

        static final String OSX_10_6 = "osx_10_6";

    }

    /**

     * 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";

    }

    /**

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

    /**

     * 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

     */

    public PackageInfo[] getInstalledPackages(File pluginsDirectory)

        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

     */

    /**

     * Returns the Architecture code of the system

     *   

     * @return architecture code of the system

     */

    public String getArchitecture();

	 * Create a dependency instance with the data of the

	 * package.

	public DependenciesCalculator createDependenciesCalculator(InstallPackageService installService);

    public PackageInfoWriter getDefaultPackageInfoWriter();

    public PackageInfoReader getDefaultPackageInfoReader();

    public MakePackageService createMakePackage(File packageFolder, PackageInfo packageInfo);

    public void setDownloadBaseURL(URL url);

    public URL getDownloadBaseURL();

    public void setVersion(String version);

    public String getVersion();

 *

    public void read(PackageInfo installerInfoResource, InputStream is)

    throws BaseException;

    public Dependencies getUnresolvedDependencies();

    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);

    }

    @Override

    public void doRegistration() {

        registerAsAPI(InstallerLibrary.class);

        this.require(ToolsLibrary.class);

    }

    @Override

    protected void doInitialize() throws LibraryException {

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

    }

 *

    public int getCompleted();

    public String getLabel();

    public void requestCancel();

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

    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);

    }

    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)