ModuleFactory (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.module.ModuleFactory

```
public class ModuleFactory
extends Object
```
Methods for loading, starting, stopping, and storing OpenMRS modules

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Map<String,List<Extension>>`	`extensionMap`
`protected static com.google.common.cache.Cache<String,Module>`	`loadedModules`
`protected static com.google.common.cache.Cache<Module,ModuleClassLoader>`	`moduleClassLoaders`
`protected static com.google.common.cache.Cache<String,Module>`	`startedModules`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static List<String>`	`getDependencies(String moduleId)` Convenience method used to identify module interdependencies and alert the user before modules are shut down.
`static Map<String,List<Extension>>`	`getExtensionMap()` Return the current extension map keyed on extension point id
`static List<Extension>`	`getExtensions(String pointId)` Return all of the extensions associated with the given `pointId` Returns empty extension list if no modules extend this pointId
`static List<Extension>`	`getExtensions(String pointId, Extension.MEDIA_TYPE type)` Return all of the extensions associated with the given `pointId` Returns getExtension(pointId) if no modules extend this pointId for given media type
`static List<GlobalProperty>`	`getGlobalProperties()` Get a list of required GlobalProperties defined by the modules
`static Collection<Module>`	`getLoadedModules()` Returns all modules found/loaded into the system (started and not started)
`static List<Module>`	`getLoadedModulesCoreFirst()` Returns all modules found/loaded into the system (started and not started), with the core modules at the start of that list
`static Map<String,Module>`	`getLoadedModulesMap()` Returns all modules found/loaded into the system (started and not started) in the form of a map<ModuleId, Module>
`static Map<String,Module>`	`getLoadedModulesMapPackage()` Returns all modules found/loaded into the system (started and not started) in the form of a map<PackageName, Module>
`static Module`	`getModuleById(String moduleId)`
`static Module`	`getModuleByPackage(String modulePackage)`
`static ModuleClassLoader`	`getModuleClassLoader(Module mod)` Get a module's classloader
`static ModuleClassLoader`	`getModuleClassLoader(String moduleId)` Get a module's classloader via the module id
`static Map<Module,ModuleClassLoader>`	`getModuleClassLoaderMap()` Return all current classloaders keyed on module object
`static Collection<ModuleClassLoader>`	`getModuleClassLoaders()` Returns all module classloaders This method will not return null
`static Set<ModuleClassLoader>`	`getModuleClassLoadersForPackage(String packageName)`
`static List<Module>`	`getModulesInStartupOrder(Collection<Module> modules)` Sort modules in startup order based on required and aware-of dependencies
`static List<Privilege>`	`getPrivileges()` Get a list of required Privileges defined by the modules
`static Module`	`getStartedModuleById(String moduleId)`
`static Collection<Module>`	`getStartedModules()` Returns the modules that have been successfully started
`static List<Module>`	`getStartedModulesInOrder()`
`static Map<String,Module>`	`getStartedModulesMap()` Returns the modules that have been successfully started in the form of a map<ModuleId, Module>
`static boolean`	`isModuleStarted(Module mod)` Checks whether the given module is activated
`static boolean`	`isModuleStarted(String moduleId)` Checks whether the given module, identified by its id, is started.
`static boolean`	`isTokenValid(DaemonToken token)` Validates the given token.
`static void`	`loadAdvice(Module module)` Loop over the given module's advice objects and load them into the Context This needs to be called for all started modules after every restart of the Spring Application Context
`static Module`	`loadModule(File moduleFile)` Add a module (in the form of a jar file) to the list of openmrs modules Returns null if an error occurred and/or module was not successfully loaded
`static Module`	`loadModule(File moduleFile, Boolean replaceIfExists)` Add a module (in the form of a jar file) to the list of openmrs modules Returns null if an error occurred and/or module was not successfully loaded
`static Module`	`loadModule(Module module, Boolean replaceIfExists)` Add a module to the list of openmrs modules
`static void`	`loadModules()` Load OpenMRS modules from `OpenmrsUtil.getModuleRepository()`
`static void`	`loadModules(List<File> modulesToLoad)` Attempt to load the given files as OpenMRS modules
`static Module`	`startModule(Module module)`
`static Module`	`startModule(Module module, boolean isOpenmrsStartup, org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext)` Runs through extensionPoints and then calls `BaseModuleActivator.willStart()` on the Module's activator.
`static Module`	`startModuleInternal(Module module)` This method should not be called directly.
`static Module`	`startModuleInternal(Module module, boolean isOpenmrsStartup, org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext)` This method should not be called directly.
`static void`	`startModules()` Try to start all of the loaded modules that have the global property moduleId.started is set to "true" or the property does not exist.
`static void`	`stopModule(Module mod)` Runs through the advice and extension points and removes from api.
`static void`	`stopModule(Module mod, boolean isShuttingDown)` Runs through the advice and extension points and removes from api.
`static List<Module>`	`stopModule(Module mod, boolean skipOverStartedProperty, boolean isFailedStartup)` Runs through the advice and extension points and removes from api.
`static void`	`unloadModule(Module mod)` Removes module from module repository
`static Module`	`updateModule(Module mod)` Update the module: 1) Download the new module 2) Unload the old module 3) Load/start the new module

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - loadedModules
```
protected static final com.google.common.cache.Cache<String,Module> loadedModules
```
  - startedModules
