org.springframework.mobile.device.site

Class SitePreferenceRequestFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.mobile.device.site.SitePreferenceRequestFilter

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.web.context.ServletContextAware

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

A Servlet 2.3 Filter that delegates to a SitePreferenceHandler to resolve the SitePreference of the user that originated the web request. The resolved SitePreference is exported as a request attribute under the well-known name of SitePreferenceHandler.CURRENT_SITE_PREFERENCE_ATTRIBUTE. Request handlers such as @Controllers and views may then access the currentSitePreference to vary their control and rendering logic, respectively. Note: do not use this filter in conjunction with the SiteSwitcherRequestFilter, as the switcher internally delegates to a SitePreferenceHandler as part of its own workflow. This filter should only be used when site switching is not needed but site preference management is still desired.

Author:

Roy Clarkson

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
SitePreferenceRequestFilter()
SitePreferenceRequestFilter(SitePreferenceHandler sitePreferenceHandler)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)

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

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

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

addRequiredProperty, afterPropertiesSet, destroy, 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

SitePreferenceRequestFilter

public SitePreferenceRequestFilter()

SitePreferenceRequestFilter

public SitePreferenceRequestFilter(SitePreferenceHandler sitePreferenceHandler)

Method Detail

doFilterInternal

protected void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    javax.servlet.FilterChain filterChain)
                         throws javax.servlet.ServletException,
                                java.io.IOException

Specified by:

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

Throws:

javax.servlet.ServletException

java.io.IOException