org.alfresco.repo.module.tool
Class ModuleManagementTool

java.lang.Object
  extended by org.alfresco.repo.module.tool.ModuleManagementTool

public class ModuleManagementTool
extends java.lang.Object

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

Field Summary
static java.lang.String BACKUP_DIR
           
static de.schlichtherle.io.ZipDetector DETECTOR_AMP_AND_WAR
          Default zip detector
static java.lang.String MODULE_DIR
          Standard directories found in the alfresco war
 
Constructor Summary
ModuleManagementTool()
          Constructor
 
Method Summary
 void disableModule(java.lang.String moduleId, java.lang.String warLocation)
           
 void enableModule(java.lang.String moduleId, java.lang.String warLocation)
           
 void installModule(java.lang.String ampFileLocation, java.lang.String warFileLocation)
          Installs a given AMP file into a given WAR file.
 void installModule(java.lang.String ampFileLocation, java.lang.String warFileLocation, boolean preview, boolean forceInstall, boolean backupWAR)
          Installs a given AMP file into a given WAR file.
 void installModules(java.lang.String directory, java.lang.String warFileLocation)
          Installs all modules within a folder into the given WAR file.
 void installModules(java.lang.String directoryLocation, java.lang.String warFileLocation, boolean preview, boolean forceInstall, boolean backupWAR)
           
 boolean isVerbose()
          Indicates whether the management tool is currently in verbose reporting mode.
 void listModules(java.lang.String warLocation)
          Lists all the currently installed modules in the WAR
static void main(java.lang.String[] args)
          Main
 void setVerbose(boolean verbose)
          Sets the verbose setting for the mangement tool
 void uninstallModule(java.lang.String moduleId, java.lang.String warLocation)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODULE_DIR

public static final java.lang.String MODULE_DIR
Standard directories found in the alfresco war

See Also:
Constant Field Values

BACKUP_DIR

public static final java.lang.String BACKUP_DIR
See Also:
Constant Field Values

DETECTOR_AMP_AND_WAR

public static final de.schlichtherle.io.ZipDetector DETECTOR_AMP_AND_WAR
Default zip detector

Constructor Detail

ModuleManagementTool

public ModuleManagementTool()
Constructor

Method Detail

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(java.lang.String directory,
                           java.lang.String warFileLocation)
Installs all modules within a folder into the given WAR file.

See Also:
ModuleManagementTool.installModule(String, String, boolean, boolean, boolean)

installModules

public void installModules(java.lang.String directoryLocation,
                           java.lang.String warFileLocation,
                           boolean preview,
                           boolean forceInstall,
                           boolean backupWAR)

installModule

public void installModule(java.lang.String ampFileLocation,
                          java.lang.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:
ModuleManagementTool.installModule(String, String, boolean, boolean, boolean)

installModule

public void installModule(java.lang.String ampFileLocation,
                          java.lang.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 replaces reguarless 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

disableModule

public void disableModule(java.lang.String moduleId,
                          java.lang.String warLocation)
Throws:
java.lang.UnsupportedOperationException

enableModule

public void enableModule(java.lang.String moduleId,
                         java.lang.String warLocation)
Throws:
java.lang.UnsupportedOperationException

uninstallModule

public void uninstallModule(java.lang.String moduleId,
                            java.lang.String warLocation)
Throws:
java.lang.UnsupportedOperationException

listModules

public void listModules(java.lang.String warLocation)
Lists all the currently installed modules in the WAR

Parameters:
warLocation - the war location

main

public static void main(java.lang.String[] args)
Main

Parameters:
args - command line interface arguments


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.