org.gvsig.installer.lib.impl.creation

Class DefaultMakePluginPackageService

java.lang.Object

org.gvsig.installer.lib.impl.creation.DefaultMakePluginPackageService

All Implemented Interfaces:

MakePluginPackageService, Service

public class DefaultMakePluginPackageService
extends Object
implements MakePluginPackageService

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANT_FILE_NAME
protected String	antScript
static String	COPIED_FILES_DIRECTORY_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultMakePluginPackageService(InstallerManager manager)

Method Summary

Methods

Modifier and Type	Method and Description
void	createPackage(PackageInfo packageInfo, OutputStream packageStream) It creates a package of a plugin.
void	createPackageIndex(PackageInfo packageInfo, OutputStream packageStream) It creates the index for a package of a plugin.
void	createPackageSet(PackageInfo packageInfo, OutputStream packageStream) It creates a package set with a single plugin package inside.
boolean	deleteDir(File folder)
static boolean	deleteDirectory(File path)
String	getDefaultAntScript() This method returns the default ant script that will be used by some plugins to copy some external files in the installation process.
PackageInfo[]	getInstalledPackages() Returns the list of packages already installed in the application.
Manager	getManager() Returns a reference to the Manager which manages this server.
File	getPluginFolder(PackageInfo packageInfo) Returns the folder where a plugin is located.
int	getPluginPackageCount() It returns the number of plugin packages that are installed in the folder that has been added using the constructor.
PackageInfo	getPluginPackageInfo(int index) It returns an instance of an PackageInfo class, that is a class that contains all the package information (name, version...).
PackageInfo	getPluginPackageInfo(String code) It returns an instance of an PackageInfo class, that is a class that contains all the package information (name, version...).
void	preparePackage(PackageInfo packageInfo, File originalPluginDir) Prepares and copies the needed files for the package.
void	writePackageInfo(PackageInfo packageInfo, File folder) Writes a package info file with the information provided.
void	writePackageInfoForIndex(PackageInfo packageInfo, File folder) Writes a package info file with the information provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANT_FILE_NAME

public static final String ANT_FILE_NAME

See Also:

Constant Field Values

COPIED_FILES_DIRECTORY_NAME

public static final String COPIED_FILES_DIRECTORY_NAME

See Also:

Constant Field Values

antScript

protected String antScript

Constructor Detail

DefaultMakePluginPackageService

public DefaultMakePluginPackageService(InstallerManager manager)
                                throws MakePluginPackageServiceException

Throws:

MakePluginPackageServiceException

Method Detail

createPackageSet

public void createPackageSet(PackageInfo packageInfo,
                    OutputStream packageStream)
                      throws MakePluginPackageServiceException

Description copied from interface: MakePluginPackageService

It creates a package set with a single plugin package inside.

Specified by:

createPackageSet in interface MakePluginPackageService

Parameters:

packageInfo - the information of the plugin that has to be included in the package set

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

preparePackage

public void preparePackage(PackageInfo packageInfo,
                  File originalPluginDir)
                    throws MakePluginPackageServiceException

Description copied from interface: MakePluginPackageService

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.

Specified by:

preparePackage in interface MakePluginPackageService

Throws:

MakePluginPackageServiceException - it is thrown when there is an exception preparing the package

createPackage

public void createPackage(PackageInfo packageInfo,
                 OutputStream packageStream)
                   throws MakePluginPackageServiceException

Description copied from interface: MakePluginPackageService

It creates a package of a plugin.

Specified by:

createPackage in interface MakePluginPackageService

Parameters:

packageInfo - the information of the plugin that has to be included in the package

packageStream - the stream where the the package will be created

Throws:

MakePluginPackageServiceException - it is thrown when there is an exception creating the package

createPackageIndex

public void createPackageIndex(PackageInfo packageInfo,
                      OutputStream packageStream)
                        throws MakePluginPackageServiceException

Description copied from interface: MakePluginPackageService

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.

