public class ModuleManagementTool extends Object implements LogOutput
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.
Modifier and Type | Field and Description |
---|---|
static String |
BACKUP_DIR
Standard directories found in the alfresco war
|
Constructor and Description |
---|
ModuleManagementTool()
Constructor
|
Modifier and Type | Method and 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.
|
public static final String BACKUP_DIR
public boolean isVerbose()
public void setVerbose(boolean verbose)
verbose
- true if verbose, false otherwisepublic void installModules(String directory, String warFileLocation) throws IOException
IOException
installModule(String, String, boolean, boolean, boolean)
public void installModules(String directoryLocation, String warFileLocation, boolean preview, boolean forceInstall, boolean backupWAR) throws IOException
IOException
public void installModule(String ampFileLocation, String warFileLocation)
ampFileLocation
- the location of the AMP file to be installedwarFileLocation
- the location of the WAR file into which the AMP file is to be installedinstallModule(String, String, boolean, boolean, boolean)
public void installModule(String ampFileLocation, String warFileLocation, boolean preview, boolean forceInstall, boolean backupWAR)
ampFileLocation
- the location of the AMP file to be installedwarFileLocation
- 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 notpublic void uninstallModule(String moduleId, String warFileLocation, boolean preview, boolean purge) throws IOException
warFileLocation
- the war file locationmoduleId
- the module idpreview
- indicates whether this is a preview installationpurge
- Fully delete all files (including those marked "PRESERVED")IOException
public void disableModule(String moduleId, String warLocation)
UnsupportedOperationException
public void enableModule(String moduleId, String warLocation)
UnsupportedOperationException
public void listModules(String warLocation)
warLocation
- the war locationModuleManagementToolException
public static void main(String[] args)
args
- command line interface argumentsCopyright © 2005–2017 Alfresco Software. All rights reserved.