org.alfresco.repo.module.tool

Interface WarHelper

All Known Implementing Classes:

WarHelperImpl, WarHelperImplTest

public interface WarHelper

Performs various actions on a war file or exploded war directory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODULE_CONFIG_IN_WAR
static java.lang.String	MODULE_NAMESPACE_DIR

Method Summary

Methods

Modifier and Type	Method and Description
void	checkCompatibleEdition(de.schlichtherle.truezip.file.TFile war, ModuleDetails installingModuleDetails) This checks to see if the module that is being installed is compatible with the war.
void	checkCompatibleVersion(de.schlichtherle.truezip.file.TFile war, ModuleDetails installingModuleDetails) Checks to see if the module is compatible with the version of Alfresco.
void	checkModuleDependencies(de.schlichtherle.truezip.file.TFile war, ModuleDetails installingModuleDetails) Checks the dependencies of this module
ModuleDetails	getModuleDetailsOrAlias(de.schlichtherle.truezip.file.TFile war, ModuleDetails installingModuleDetails) Gets the module details or an available alias

Field Detail

MODULE_NAMESPACE_DIR

static final java.lang.String MODULE_NAMESPACE_DIR

See Also:

Constant Field Values

MODULE_CONFIG_IN_WAR

static final java.lang.String MODULE_CONFIG_IN_WAR

See Also:

Constant Field Values

Method Detail

getModuleDetailsOrAlias

ModuleDetails getModuleDetailsOrAlias(de.schlichtherle.truezip.file.TFile war,
                                    ModuleDetails installingModuleDetails)

Gets the module details or an available alias

Parameters:

war - a valid war file or exploded directory from a war

installingModuleDetails -

Returns:

ModuleDetails

checkModuleDependencies

void checkModuleDependencies(de.schlichtherle.truezip.file.TFile war,
                           ModuleDetails installingModuleDetails)

Checks the dependencies of this module

Parameters:

war -

installingModuleDetails -

checkCompatibleVersion

void checkCompatibleVersion(de.schlichtherle.truezip.file.TFile war,
                          ModuleDetails installingModuleDetails)

Checks to see if the module is compatible with the version of Alfresco.

Parameters:

war - a valid war file or exploded directory from a war

checkCompatibleEdition

void checkCompatibleEdition(de.schlichtherle.truezip.file.TFile war,
                          ModuleDetails installingModuleDetails)

This checks to see if the module that is being installed is compatible with the war. If not module edition is specfied then it will just return. However, if an edition is specified and it doesn't match then an error is thrown.

Parameters:

war - a valid war file or exploded directory from a war

installingModuleDetails -