```
protected static final com.google.common.cache.Cache<String,Module> startedModules
```
  - extensionMap
```
protected static final Map<String,List<Extension>> extensionMap
```
  - moduleClassLoaders
```
protected static final com.google.common.cache.Cache<Module,ModuleClassLoader> moduleClassLoaders
```
- Method Detail
  - loadModule
```
public static Module loadModule(File moduleFile)
                         throws ModuleException
```
    Add a module (in the form of a jar file) to the list of openmrs modules Returns null if an error occurred and/or module was not successfully loaded
    
    Parameters:
    
    moduleFile -
    
    Returns:
    
    Module
    
    Throws:
    
    ModuleException
  - loadModule
```
public static Module loadModule(File moduleFile,
                                Boolean replaceIfExists)
                         throws ModuleException
```
    Add a module (in the form of a jar file) to the list of openmrs modules Returns null if an error occurred and/or module was not successfully loaded
    
    Parameters:
    
    moduleFile -
    
    replaceIfExists - unload a module that has the same moduleId if one is loaded already
    
    Returns:
    
    Module
    
    Throws:
    
    ModuleException
  - loadModule
```
public static Module loadModule(Module module,
                                Boolean replaceIfExists)
                         throws ModuleException
```
    Add a module to the list of openmrs modules
    
    Parameters:
    
    module -
    
    replaceIfExists - unload a module that has the same moduleId if one is loaded already Should load module if it is currently not loaded Should not load module if already loaded Should always load module if replacement is wanted Should not load an older version of the same module Should load a newer version of the same module
    
    Returns:
    
    module the module that was loaded or if the module exists already with the same version, the old module
    
    Throws:
    
    ModuleException
  - loadModules
```
public static void loadModules()
```
    Load OpenMRS modules from OpenmrsUtil.getModuleRepository()
  - loadModules
```
public static void loadModules(List<File> modulesToLoad)
```
    Attempt to load the given files as OpenMRS modules
    
    Parameters:
    
    modulesToLoad - the list of files to try and load Should not crash when file is not found or broken Should setup requirement mappings for every module Should not start the loaded modules
  - startModules
```
public static void startModules()
```
    Try to start all of the loaded modules that have the global property moduleId.started is set to "true" or the property does not exist. Otherwise, leave it as only "loaded"
    
    Modules that are already started will be skipped.
  - getModulesInStartupOrder
