org.openmrs.web.filter.initialization

Class InitializationFilter

java.lang.Object

org.openmrs.web.filter.StartupFilter

org.openmrs.web.filter.initialization.InitializationFilter

All Implemented Interfaces:

javax.servlet.Filter

public class InitializationFilter
extends StartupFilter

This is the first filter that is processed. It is only active when starting OpenMRS for the very first time. It will redirect all requests to the WebConstants.SETUP_PAGE_URL if the Listener wasn't able to find any runtime properties

Field Summary

Fields

Modifier and Type	Field and Description
static String	RELEASE_TESTING_MODULE_PATH

Fields inherited from class org.openmrs.web.filter.StartupFilter

AUTO_RUN_OPENMRS, errors, filterConfig, msgs, velocityEngine

Constructor Summary

Constructors

Constructor and Description
InitializationFilter()

Method Summary

Modifier and Type	Method and Description
void	checkLocaleAttributesForFirstTime(javax.servlet.http.HttpServletRequest httpRequest) It sets locale parameter for current session when user is making first GET http request to application.
protected void	doGet(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Called by StartupFilter.doFilter(ServletRequest, ServletResponse, FilterChain) on GET requests
protected void	doPost(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Called by StartupFilter.doFilter(ServletRequest, ServletResponse, FilterChain) on POST requests
protected String	getTemplatePrefix() This string is prepended to all templateNames passed to StartupFilter.renderTemplate(String, Map, HttpServletResponse)
protected Object	getUpdateFilterModel() The model that is used as the backer for all pages in this startup wizard.
void	init(javax.servlet.FilterConfig filterConfig)
static boolean	initializationRequired() Public method that returns true if database+runtime properties initialization is required
protected static boolean	isInstallationStarted()
static String	loadDriver(String connection, String databaseDriver) Convenience method that loads the database driver
protected void	setInitializationComplete(boolean initializationComplete)
protected static void	setInstallationStarted(boolean isInstallationStarted)
boolean	skipFilter(javax.servlet.http.HttpServletRequest httpRequest) If this returns true, this filter fails early and quickly.

Methods inherited from class org.openmrs.web.filter.StartupFilter

addLogLinesToResponse, destroy, doFilter, getToolContext, renderTemplate, toJSONString

Methods inherited from class java.lang.Object

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

Field Detail

RELEASE_TESTING_MODULE_PATH

public static final String RELEASE_TESTING_MODULE_PATH

See Also:

Constant Field Values

Constructor Detail

InitializationFilter

public InitializationFilter()

Method Detail

setInitializationComplete

protected void setInitializationComplete(boolean initializationComplete)

doGet

protected void doGet(javax.servlet.http.HttpServletRequest httpRequest,
                     javax.servlet.http.HttpServletResponse httpResponse)
              throws IOException,
                     javax.servlet.ServletException

Called by StartupFilter.doFilter(ServletRequest, ServletResponse, FilterChain) on GET requests

Specified by:

doGet in class StartupFilter

Parameters:

httpRequest -

httpResponse -

Throws:

IOException

javax.servlet.ServletException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest httpRequest,
                      javax.servlet.http.HttpServletResponse httpResponse)
               throws IOException,
                      javax.servlet.ServletException

Called by StartupFilter.doFilter(ServletRequest, ServletResponse, FilterChain) on POST requests

Specified by:

doPost in class StartupFilter

Parameters:

httpRequest -

httpResponse -

Throws:

IOException

javax.servlet.ServletException

checkLocaleAttributesForFirstTime

public void checkLocaleAttributesForFirstTime(javax.servlet.http.HttpServletRequest httpRequest)

It sets locale parameter for current session when user is making first GET http request to application. It retrieves user locale from request object and checks if this locale is supported by application. If not, it uses Locale.ENGLISH by default

Parameters:

httpRequest - the http request object

getTemplatePrefix

protected String getTemplatePrefix()

Description copied from class: StartupFilter

This string is prepended to all templateNames passed to StartupFilter.renderTemplate(String, Map, HttpServletResponse)

Overrides:

getTemplatePrefix in class StartupFilter

Returns:

string to prepend as the path for the templates

See Also:

StartupFilter.getTemplatePrefix()

getUpdateFilterModel

protected Object getUpdateFilterModel()

Description copied from class: StartupFilter

The model that is used as the backer for all pages in this startup wizard. Should never return null.

Specified by:

getUpdateFilterModel in class StartupFilter

Returns:

the stored formbacking/model object

See Also:

StartupFilter.getUpdateFilterModel()

skipFilter

public boolean skipFilter(javax.servlet.http.HttpServletRequest httpRequest)

Description copied from class: StartupFilter

If this returns true, this filter fails early and quickly. All logic is skipped and startup and usage continue normally.

Specified by:

skipFilter in class StartupFilter

Returns:

true if this filter can be skipped

See Also:

StartupFilter.skipFilter(HttpServletRequest)

initializationRequired

public static boolean initializationRequired()

Public method that returns true if database+runtime properties initialization is required

Returns:

true if this initialization wizard needs to run

setInstallationStarted

protected static void setInstallationStarted(boolean isInstallationStarted)

Parameters:

isInstallationStarted - the value to set

isInstallationStarted

protected static boolean isInstallationStarted()

Returns:

true if installation has been started

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Overrides:

init in class StartupFilter

Throws:

javax.servlet.ServletException

See Also:

Filter.init(javax.servlet.FilterConfig)

loadDriver

public static String loadDriver(String connection,
                                String databaseDriver)

Convenience method that loads the database driver

Parameters:

connection - the database connection string

databaseDriver - the database driver class name to load

Returns:

the loaded driver string