Class InstallerModule

java.lang.Object

org.bgerp.app.dist.inst.InstallerModule

public class InstallerModule
extends Object

Processor of a ZIP update package

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InstallerModule.Report	Report of replaced and removed files during an installation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTRY_MODULE_PROPERTIES	ZIP entry name of the module descriptor
protected static final String	MESSAGE_ERROR	Error result message
protected static final String	MESSAGE_OK	Success result message

Constructor Summary

Constructors

Constructor	Description
InstallerModule(Setup setup, File targetDir, File zip)	Installs a module from a ZIP package: executes its calls, copies files and removes excess ones.

Method Summary

Modifier and Type	Method	Description
protected boolean	copyFiles(File zip, Module mi)	Copies the package content files into the target directory.
protected void	executeCalls(Module mi, Setup setup, File zip)	Executes the module's InstallationCalls.
protected Module	getModuleInf(File zip)	Reads ENTRY_MODULE_PROPERTIES from the ZIP package.
InstallerModule.Report	getReport()	Installation report.

Methods inherited from class Object

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

Field Details

MESSAGE_ERROR

protected static final String MESSAGE_ERROR

Error result message

See Also:

• Constant Field Values

MESSAGE_OK

protected static final String MESSAGE_OK

Success result message

See Also:

• Constant Field Values

ENTRY_MODULE_PROPERTIES

public static final String ENTRY_MODULE_PROPERTIES

ZIP entry name of the module descriptor

See Also:

• Constant Field Values

Constructor Details

InstallerModule

public InstallerModule(Setup setup,
 File targetDir,
 File zip)
                throws Exception

Installs a module from a ZIP package: executes its calls, copies files and removes excess ones.

Parameters:

setup - application setup

targetDir - directory to be updated

zip - the module ZIP file

Throws:

Exception - on an installation error

Method Details

getModuleInf

protected Module getModuleInf(File zip)

Reads ENTRY_MODULE_PROPERTIES from the ZIP package.

Parameters:

zip - the module ZIP file

Returns:

module info, or null if not found

copyFiles

protected boolean copyFiles(File zip,
 Module mi)

Copies the package content files into the target directory.

Parameters:

zip - the module ZIP file

mi - module info

Returns:

true on success

executeCalls

protected void executeCalls(Module mi,
 Setup setup,
 File zip)
                     throws Exception

Executes the module's InstallationCalls.

Parameters:

mi - module info

setup - application setup

zip - the module ZIP file

Throws:

Exception - on a call error

getReport

public InstallerModule.Report getReport()

Installation report.

Returns:

report