```
public static List<Module> getModulesInStartupOrder(Collection<Module> modules)
                                             throws CycleException
```
    Sort modules in startup order based on required and aware-of dependencies
    
    Parameters:
    
    modules - list of modules to sort
    
    Returns:
    
    list of modules sorted by dependencies
    
    Throws:
    
    CycleException
  - getLoadedModulesCoreFirst
```
public static List<Module> getLoadedModulesCoreFirst()
```
    Returns all modules found/loaded into the system (started and not started), with the core modules at the start of that list
    
    Returns:
    
    List<Module> of the modules loaded into the system, with the core modules first.
  - getLoadedModules
```
public static Collection<Module> getLoadedModules()
```
    Returns all modules found/loaded into the system (started and not started)
    
    Returns:
    
    Collection<Module> of the modules loaded into the system
  - getLoadedModulesMap
```
public static Map<String,Module> getLoadedModulesMap()
```
    Returns all modules found/loaded into the system (started and not started) in the form of a map<ModuleId, Module>
    
    Returns:
    
    map<ModuleId, Module>
  - getLoadedModulesMapPackage
```
public static Map<String,Module> getLoadedModulesMapPackage()
```
    Returns all modules found/loaded into the system (started and not started) in the form of a map<PackageName, Module>
    
    Returns:
    
    map<PackageName, Module>
  - getStartedModules
```
public static Collection<Module> getStartedModules()
```
    Returns the modules that have been successfully started
    
    Returns:
    
    Collection<Module> of the started modules
  - getStartedModulesInOrder
```
public static List<Module> getStartedModulesInOrder()
```
  - getStartedModulesMap
```
public static Map<String,Module> getStartedModulesMap()
```
    Returns the modules that have been successfully started in the form of a map<ModuleId, Module>
    
    Returns:
    
    Map<ModuleId, Module>
  - getModuleById
```
public static Module getModuleById(String moduleId)
```
    Parameters:
    
    moduleId -
    
    Returns:
    
    Module matching module id or null if none
  - getStartedModuleById
```
public static Module getStartedModuleById(String moduleId)
```
    Parameters:
    
    moduleId -
    
    Returns:
    
    Module matching moduleId, if it is started or null otherwise
  - getModuleByPackage
```
public static Module getModuleByPackage(String modulePackage)
```
    Parameters:
    
    modulePackage -
    
    Returns:
    
    Module matching module package or null if none
  - startModule
```
public static Module startModule(Module module)
                          throws ModuleException
```
    Throws:
    
    ModuleException
    
    See Also:
    
    startModule(Module, boolean, AbstractRefreshableApplicationContext), startModuleInternal(Module), Daemon.startModule(Module)
  - startModule
```
public static Module startModule(Module module,
                                 boolean isOpenmrsStartup,
                                 org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext)
                          throws ModuleException
```
    Runs through extensionPoints and then calls BaseModuleActivator.willStart() on the Module's activator. This method is run in a new thread and is authenticated as the Daemon user. If a non null application context is passed in, it gets refreshed to make the module's services available
    
    Parameters:
    
    module - Module to start
    
    isOpenmrsStartup - Specifies whether this module is being started at application startup or not, this argument is ignored if a null application context is passed in
    
    applicationContext - the spring application context instance to refresh
    
    Throws:
    
    ModuleException - if the module throws any kind of error at startup or in an activator
    
    See Also:
    
    startModuleInternal(Module, boolean, AbstractRefreshableApplicationContext), Daemon.startModule(Module, boolean, AbstractRefreshableApplicationContext)
  - startModuleInternal
```
public static Module startModuleInternal(Module module)
                                  throws ModuleException
```
    This method should not be called directly.
    
    The startModule(Module) (and hence Daemon.startModule(Module)) calls this method in a new Thread and is authenticated as the Daemon user
    
    Runs through extensionPoints and then calls BaseModuleActivator.willStart() on the Module's activator.
    
    Parameters:
    
    module - Module to start
    
    Throws:
    
    ModuleException
  - startModuleInternal
