org.springframework.mobile.device.switcher

Class SiteSwitcherRequestFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.mobile.device.switcher.SiteSwitcherRequestFilter

All Implemented Interfaces:

Filter, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, ServletContextAware

public class SiteSwitcherRequestFilter
extends OncePerRequestFilter

A Servlet 2.3 Filter that switches the user between the mobile and normal site by employing a specific switching algorithm. The switching algorithm is as follows:

• If the request originates from the mobile site:
  • If the user prefers the normal site, then redirect the user to the normal site.
  • If the user prefers the tablet site, then redirect the user to the tablet site.
• If the request originates from the tablet site:
  • If the user prefers the normal site, then redirect the user to the normal site.
  • If the user prefers the mobile site, then redirect the user to the mobile site.
• Otherwise, the request originates from the normal site, so:
• If the user prefers the mobile site, or the user has no site preference and is on a mobile device, redirect the user to the mobile site.
• If the user prefers the tablet site, or the user has no site preference and is on a tablet device, redirect the user to the tablet site.

The initialization parameters available for configuring the servlet filter:

• switcherMode
• serverName
• tabletIsMobile
• mobilePath
• tabletPath
• rootPath

The switcherMode init parameter requires that you specify one of three values. And for each of these values, the corresponding additional required init params are listed.

• mDot
• serverName is required
• tabletIsMobile is optional
• dotMobi
• serverName is required
• tabletIsMobile is optional
• urlPath
• mobilePath is optional
• tabletPath is optional
• rootPath is optional

The following examples illustrate the different parameter configurations.

Creates a site switcher that switches between app.com and m.app.com:

 <init-param>
     <param-name>switcherMode</param-name>
     <param-value>mDot</param-value>
     <param-name>serverName</param-name>
     <param-value>app.com</param-value>
 </init-param>
 

Creates a site switcher that switches between app.com and app.mobi:

 <init-param>
     <param-name>switcherMode</param-name>
     <param-value>dotMobi</param-value>
     <param-name>serverName</param-name>
     <param-value>app.com</param-value>
 </init-param>
 

By default tablets are presented with the 'normal' site when using mDot or dotMobi. However you can have the site switcher direct tablets to the mobile site by setting the tabletIsMobile parameter to true.

 <init-param>
     <param-name>switcherMode</param-name>
     <param-value>mDot</param-value>
     <param-name>serverName</param-name>
     <param-value>app.com</param-value>
     <param-name>tabletIsMobile</param-name>
     <param-value>true</param-value>
 </init-param>
 

Creates a site switcher that switches between app.com and app.com/mob/ for mobile devices, and app.com and app.com/tab/ for tablet devices:

 <init-param>
     <param-name>switcherMode</param-name>
     <param-value>urlPath</param-value>
     <param-name>mobilePath</param-name>
     <param-value>mob</param-value>
     <param-name>tabletPath</param-name>
     <param-value>tab</param-value>
 </init-param>
 

Author:

Guilherme Willian de Oliveira, 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
SiteSwitcherRequestFilter()
SiteSwitcherRequestFilter(SiteUrlFactory normalSiteUrlFactory, SiteUrlFactory mobileSiteUrlFactory, SiteUrlFactory tabletSiteUrlFactory, SitePreferenceHandler sitePreferenceHandler) Creates a new site switcher.

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
String	getMobilePath()
String	getRootPath()
String	getServerName()
String	getSwitcherMode()
Boolean	getTabletIsMobile()
String	getTabletPath()
protected void	initFilterBean()
void	setMobilePath(String mobilePath)
void	setRootPath(String rootPath)
void	setServerName(String serverName)
void	setSwitcherMode(String switcherMode)
void	setTabletIsMobile(Boolean tabletIsMobile)
void	setTabletPath(String tabletPath)

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, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteSwitcherRequestFilter

public SiteSwitcherRequestFilter()

SiteSwitcherRequestFilter

public SiteSwitcherRequestFilter(SiteUrlFactory normalSiteUrlFactory,
                                 SiteUrlFactory mobileSiteUrlFactory,
                                 SiteUrlFactory tabletSiteUrlFactory,
                                 SitePreferenceHandler sitePreferenceHandler)

Creates a new site switcher.

Parameters:

normalSiteUrlFactory - the factory for a "normal" site URL e.g. http://app.com

mobileSiteUrlFactory - the factory for a "mobile" site URL e.g. http://m.app.com

tabletSiteUrlFactory - the factory for a "tablet" site

sitePreferenceHandler - the handler for the user site preference

Method Detail

getSwitcherMode

public String getSwitcherMode()

setSwitcherMode

public void setSwitcherMode(String switcherMode)

getServerName

public String getServerName()

setServerName

public void setServerName(String serverName)

getTabletIsMobile

public Boolean getTabletIsMobile()

setTabletIsMobile

public void setTabletIsMobile(Boolean tabletIsMobile)

getMobilePath

public String getMobilePath()

setMobilePath

public void setMobilePath(String mobilePath)

getTabletPath

public String getTabletPath()

setTabletPath

public void setTabletPath(String tabletPath)

getRootPath

public String getRootPath()

setRootPath

public void setRootPath(String rootPath)

initFilterBean

protected void initFilterBean()
                       throws ServletException

Overrides:

initFilterBean in class GenericFilterBean

Throws:

ServletException

doFilterInternal

protected void doFilterInternal(HttpServletRequest request,
                                HttpServletResponse response,
                                FilterChain filterChain)
                         throws ServletException,
                                IOException

Specified by:

doFilterInternal in class OncePerRequestFilter

Throws:

ServletException

IOException