info.magnolia.module
Interface ModuleManager

All Known Implementing Classes:
ModuleManagerImpl

public interface ModuleManager

ModuleManager is responsible for the lifecycle of modules. (loads definitions, install/update/uninstall, start/stop)

Version:
$Revision: $ ($Author: $)
Author:
gjoseph

Nested Class Summary
static class ModuleManager.Factory
          Use this to retrieve the configured singleton impl of ModuleManager.
static class ModuleManager.ModuleAndDeltas
          Represents what's to be done for each module.
static class ModuleManager.ModuleManagementState
          Represent what's to be done for all modules.
 
Method Summary
 void checkForInstallOrUpdates()
          Checks if we need to do any module installation, update or uninstall.
 InstallContext getInstallContext()
           
 ModuleManager.ModuleManagementState getStatus()
          Returns the status as discovered by checkForInstallOrUpdates().
 ModuleManagerUI getUI()
           
 List<ModuleDefinition> loadDefinitions()
          Loads modules definitions, validates dependencies and sorts modules by dependencies.
 void performInstallOrUpdate()
           
 void startModules()
           
 void stopModules()
           
 

Method Detail

loadDefinitions

List<ModuleDefinition> loadDefinitions()
                                       throws ModuleManagementException
Loads modules definitions, validates dependencies and sorts modules by dependencies.

Throws:
ModuleManagementException

checkForInstallOrUpdates

void checkForInstallOrUpdates()
                              throws ModuleManagementException
Checks if we need to do any module installation, update or uninstall.

Throws:
ModuleManagementException

getStatus

ModuleManager.ModuleManagementState getStatus()
Returns the status as discovered by checkForInstallOrUpdates().

Throws:
IllegalStateException - if checkForInstallOrUpdates was never called.

getUI

ModuleManagerUI getUI()

performInstallOrUpdate

void performInstallOrUpdate()

getInstallContext

InstallContext getInstallContext()

startModules

void startModules()

stopModules

void stopModules()


Copyright © 2003-2012 Magnolia International Ltd.. All Rights Reserved.