```
public static Module startModuleInternal(Module module,
                                         boolean isOpenmrsStartup,
                                         org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext)
                                  throws ModuleException
```
    This method should not be called directly.
    
    The startModule(Module) (and hence Daemon.startModule(Module)) calls this method in a new Thread and is authenticated as the Daemon user
    
    Runs through extensionPoints and then calls BaseModuleActivator.willStart() on the Module's activator.
    
    If a non null application context is passed in, it gets refreshed to make the module's services available
    
    Parameters:
    
    module - Module to start
    
    isOpenmrsStartup - Specifies whether this module is being started at application startup or not, this argument is ignored if a null application context is passed in
    
    applicationContext - the spring application context instance to refresh
    
    Throws:
    
    ModuleException
  - getModuleClassLoadersForPackage
```
public static Set<ModuleClassLoader> getModuleClassLoadersForPackage(String packageName)
```
  - loadAdvice
```
public static void loadAdvice(Module module)
```
    Loop over the given module's advice objects and load them into the Context This needs to be called for all started modules after every restart of the Spring Application Context
    
    Parameters:
    
    module -
  - stopModule
```
public static void stopModule(Module mod)
```
    Runs through the advice and extension points and removes from api.
    Also calls mod.Activator.shutdown()
    
    Parameters:
    
    mod - module to stop
    
    See Also:
    
    stopModule(Module, boolean, boolean)
  - stopModule
```
public static void stopModule(Module mod,
                              boolean isShuttingDown)
```
    Runs through the advice and extension points and removes from api.
    Also calls mod.Activator.shutdown()
    
    Parameters:
    
    mod - the module to stop
    
    isShuttingDown - true if this is called during the process of shutting down openmrs
    
    See Also:
    
    stopModule(Module, boolean, boolean)
  - stopModule
```
public static List<Module> stopModule(Module mod,
                                      boolean skipOverStartedProperty,
                                      boolean isFailedStartup)
                               throws ModuleMustStartException
```
    Runs through the advice and extension points and removes from api.
    skipOverStartedProperty should only be true when openmrs is stopping modules because it is shutting down. When normally stopping a module, use stopModule(Module) (or leave value as false). This property controls whether the globalproperty is set for startup/shutdown.
    Also calls module's ModuleActivator.stopped()
    
    Parameters:
    
    mod - module to stop
    
    skipOverStartedProperty - true if we don't want to set <moduleid>.started to false
    
    isFailedStartup - true if this is being called as a cleanup because of a failed module startup
    
    Returns:
    
    list of dependent modules that were stopped because this module was stopped. This will never be null.
    
    Throws:
    
    ModuleMustStartException
  - unloadModule
```
public static void unloadModule(Module mod)
```
    Removes module from module repository
    
    Parameters:
    
    mod - module to unload
  - getExtensions
```
public static List<Extension> getExtensions(String pointId)
```
    Return all of the extensions associated with the given pointId Returns empty extension list if no modules extend this pointId
    
    Parameters:
    
    pointId -
    
    Returns:
    
    List of extensions
  - getExtensions
```
public static List<Extension> getExtensions(String pointId,
                                            Extension.MEDIA_TYPE type)
```
    Return all of the extensions associated with the given pointId Returns getExtension(pointId) if no modules extend this pointId for given media type
    
    Parameters:
    
    pointId -
    
    type - Extension.MEDIA_TYPE
    
    Returns:
    
    List of extensions
  - getPrivileges
```
public static List<Privilege> getPrivileges()
```
    Get a list of required Privileges defined by the modules
    
    Returns:
    
    List<Privilege> of the required privileges
  - getGlobalProperties
```
public static List<GlobalProperty> getGlobalProperties()
```
    Get a list of required GlobalProperties defined by the modules
    
    Returns:
    
    List<GlobalProperty> object of the module's global properties
  - isModuleStarted
