org.openmrs.web.filter

Class OpenmrsFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.openmrs.web.filter.OpenmrsFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public class OpenmrsFilter
extends org.springframework.web.filter.OncePerRequestFilter

This is the custom OpenMRS filter. It is defined as the filter of choice in the web.xml file. All page/object calls run through the doFilter method so we can wrap every session with the user's userContext (which holds the user's authenticated info). This is needed because the OpenMRS API keeps authentication information on the current Thread. Web applications use a different thread per request, so before each request this filter will make sure that the UserContext (the authentication information) is on the Thread.

Field Summary

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor and Description
OpenmrsFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, javax.servlet.FilterChain chain) This method is called for every request for a page/image/javascript file/etc The main point of this is to make sure the user's current userContext is on the session and on the current thread

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenmrsFilter

public OpenmrsFilter()

Method Detail

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Overrides:

destroy in class org.springframework.web.filter.GenericFilterBean

See Also:

Filter.destroy()

doFilterInternal

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

This method is called for every request for a page/image/javascript file/etc The main point of this is to make sure the user's current userContext is on the session and on the current thread

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

javax.servlet.ServletException

IOException

See Also:

OncePerRequestFilter.doFilterInternal(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.FilterChain)