org.openmrs.web.filter

Class StartupFilter

java.lang.Object

org.openmrs.web.filter.StartupFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

InitializationFilter, StartupErrorFilter, UpdateFilter

public abstract class StartupFilter
extends java.lang.Object
implements javax.servlet.Filter

Abstract class used when a small wizard is needed before Spring, jsp, etc has been started up.

See Also:

UpdateFilter, InitializationFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO_RUN_OPENMRS
protected java.util.Map<java.lang.String,java.lang.Object[]>	errors Records errors that will be displayed to the user
protected javax.servlet.FilterConfig	filterConfig Set by the init(FilterConfig) method so that we have access to the current ServletContext
protected org.apache.commons.logging.Log	log
protected java.util.Map<java.lang.String,java.lang.Object[]>	msgs Messages that will be displayed to the user
protected static org.apache.velocity.app.VelocityEngine	velocityEngine

Constructor Summary

Constructors

Constructor and Description
StartupFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) The web.xml file sets this StartupFilter to be the first filter for all requests.
protected abstract void	doGet(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Called by doFilter(ServletRequest, ServletResponse, FilterChain) on GET requests
protected abstract void	doPost(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Called by doFilter(ServletRequest, ServletResponse, FilterChain) on POST requests
protected abstract java.lang.Object	getModel() The model that is used as the backer for all pages in this startup wizard.
protected java.lang.String	getTemplatePrefix() This string is prepended to all templateNames passed to renderTemplate(String, Map, HttpServletResponse)
org.apache.velocity.tools.ToolContext	getToolContext(java.lang.String locale) Gets tool context for specified locale parameter.
void	init(javax.servlet.FilterConfig filterConfig)
protected void	renderTemplate(java.lang.String templateName, java.util.Map<java.lang.String,java.lang.Object> referenceMap, javax.servlet.http.HttpServletResponse httpResponse) All private attributes on this class are returned to the template via the velocity context and reflection
abstract boolean	skipFilter(javax.servlet.http.HttpServletRequest request) If this returns true, this filter fails early and quickly.
protected java.lang.String	toJSONString(java.lang.Object object, boolean escapeJavascript) Convenience method to convert the given object to a JSON string.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

velocityEngine

protected static org.apache.velocity.app.VelocityEngine velocityEngine

AUTO_RUN_OPENMRS

public static final java.lang.String AUTO_RUN_OPENMRS

See Also:

Constant Field Values

filterConfig

protected javax.servlet.FilterConfig filterConfig

Set by the init(FilterConfig) method so that we have access to the current ServletContext

errors

protected java.util.Map<java.lang.String,java.lang.Object[]> errors

Records errors that will be displayed to the user

msgs

protected java.util.Map<java.lang.String,java.lang.Object[]> msgs

Messages that will be displayed to the user

Constructor Detail

StartupFilter

public StartupFilter()

Method Detail

doFilter

public final void doFilter(javax.servlet.ServletRequest request,
                           javax.servlet.ServletResponse response,
                           javax.servlet.FilterChain chain)
                    throws java.io.IOException,
                           javax.servlet.ServletException

The web.xml file sets this StartupFilter to be the first filter for all requests.

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException

See Also:

Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)

doGet

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

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

Parameters:

httpRequest -

httpResponse -

Throws:

java.io.IOException

javax.servlet.ServletException

doPost

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

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

Parameters:

httpRequest -

httpResponse -

Throws:

java.lang.Exception

java.io.IOException

javax.servlet.ServletException

renderTemplate

protected void renderTemplate(java.lang.String templateName,
                              java.util.Map<java.lang.String,java.lang.Object> referenceMap,
                              javax.servlet.http.HttpServletResponse httpResponse)
                       throws java.io.IOException

All private attributes on this class are returned to the template via the velocity context and reflection

Parameters:

templateName - the name of the velocity file to render. This name is prepended with getTemplatePrefix()

referenceMap -

writer -

Throws:

java.io.IOException

init

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

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

See Also:

Filter.init(javax.servlet.FilterConfig)

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

See Also:

Filter.destroy()

getTemplatePrefix

protected java.lang.String getTemplatePrefix()

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

Returns:

string to prepend as the path for the templates

getModel

protected abstract java.lang.Object getModel()

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

Returns:

the stored formbacking/model object

skipFilter

public abstract boolean skipFilter(javax.servlet.http.HttpServletRequest request)

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

Returns:

true if this filter can be skipped

toJSONString

protected java.lang.String toJSONString(java.lang.Object object,
                                        boolean escapeJavascript)

Convenience method to convert the given object to a JSON string. Supports Maps, Lists, Strings, Boolean, Double

Parameters:

object - object to convert to json

escapeJavascript - specifies if javascript special characters should be escaped

Returns:

JSON string to be eval'd in javascript

getToolContext

public org.apache.velocity.tools.ToolContext getToolContext(java.lang.String locale)

Gets tool context for specified locale parameter. If context does not exists, it creates new context, configured for that locale. Otherwise, it changes locale property of LocalizationTool object, that is being contained in tools context

Parameters:

locale - the string with locale parameter for configuring tools context

Returns:

the tool context object