org.alfresco.repo.module.tool

Class WarHelperImpl

java.lang.Object

org.alfresco.repo.module.tool.WarHelperImpl

All Implemented Interfaces:

WarHelper

Direct Known Subclasses:

WarHelperImplTest

public class WarHelperImpl
extends java.lang.Object
implements WarHelper

Performs logic for the Module Management Tool.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION_PROPERTIES

Fields inherited from interface org.alfresco.repo.module.tool.WarHelper

MODULE_CONFIG_IN_WAR, MODULE_NAMESPACE_DIR

Constructor Summary

Constructors

Constructor and Description
WarHelperImpl(LogOutput log)

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
protected ModuleDetails	getModuleDetails(de.schlichtherle.truezip.file.TFile war, java.lang.String moduleId) Gets the module details for the specified module from the war.
ModuleDetails	getModuleDetailsOrAlias(de.schlichtherle.truezip.file.TFile war, ModuleDetails installingModuleDetails) Gets the module details or an available alias

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_PROPERTIES

public static final java.lang.String VERSION_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

WarHelperImpl

public WarHelperImpl(LogOutput log)

Method Detail

checkCompatibleVersion

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

Description copied from interface: WarHelper

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

Specified by:

checkCompatibleVersion in interface WarHelper

Parameters:

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

checkCompatibleEdition

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

Description copied from interface: WarHelper

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.

Specified by:

checkCompatibleEdition in interface WarHelper

Parameters:

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

checkModuleDependencies

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

Description copied from interface: WarHelper

Checks the dependencies of this module

Specified by:

checkModuleDependencies in interface WarHelper

getModuleDetailsOrAlias

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

Description copied from interface: WarHelper

Gets the module details or an available alias

Specified by:

getModuleDetailsOrAlias in interface WarHelper

Parameters:

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

Returns:

ModuleDetails

getModuleDetails

protected ModuleDetails getModuleDetails(de.schlichtherle.truezip.file.TFile war,
                             java.lang.String moduleId)

Gets the module details for the specified module from the war.

Parameters:

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

moduleId -

Returns: