Uses of Class
org.openmrs.module.Module

Packages that use Module

Package	Description
org.openmrs.api.context	This package describes the context framework through which authentication is performed and services provided for the OpenMRS system.
org.openmrs.module	OpenMRS Module classes
org.openmrs.module.web
org.openmrs.module.web.filter
org.openmrs.web

Uses of Module in org.openmrs.api.context

Methods in org.openmrs.api.context that return Module

Modifier and Type	Method and Description
static Module	Daemon.startModule(Module module)
static Module	Daemon.startModule(Module module, boolean isOpenmrsStartup, org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext) This method should not be called directly.

Methods in org.openmrs.api.context with parameters of type Module

Modifier and Type	Method and Description
static Module	Daemon.startModule(Module module)
static Module	Daemon.startModule(Module module, boolean isOpenmrsStartup, org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext) This method should not be called directly.

Uses of Module in org.openmrs.module

Fields in org.openmrs.module with type parameters of type Module

Modifier and Type	Field and Description
protected static com.google.common.cache.Cache<String,Module>	ModuleFactory.loadedModules
protected static com.google.common.cache.Cache<Module,ModuleClassLoader>	ModuleFactory.moduleClassLoaders
protected static com.google.common.cache.Cache<String,Module>	ModuleFactory.startedModules

Methods in org.openmrs.module that return Module

Modifier and Type	Method and Description
protected static Module[]	ModuleClassLoader.collectAwareOfModuleImports(Module module) Get and cache the imports for this module.
protected static Module[]	ModuleClassLoader.collectRequiredModuleImports(Module module) Get and cache the imports for this module.
Module	ModuleClassLoader.getModule()
Module	AdvicePoint.getModule()
static Module	ModuleFactory.getModuleById(String moduleId)
static Module	ModuleFactory.getModuleByPackage(String modulePackage)
static Module	ModuleUtil.getModuleForPath(String path) Gets the module that should handle a path.
static Module	ModuleFactory.getStartedModuleById(String moduleId)
static Module	ModuleFactory.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	ModuleFactory.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	ModuleFactory.loadModule(Module module, Boolean replaceIfExists) Add a module to the list of openmrs modules
Module	ModuleFileParser.parse() Deprecated. since 2.2.0 use ModuleFileParser.parse(File)
Module	ModuleFileParser.parse(File moduleFile) Get the module from an OpenMRS module file.
Module	ModuleFileParser.parse(InputStream inputStream) Parses the given InputStream of an OpenMRS module into a Module.
static Module	ModuleFactory.startModule(Module module)
static Module	ModuleFactory.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	ModuleFactory.startModuleInternal(Module module) This method should not be called directly.
static Module	ModuleFactory.startModuleInternal(Module module, boolean isOpenmrsStartup, org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext) This method should not be called directly.
static Module	ModuleFactory.updateModule(Module mod) Update the module: 1) Download the new module 2) Unload the old module 3) Load/start the new module

Methods in org.openmrs.module that return types with arguments of type Module

Modifier and Type	Method and Description
static Collection<Module>	ModuleFactory.getLoadedModules() Returns all modules found/loaded into the system (started and not started)
static List<Module>	ModuleFactory.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>	ModuleFactory.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>	ModuleFactory.getLoadedModulesMapPackage() Returns all modules found/loaded into the system (started and not started) in the form of a map<PackageName, Module>
static Map<Module,ModuleClassLoader>	ModuleFactory.getModuleClassLoaderMap() Return all current classloaders keyed on module object
static List<Module>	ModuleFactory.getModulesInStartupOrder(Collection<Module> modules) Sort modules in startup order based on required and aware-of dependencies
static Collection<Module>	ModuleFactory.getStartedModules() Returns the modules that have been successfully started
static List<Module>	ModuleFactory.getStartedModulesInOrder()
static Map<String,Module>	ModuleFactory.getStartedModulesMap() Returns the modules that have been successfully started in the form of a map<ModuleId, Module>
static List<Module>	ModuleFactory.stopModule(Module mod, boolean skipOverStartedProperty, boolean isFailedStartup) Runs through the advice and extension points and removes from api.

Methods in org.openmrs.module with parameters of type Module

Modifier and Type	Method and Description
protected static Module[]	ModuleClassLoader.collectAwareOfModuleImports(Module module) Get and cache the imports for this module.
protected static Module[]	ModuleClassLoader.collectRequiredModuleImports(Module module) Get and cache the imports for this module.
static File	ModuleClassLoader.getLibCacheFolderForModule(Module module) Get the library cache folder for the given module.
static ModuleClassLoader	ModuleFactory.getModuleClassLoader(Module mod) Get a module's classloader
static String	ModuleUtil.getPathForResource(Module module, String path) Takes a global path and returns the local path within the specified module.
static SortedMap<String,String>	SqlDiffFileParser.getSqlDiffs(Module module) Get the diff map.
static boolean	ModuleFactory.isModuleStarted(Module mod) Checks whether the given module is activated
static void	ModuleFactory.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	ModuleFactory.loadModule(Module module, Boolean replaceIfExists) Add a module to the list of openmrs modules
static org.springframework.context.support.AbstractRefreshableApplicationContext	ModuleUtil.refreshApplicationContext(org.springframework.context.support.AbstractRefreshableApplicationContext ctx, boolean isOpenmrsStartup, Module startedModule) Refreshes the given application context "properly" in OpenMRS.
static Module	ModuleFactory.startModule(Module module)
static Module	ModuleFactory.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	ModuleFactory.startModuleInternal(Module module) This method should not be called directly.
static Module	ModuleFactory.startModuleInternal(Module module, boolean isOpenmrsStartup, org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext) This method should not be called directly.
static void	ModuleFactory.stopModule(Module mod) Runs through the advice and extension points and removes from api.
static void	ModuleFactory.stopModule(Module mod, boolean isShuttingDown) Runs through the advice and extension points and removes from api.
static List<Module>	ModuleFactory.stopModule(Module mod, boolean skipOverStartedProperty, boolean isFailedStartup) Runs through the advice and extension points and removes from api.
static void	ModuleFactory.unloadModule(Module mod) Removes module from module repository
static Module	ModuleFactory.updateModule(Module mod) Update the module: 1) Download the new module 2) Unload the old module 3) Load/start the new module

Method parameters in org.openmrs.module with type arguments of type Module

Modifier and Type	Method and Description
static List<Module>	ModuleFactory.getModulesInStartupOrder(Collection<Module> modules) Sort modules in startup order based on required and aware-of dependencies

Constructors in org.openmrs.module with parameters of type Module

Constructor and Description
AdvicePoint(Module mod, String point, String className)
ModuleClassLoader(Module module, ClassLoader parent) Creates class instance configured to load classes and resources for given module.
ModuleClassLoader(Module module, List<URL> urls)
ModuleClassLoader(Module module, List<URL> urls, ClassLoader parent)
ModuleClassLoader(Module module, List<URL> urls, ClassLoader parent, URLStreamHandlerFactory factory)

Uses of Module in org.openmrs.module.web

Methods in org.openmrs.module.web with parameters of type Module

Modifier and Type	Method and Description
static void	WebModuleUtil.loadFilters(Module module, javax.servlet.ServletContext servletContext) This method will initialize and store this module's filters
static void	WebModuleUtil.loadServlets(Module mod, javax.servlet.ServletContext servletContext) This method will find and cache this module's servlets (so that it doesn't have to look them up every time)
static org.springframework.web.context.support.XmlWebApplicationContext	WebModuleUtil.refreshWAC(javax.servlet.ServletContext servletContext, boolean isOpenmrsStartup, Module startedModule) Stops, closes, and refreshes the Spring context for the given servletContext
static boolean	WebModuleUtil.startModule(Module mod, javax.servlet.ServletContext servletContext, boolean delayContextRefresh) Performs the webapp specific startup needs for modules Normal startup is done in ModuleFactory.startModule(Module) If delayContextRefresh is true, the spring context is not rerun.
static void	WebModuleUtil.stopModule(Module mod, javax.servlet.ServletContext servletContext) Reverses all visible activities done by startModule(org.openmrs.module.Module)
static void	WebModuleUtil.stopModule(Module mod, javax.servlet.ServletContext servletContext, boolean skipRefresh) Reverses all visible activities done by startModule(org.openmrs.module.Module)
static void	WebModuleUtil.unloadFilters(Module module) This method will destroy and remove all filters that were registered by the passed Module
static void	WebModuleUtil.unloadServlets(Module mod) Remove the servlets defined for this module

Uses of Module in org.openmrs.module.web.filter

Methods in org.openmrs.module.web.filter that return Module

Modifier and Type	Method and Description
Module	ModuleFilterMapping.getModule()
Module	ModuleFilterDefinition.getModule()

Methods in org.openmrs.module.web.filter with parameters of type Module

Modifier and Type	Method and Description
static List<ModuleFilterDefinition>	ModuleFilterDefinition.retrieveFilterDefinitions(Module module) Static method to parse through a Module's configuration file and return a List of ModuleFilterDefinition objects for which there are configuration elements.
static Deque<ModuleFilterMapping>	ModuleFilterMapping.retrieveFilterMappings(Module module) Static method to parse through a Module's configuration file and return a List of ModuleFilterMapping objects for which there are configuration elements.
void	ModuleFilterMapping.setModule(Module module)
void	ModuleFilterDefinition.setModule(Module module)

Constructors in org.openmrs.module.web.filter with parameters of type Module

Constructor and Description
ModuleFilterDefinition(Module module) Default constructor, requires a Module
ModuleFilterMapping(Module module) Default constructor, requires a Module

Uses of Module in org.openmrs.web

Method parameters in org.openmrs.web with type arguments of type Module

Modifier and Type	Method and Description
static void	Listener.performWebStartOfModules(Collection<Module> startedModules, javax.servlet.ServletContext servletContext)