org.openmrs.web

Class Listener

java.lang.Object

org.springframework.web.context.ContextLoader

org.openmrs.web.Listener

All Implemented Interfaces:

EventListener, javax.servlet.http.HttpSessionListener, javax.servlet.ServletContextListener

public final class Listener
extends org.springframework.web.context.ContextLoader
implements javax.servlet.ServletContextListener, javax.servlet.http.HttpSessionListener

Our Listener class performs the basic starting functions for our webapp. Basic needs for starting the API: 1) Get the runtime properties 2) Start Spring 3) Start the OpenMRS APi (via Context.startup) Basic startup needs specific to the web layer: 1) Do the web startup of the modules 2) Copy the custom look/images/messages over into the web layer

Field Summary

Fields inherited from class org.springframework.web.context.ContextLoader

CONFIG_LOCATION_PARAM, CONTEXT_CLASS_PARAM, CONTEXT_ID_PARAM, CONTEXT_INITIALIZER_CLASSES_PARAM, GLOBAL_INITIALIZER_CLASSES_PARAM

Constructor Summary

Constructors

Constructor and Description
Listener()

Method Summary

Modifier and Type	Method and Description
void	contextDestroyed(javax.servlet.ServletContextEvent event) Called when the webapp is shut down properly Must call Context.shutdown() and then shutdown all the web layers of the modules
void	contextInitialized(javax.servlet.ServletContextEvent event) This method is called when the servlet context is initialized(when the Web Application is deployed).
static boolean	errorOccurredAtStartup() Boolean flag set by the contextInitialized(ServletContextEvent) method if an error occurred when trying to start up.
static Throwable	getErrorAtStartup() Get the error thrown at startup
static Properties	getRuntimeProperties() Finds and loads the runtime properties
static boolean	isOpenmrsStarted() Boolean flag that tells if OpenMRS is started and ready to handle requests via REST.
static boolean	isSetupNeeded() Boolean flag that tells if we need to run the database setup wizard.
static void	loadBundledModules(javax.servlet.ServletContext servletContext) Load the pre-packaged modules from web/WEB-INF/bundledModules.
static void	performWebStartOfModules(Collection<Module> startedModules, javax.servlet.ServletContext servletContext)
static void	performWebStartOfModules(javax.servlet.ServletContext servletContext) Call WebModuleUtil.startModule on each started module
static boolean	runtimePropertiesFound() Boolean flag set on webapp startup marking whether there is a runtime properties file or not.
void	sessionCreated(javax.servlet.http.HttpSessionEvent se) This gets all Spring components that implement HttpSessionListener and passes the HttpSession event to them whenever an HttpSession is created
void	sessionDestroyed(javax.servlet.http.HttpSessionEvent se) This gets all Spring components that implement HttpSessionListener and passes the HttpSession event to them whenever an HttpSession is destroyed
static void	setErrorAtStartup(Throwable errorAtStartup)
static void	setRuntimePropertiesFound(boolean runtimePropertiesFound)
static void	startOpenmrs(javax.servlet.ServletContext servletContext) Do the work of starting openmrs.

Methods inherited from class org.springframework.web.context.ContextLoader

closeWebApplicationContext, configureAndRefreshWebApplicationContext, createWebApplicationContext, customizeContext, determineContextClass, determineContextInitializerClasses, getCurrentWebApplicationContext, initWebApplicationContext, loadParentContext, setContextInitializers

Methods inherited from class java.lang.Object

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

Constructor Detail

Listener

public Listener()

Method Detail

runtimePropertiesFound

public static boolean runtimePropertiesFound()

Boolean flag set on webapp startup marking whether there is a runtime properties file or not. If there is not, then the InitializationFilter takes over any openmrs url and redirects to the WebConstants.SETUP_PAGE_URL

Returns:

true/false whether an openmrs runtime properties file is defined

errorOccurredAtStartup

public static boolean errorOccurredAtStartup()

Boolean flag set by the contextInitialized(ServletContextEvent) method if an error occurred when trying to start up. The StartupErrorFilter displays the error to the admin

Returns:

true/false if an error occurred when starting up

isSetupNeeded

public static boolean isSetupNeeded()

Boolean flag that tells if we need to run the database setup wizard.

Returns:

true if setup is needed, else false.

isOpenmrsStarted

public static boolean isOpenmrsStarted()

Boolean flag that tells if OpenMRS is started and ready to handle requests via REST.

Returns:

true if started, else false.

getErrorAtStartup

public static Throwable getErrorAtStartup()

Get the error thrown at startup

Returns:

get the error thrown at startup

setRuntimePropertiesFound

public static void setRuntimePropertiesFound(boolean runtimePropertiesFound)

setErrorAtStartup

public static void setErrorAtStartup(Throwable errorAtStartup)

sessionCreated

public void sessionCreated(javax.servlet.http.HttpSessionEvent se)

This gets all Spring components that implement HttpSessionListener and passes the HttpSession event to them whenever an HttpSession is created

Specified by:

sessionCreated in interface javax.servlet.http.HttpSessionListener

See Also:

HttpSessionListener.sessionCreated(HttpSessionEvent)

sessionDestroyed

public void sessionDestroyed(javax.servlet.http.HttpSessionEvent se)

This gets all Spring components that implement HttpSessionListener and passes the HttpSession event to them whenever an HttpSession is destroyed

Specified by:

sessionDestroyed in interface javax.servlet.http.HttpSessionListener

See Also:

HttpSessionListener.sessionDestroyed(HttpSessionEvent)

contextInitialized

public void contextInitialized(javax.servlet.ServletContextEvent event)

This method is called when the servlet context is initialized(when the Web Application is deployed). You can initialize servlet context related data here.

Specified by:

contextInitialized in interface javax.servlet.ServletContextListener

Parameters:

event -

startOpenmrs

public static void startOpenmrs(javax.servlet.ServletContext servletContext)
                         throws javax.servlet.ServletException

Do the work of starting openmrs.

Parameters:

servletContext -

Throws:

javax.servlet.ServletException

loadBundledModules

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

Load the pre-packaged modules from web/WEB-INF/bundledModules.

This method assumes that the api startup() and WebModuleUtil.startup() will be called later for modules that loaded here

Parameters:

servletContext - the current servlet context for the webapp

contextDestroyed

public void contextDestroyed(javax.servlet.ServletContextEvent event)

Called when the webapp is shut down properly Must call Context.shutdown() and then shutdown all the web layers of the modules

Specified by:

contextDestroyed in interface javax.servlet.ServletContextListener

See Also:

ContextLoaderListener.contextDestroyed(javax.servlet.ServletContextEvent)

getRuntimeProperties

public static Properties getRuntimeProperties()

Finds and loads the runtime properties

Returns:

Properties

See Also:

OpenmrsUtil.getRuntimeProperties(String)

performWebStartOfModules

public static void performWebStartOfModules(javax.servlet.ServletContext servletContext)
                                     throws ModuleMustStartException,
                                            Exception

Call WebModuleUtil.startModule on each started module

Parameters:

servletContext -

Throws:

ModuleMustStartException - if the context cannot restart due to a MandatoryModuleException or OpenmrsCoreModuleException

Exception

performWebStartOfModules

public static void performWebStartOfModules(Collection<Module> startedModules,
                                            javax.servlet.ServletContext servletContext)
                                     throws ModuleMustStartException,
                                            Exception

Throws:

ModuleMustStartException

Exception