org.openmrs.module.web

Class WebModuleUtil

java.lang.Object

org.openmrs.module.web.WebModuleUtil

public class WebModuleUtil
extends Object

Method Summary

Modifier and Type	Method and Description
static void	createDwrModulesXml(String realPath)
static Collection<ModuleFilterMapping>	getFilterMappings() This method will return all Filter Mappings that have been registered by a module
static Collection<javax.servlet.Filter>	getFilters() This method will return all Filters that have been registered a module
static List<javax.servlet.Filter>	getFiltersForRequest(javax.servlet.ServletRequest request) Return List of Filters that have been loaded through Modules that have mappings that pass for the passed request
static String	getModuleWebFolder(String moduleId) Retrieves a path to a folder that stores web files of a module.
static String	getRealPath(javax.servlet.ServletContext servletContext)
static javax.servlet.http.HttpServlet	getServlet(String servletName) Finds the servlet defined by the servlet name
static boolean	isModulePackageNameInTaskClass(String modulePackageName, String taskClass) Checks if module package name is in task class name
static void	loadFilters(Module module, javax.servlet.ServletContext servletContext) This method will initialize and store this module's filters
static void	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	refreshWAC(javax.servlet.ServletContext servletContext, boolean isOpenmrsStartup, Module startedModule) Stops, closes, and refreshes the Spring context for the given servletContext
static void	setDispatcherServlet(DispatcherServlet ds) Save the dispatcher servlet for use later (reinitializing things)
static void	setStaticDispatcherServlet(StaticDispatcherServlet ds) Save the static content dispatcher servlet for use later when refreshing spring
static void	shutdownModules(javax.servlet.ServletContext servletContext) Reverses all activities done by startModule(org.openmrs.module.Module) Normal stop/shutdown is done by ModuleFactory
static boolean	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	stopModule(Module mod, javax.servlet.ServletContext servletContext) Reverses all visible activities done by startModule(org.openmrs.module.Module)
static void	stopModule(Module mod, javax.servlet.ServletContext servletContext, boolean skipRefresh) Reverses all visible activities done by startModule(org.openmrs.module.Module)
static void	unloadFilters(Module module) This method will destroy and remove all filters that were registered by the passed Module
static void	unloadServlets(Module mod) Remove the servlets defined for this module

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

startModule

public static boolean 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. This will save a lot of time, but it also means that the calling method is responsible for restarting the context if necessary (the calling method will also have to call loadServlets(Module, ServletContext) and loadFilters(Module, ServletContext)).

If delayContextRefresh is true and this module should have caused a context refresh, a true value is returned. Otherwise, false is returned

Parameters:

mod - Module to start

servletContext - the current ServletContext

delayContextRefresh - true/false whether or not to do the context refresh

Returns:

boolean whether or not the spring context need to be refreshed

isModulePackageNameInTaskClass

public static boolean isModulePackageNameInTaskClass(String modulePackageName,
                                                     String taskClass)

Checks if module package name is in task class name

Parameters:

modulePackageName - the package name of module

taskClass - the class of given task

Returns:

true if task and module are in the same package Should return false for different package names Should return false if module has longer package name Should properly match subpackages Should return false for empty package names

loadServlets

public static void 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)

Parameters:

mod -

servletContext - the servlet context

unloadServlets

public static void unloadServlets(Module mod)

Remove the servlets defined for this module

Parameters:

mod - the module that is being stopped that needs its servlets removed

loadFilters

public static void loadFilters(Module module,
                               javax.servlet.ServletContext servletContext)

This method will initialize and store this module's filters

Parameters:

module - - The Module to load and register Filters

servletContext - - The servletContext within which this method is called

unloadFilters

public static void unloadFilters(Module module)

This method will destroy and remove all filters that were registered by the passed Module

Parameters:

module - - The Module for which you want to remove and destroy filters.

getFilters

public static Collection<javax.servlet.Filter> getFilters()

This method will return all Filters that have been registered a module

Returns:

A Collection of Filters that have been registered by a module

getFilterMappings

public static Collection<ModuleFilterMapping> getFilterMappings()

This method will return all Filter Mappings that have been registered by a module

Returns:

A Collection of all ModuleFilterMappings that have been registered by a Module

getFiltersForRequest

public static List<javax.servlet.Filter> getFiltersForRequest(javax.servlet.ServletRequest request)

Return List of Filters that have been loaded through Modules that have mappings that pass for the passed request

Parameters:

request - - The request to check for matching Filters

Returns:

List of all Filters that have filter mappings that match the passed request

shutdownModules

public static void shutdownModules(javax.servlet.ServletContext servletContext)

Reverses all activities done by startModule(org.openmrs.module.Module) Normal stop/shutdown is done by ModuleFactory

stopModule

public static void stopModule(Module mod,
                              javax.servlet.ServletContext servletContext)

Reverses all visible activities done by startModule(org.openmrs.module.Module)

Parameters:

mod -

servletContext -

stopModule

public static void stopModule(Module mod,
                              javax.servlet.ServletContext servletContext,
                              boolean skipRefresh)

Reverses all visible activities done by startModule(org.openmrs.module.Module)

Parameters:

mod -

servletContext -

skipRefresh -

refreshWAC

public static org.springframework.web.context.support.XmlWebApplicationContext refreshWAC(javax.servlet.ServletContext servletContext,
                                                                                          boolean isOpenmrsStartup,
                                                                                          Module startedModule)

Stops, closes, and refreshes the Spring context for the given servletContext

Parameters:

servletContext -

isOpenmrsStartup - if this refresh is being done at application startup

startedModule - the module that was just started and waiting on the context refresh

Returns:

The newly refreshed webApplicationContext

setDispatcherServlet

public static void setDispatcherServlet(DispatcherServlet ds)

Save the dispatcher servlet for use later (reinitializing things)

Parameters:

ds -

setStaticDispatcherServlet

public static void setStaticDispatcherServlet(StaticDispatcherServlet ds)

Save the static content dispatcher servlet for use later when refreshing spring

Parameters:

ds -

getServlet

public static javax.servlet.http.HttpServlet getServlet(String servletName)

Finds the servlet defined by the servlet name

Parameters:

servletName - the name of the servlet out of the path

Returns:

the current servlet or null if none defined

getModuleWebFolder

public static String getModuleWebFolder(String moduleId)

Retrieves a path to a folder that stores web files of a module.
(path-to-openmrs/WEB-INF/view/module/moduleid)

Parameters:

moduleId - module id (e.g., "basicmodule")

Returns:

a path to a folder that stores web files or null if not in a web environment Should return the correct module folder Should return null if the dispatcher servlet is not yet set Should return the correct module folder if real path has a trailing slash

createDwrModulesXml

public static void createDwrModulesXml(String realPath)

getRealPath

public static String getRealPath(javax.servlet.ServletContext servletContext)