Specified by:

createPackageIndex in interface MakePluginPackageService

Parameters:

packageInfo - the information of the plugin that has to be included in the package index

packageStream - the stream where the the package index will be created

Throws:

MakePluginPackageServiceException - it is thrown when there is an exception creating the package

writePackageInfo

public void writePackageInfo(PackageInfo packageInfo,
                    File folder)
                      throws MakePluginPackageServiceException

Description copied from interface: MakePluginPackageService

Writes a package info file with the information provided.

Specified by:

writePackageInfo in interface MakePluginPackageService

Parameters:

packageInfo - the package that has to be written into the file

folder - the folder where the file is to be created

Throws:

MakePluginPackageServiceException - it is thrown when there is an exception writing the file

writePackageInfoForIndex

public void writePackageInfoForIndex(PackageInfo packageInfo,
                            File folder)
                              throws MakePluginPackageServiceException

Description copied from interface: MakePluginPackageService

Writes a package info file with the information provided.

Specified by:

writePackageInfoForIndex in interface MakePluginPackageService

Parameters:

packageInfo - the package that has to be written into the file

folder - the folder where the file is to be created

Throws:

MakePluginPackageServiceException - it is thrown when there is an exception writing the file

deleteDirectory

public static boolean deleteDirectory(File path)

getManager

public Manager getManager()

Description copied from interface: Service

Returns a reference to the Manager which manages this server.

Specified by:

getManager in interface Service

Returns:

the server's Manager

getPluginPackageInfo

public PackageInfo getPluginPackageInfo(int index)

Description copied from interface: MakePluginPackageService

It returns an instance of an PackageInfo class, that is a class that contains all the package information (name, version...).

Specified by:

getPluginPackageInfo in interface MakePluginPackageService

Parameters:

index - the position of the plugin that has to be retrieved.

Returns:

the installer information of a plugin package. Returns null if the package doesn't exist.

getPluginPackageInfo

public PackageInfo getPluginPackageInfo(String code)

Description copied from interface: MakePluginPackageService

It returns an instance of an PackageInfo class, that is a class that contains all the package information (name, version...).

Specified by:

getPluginPackageInfo in interface MakePluginPackageService

Parameters:

code - code of the plugin, defined in the package.info file like a property.

Returns:

the installer information of a plugin package. Returns null if the package doesn't exist.

getPluginPackageCount

public int getPluginPackageCount()

Description copied from interface: MakePluginPackageService

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 MakePluginPackageService.getPluginPackageInfo(int) method to know all the installed plugins.

Specified by:

getPluginPackageCount in interface MakePluginPackageService

Returns:

the number of plugins installed in a directory.

getDefaultAntScript

public String getDefaultAntScript()
                           throws MakePluginPackageServiceException

Description copied from interface: MakePluginPackageService

This method returns the default ant script that will be used by some plugins to copy some external files in the installation process.

Specified by:

getDefaultAntScript in interface MakePluginPackageService

Returns:

a string that contains the standard ant script

Throws:

MakePluginPackageServiceException - if there is a problem reading the file

getInstalledPackages

public PackageInfo[] getInstalledPackages()
                                   throws MakePluginPackageServiceException

Description copied from interface: MakePluginPackageService

Returns the list of packages already installed in the application.

Specified by:

getInstalledPackages in interface MakePluginPackageService

Returns:

the list of packages already installed in the application

Throws:

MakePluginPackageServiceException - if there is an error getting the installed packages

getPluginFolder

public File getPluginFolder(PackageInfo packageInfo)
                     throws MakePluginPackageServiceException

Description copied from interface: MakePluginPackageService

Returns the folder where a plugin is located.

Specified by:

getPluginFolder in interface MakePluginPackageService

Returns:

the plugin's folder

Throws:

MakePluginPackageServiceException - if there is an error locating the folder

deleteDir

public boolean deleteDir(File folder)

Specified by:

deleteDir in interface MakePluginPackageService

Returns: