Package org.alfresco.repo.module.tool

Class ModuleManagementTool

java.lang.Object

org.alfresco.repo.module.tool.ModuleManagementTool

All Implemented Interfaces:

LogOutput

public class ModuleManagementTool
extends Object
implements LogOutput

Module management tool.

Manages the modules installed in a war file. Allows modules to be installed, updated, enabled, disabled and uninstalled. Information about the module installed is also available.

Since:

2.0

Author:

Roy Wetherall, Derek Hulley

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BACKUP_DIR	Standard directories found in the alfresco war

Constructor Summary

Constructors

Constructor	Description
ModuleManagementTool()	Constructor

Method Summary

Modifier and Type	Method	Description
void	disableModule(String moduleId, String warLocation)
void	enableModule(String moduleId, String warLocation)
void	info(Object message)
void	installModule(String ampFileLocation, String warFileLocation)	Installs a given AMP file into a given WAR file.
void	installModule(String ampFileLocation, String warFileLocation, boolean preview, boolean forceInstall, boolean backupWAR)	Installs a given AMP file into a given WAR file.
void	installModules(String directory, String warFileLocation)	Installs all modules within a folder into the given WAR file.
void	installModules(String directoryLocation, String warFileLocation, boolean preview, boolean forceInstall, boolean backupWAR)
boolean	isVerbose()	Indicates whether the management tool is currently in verbose reporting mode.
void	listModules(String warLocation)	Lists all the currently installed modules in the WAR
static void	main(String[] args)	Main
void	setVerbose(boolean verbose)	Sets the verbose setting for the mangement tool
void	uninstallModule(String moduleId, String warFileLocation, boolean preview, boolean purge)	Cleans the WAR file of all files relating to the currently installed version of the the Module.

Methods inherited from class java.lang.Object

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

Field Details

BACKUP_DIR

public static final String BACKUP_DIR

Standard directories found in the alfresco war

See Also:

• Constant Field Values

Constructor Details

ModuleManagementTool

public ModuleManagementTool()

Constructor

Method Details

isVerbose

public boolean isVerbose()

Indicates whether the management tool is currently in verbose reporting mode.

Returns:

true if verbose, false otherwise

setVerbose

public void setVerbose(boolean verbose)

Sets the verbose setting for the mangement tool

Parameters:

verbose - true if verbose, false otherwise

installModules

public void installModules(String directory,
 String warFileLocation)
                    throws IOException

Installs all modules within a folder into the given WAR file.

Throws:

IOException

See Also:

• installModule(String, String, boolean, boolean, boolean)

installModules

public void installModules(String directoryLocation,
 String warFileLocation,
 boolean preview,
 boolean forceInstall,
 boolean backupWAR)
                    throws IOException

Throws:

IOException

installModule

public void installModule(String ampFileLocation,
 String warFileLocation)

Installs a given AMP file into a given WAR file.

Parameters:

ampFileLocation - the location of the AMP file to be installed

warFileLocation - the location of the WAR file into which the AMP file is to be installed

See Also:

• installModule(String, String, boolean, boolean, boolean)

installModule

public void installModule(String ampFileLocation,
 String warFileLocation,
 boolean preview,
 boolean forceInstall,
 boolean backupWAR)

Installs a given AMP file into a given WAR file.

Parameters:

ampFileLocation - the location of the AMP file to be installed

warFileLocation - the location of the WAR file into which the AMP file is to be installed.

preview - indicates whether this should be a preview install. This means that the process of installation will be followed and reported, but the WAR file will not be modified.

forceInstall - indicates whether the installed files will be replaced regardless of the currently installed version of the AMP. Generally used during development of the AMP.

backupWAR - indicates whether we should backup the war we are modifying or not

uninstallModule

public void uninstallModule(String moduleId,
 String warFileLocation,
 boolean preview,
 boolean purge)
                     throws IOException

Cleans the WAR file of all files relating to the currently installed version of the the Module.

Parameters:

warFileLocation - the war file location

moduleId - the module id

preview - indicates whether this is a preview installation

purge - Fully delete all files (including those marked "PRESERVED")

Throws:

IOException

disableModule

public void disableModule(String moduleId,
 String warLocation)

Throws:

UnsupportedOperationException

enableModule

public void enableModule(String moduleId,
 String warLocation)

Throws:

UnsupportedOperationException

listModules

public void listModules(String warLocation)

Lists all the currently installed modules in the WAR

Parameters:

warLocation - the war location

Throws:

ModuleManagementToolException

main

public static void main(String[] args)

Main

Parameters:

args - command line interface arguments

info

public void info(Object message)

Specified by:

info in interface LogOutput