```
public static boolean isModuleStarted(Module mod)
```
    Checks whether the given module is activated
    
    Parameters:
    
    mod - Module to check
    
    Returns:
    
    true if the module is started, false otherwise
  - isModuleStarted
```
public static boolean isModuleStarted(String moduleId)
```
    Checks whether the given module, identified by its id, is started.
    
    Parameters:
    
    moduleId - module id. e.g formentry, logic
    
    Returns:
    
    true if the module is started, false otherwise
    
    Since:
    
    1.9
  - getModuleClassLoader
```
public static ModuleClassLoader getModuleClassLoader(Module mod)
                                              throws ModuleException
```
    Get a module's classloader
    
    Parameters:
    
    mod - Module to fetch the class loader for
    
    Returns:
    
    ModuleClassLoader pertaining to this module. Returns null if the module is not started
    
    Throws:
    
    ModuleException - if the module does not have a registered classloader
  - getModuleClassLoader
```
public static ModuleClassLoader getModuleClassLoader(String moduleId)
                                              throws ModuleException
```
    Get a module's classloader via the module id
    
    Parameters:
    
    moduleId - String id of the module
    
    Returns:
    
    ModuleClassLoader pertaining to this module. Returns null if the module is not started
    
    Throws:
    
    ModuleException - if this module isn't started or doesn't have a classloader
    
    See Also:
    
    getModuleClassLoader(Module)
  - getModuleClassLoaders
```
public static Collection<ModuleClassLoader> getModuleClassLoaders()
```
    Returns all module classloaders This method will not return null
    
    Returns:
    
    Collection<ModuleClassLoader> all known module classloaders or empty list.
  - getModuleClassLoaderMap
```
public static Map<Module,ModuleClassLoader> getModuleClassLoaderMap()
```
    Return all current classloaders keyed on module object
    
    Returns:
    
    Map<Module, ModuleClassLoader>
  - getExtensionMap
```
public static Map<String,List<Extension>> getExtensionMap()
```
    Return the current extension map keyed on extension point id
    
    Returns:
    
    Map<String, List<Extension>>
  - updateModule
```
public static Module updateModule(Module mod)
                           throws ModuleException
```
    Update the module: 1) Download the new module 2) Unload the old module 3) Load/start the new module
    
    Parameters:
    
    mod -
    
    Throws:
    
    ModuleException
  - isTokenValid
```
public static boolean isTokenValid(DaemonToken token)
```
    Validates the given token.
    It is thread safe.
    
    Parameters:
    
    token -
    
    Since:
    
    1.9.2
  - getDependencies
```
public static List<String> getDependencies(String moduleId)
```
    Convenience method used to identify module interdependencies and alert the user before modules are shut down.
    
    Parameters:
    
    moduleId - the moduleId used to identify the module being validated
    
    Returns:
    
    List<dependentModules> the list of moduleId's which depend on the module about to be shutdown.
    
    Since:
    
    1.10

Class ModuleFactory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

loadedModules

startedModules

extensionMap

moduleClassLoaders

Method Detail

loadModule

loadModule

loadModule

loadModules

loadModules

startModules

getModulesInStartupOrder

getLoadedModulesCoreFirst

getLoadedModules

getLoadedModulesMap

getLoadedModulesMapPackage

getStartedModules

getStartedModulesInOrder

getStartedModulesMap

getModuleById

getStartedModuleById

getModuleByPackage

startModule

startModule

startModuleInternal

startModuleInternal

getModuleClassLoadersForPackage

loadAdvice

stopModule

stopModule

stopModule

unloadModule

getExtensions

getExtensions

getPrivileges

getGlobalProperties

isModuleStarted

isModuleStarted

getModuleClassLoader

getModuleClassLoader

getModuleClassLoaders

getModuleClassLoaderMap

getExtensionMap

updateModule

isTokenValid

getDependencies