org.springframework.mobile.device.switcher

Class SiteSwitcherHandlerInterceptor

java.lang.Object

org.springframework.web.servlet.handler.HandlerInterceptorAdapter

org.springframework.mobile.device.switcher.SiteSwitcherHandlerInterceptor

All Implemented Interfaces:

org.springframework.web.servlet.AsyncHandlerInterceptor, org.springframework.web.servlet.HandlerInterceptor

public class SiteSwitcherHandlerInterceptor
extends org.springframework.web.servlet.handler.HandlerInterceptorAdapter

A Spring MVC interceptor that switches the user between the mobile, normal, and tablet sites 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.

Author:

Keith Donald, Scott Rossillo, Roy Clarkson

Constructor Summary

Constructors

Constructor and Description
SiteSwitcherHandlerInterceptor(SiteUrlFactory normalSiteUrlFactory, SiteUrlFactory mobileSiteUrlFactory, SitePreferenceHandler sitePreferenceHandler) Creates a new site switcher.
SiteSwitcherHandlerInterceptor(SiteUrlFactory normalSiteUrlFactory, SiteUrlFactory mobileSiteUrlFactory, SitePreferenceHandler sitePreferenceHandler, java.lang.Boolean tabletIsMobile) Creates a new site switcher.
SiteSwitcherHandlerInterceptor(SiteUrlFactory normalSiteUrlFactory, SiteUrlFactory mobileSiteUrlFactory, SiteUrlFactory tabletSiteUrlFactory, SitePreferenceHandler sitePreferenceHandler) Creates a new site switcher.

Method Summary

Methods

Modifier and Type	Method and Description
static SiteSwitcherHandlerInterceptor	dotMobi(java.lang.String serverName) Creates a site switcher that redirects to a .mobi domain for normal site requests that either originate from a mobile device or indicate a mobile site preference.
static SiteSwitcherHandlerInterceptor	dotMobi(java.lang.String serverName, java.lang.Boolean tabletIsMobile) Creates a site switcher that redirects to a .mobi domain for normal site requests that either originate from a mobile device or indicate a mobile site preference.
static SiteSwitcherHandlerInterceptor	mDot(java.lang.String serverName) Creates a site switcher that redirects to a m. domain for normal site requests that either originate from a mobile device or indicate a mobile site preference.
static SiteSwitcherHandlerInterceptor	mDot(java.lang.String serverName, java.lang.Boolean tabletIsMobile) Creates a site switcher that redirects to a m. domain for normal site requests that either originate from a mobile device or indicate a mobile site preference.
boolean	preHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object handler)
static SiteSwitcherHandlerInterceptor	standard(java.lang.String normalServerName, java.lang.String mobileServerName, java.lang.String cookieDomain) Creates a site switcher that redirects to a custom domain for normal site requests that either originate from a mobile device or indicate a mobile site preference.
static SiteSwitcherHandlerInterceptor	standard(java.lang.String normalServerName, java.lang.String mobileServerName, java.lang.String cookieDomain, java.lang.Boolean tabletIsMobile) Creates a site switcher that redirects to a custom domain for normal site requests that either originate from a mobile device or indicate a mobile site preference.
static SiteSwitcherHandlerInterceptor	standard(java.lang.String normalServerName, java.lang.String mobileServerName, java.lang.String tabletServerName, java.lang.String cookieDomain) Creates a site switcher that redirects to a custom domain for normal site requests that either originate from a mobile device or indicate a mobile site preference.
static SiteSwitcherHandlerInterceptor	urlPath(java.lang.String mobilePath) Creates a site switcher that redirects to a path on the current domain for normal site requests that either originate from a mobile device or indicate a mobile site preference.
static SiteSwitcherHandlerInterceptor	urlPath(java.lang.String mobilePath, java.lang.String rootPath) Creates a site switcher that redirects to a path on the current domain for normal site requests that either originate from a mobile device or indicate a mobile site preference.
static SiteSwitcherHandlerInterceptor	urlPath(java.lang.String mobilePath, java.lang.String tabletPath, java.lang.String rootPath) Creates a site switcher that redirects to a path on the current domain for normal site requests that either originate from a mobile device or tablet device, or indicate a mobile or tablet site preference.

Methods inherited from class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

afterCompletion, afterConcurrentHandlingStarted, postHandle

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteSwitcherHandlerInterceptor

public SiteSwitcherHandlerInterceptor(SiteUrlFactory normalSiteUrlFactory,
                              SiteUrlFactory mobileSiteUrlFactory,
                              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

sitePreferenceHandler - the handler for the user site preference

SiteSwitcherHandlerInterceptor

public SiteSwitcherHandlerInterceptor(SiteUrlFactory normalSiteUrlFactory,
                              SiteUrlFactory mobileSiteUrlFactory,
                              SitePreferenceHandler sitePreferenceHandler,
                              java.lang.Boolean tabletIsMobile)

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

sitePreferenceHandler - the handler for the user site preference

tabletIsMobile - true to send tablets to the 'mobile' site.

SiteSwitcherHandlerInterceptor

public SiteSwitcherHandlerInterceptor(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 URL e.g. http://app.com/tablet

sitePreferenceHandler - the handler for the user site preference

Method Detail

preHandle

public boolean preHandle(javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response,
                java.lang.Object handler)
                  throws java.lang.Exception

Specified by:

preHandle in interface org.springframework.web.servlet.HandlerInterceptor

Overrides:

preHandle in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Throws:

java.lang.Exception

mDot

public static SiteSwitcherHandlerInterceptor mDot(java.lang.String serverName)

Creates a site switcher that redirects to a m. domain for normal site requests that either originate from a mobile device or indicate a mobile site preference. Uses a CookieSitePreferenceRepository that saves a cookie that is shared between the two domains.

mDot

public static SiteSwitcherHandlerInterceptor mDot(java.lang.String serverName,
                                  java.lang.Boolean tabletIsMobile)

Creates a site switcher that redirects to a m. domain for normal site requests that either originate from a mobile device or indicate a mobile site preference. Uses a CookieSitePreferenceRepository that saves a cookie that is shared between the two domains.

dotMobi

public static SiteSwitcherHandlerInterceptor dotMobi(java.lang.String serverName)

Creates a site switcher that redirects to a .mobi domain for normal site requests that either originate from a mobile device or indicate a mobile site preference. Will strip off the trailing domain name when building the mobile domain e.g. "app.com" will become "app.mobi" (the .com will be stripped). Uses a CookieSitePreferenceRepository that saves a cookie that is shared between the two domains.

dotMobi

public static SiteSwitcherHandlerInterceptor dotMobi(java.lang.String serverName,
                                     java.lang.Boolean tabletIsMobile)

Creates a site switcher that redirects to a .mobi domain for normal site requests that either originate from a mobile device or indicate a mobile site preference. Will strip off the trailing domain name when building the mobile domain e.g. "app.com" will become "app.mobi" (the .com will be stripped). Uses a CookieSitePreferenceRepository that saves a cookie that is shared between the two domains.

standard

public static SiteSwitcherHandlerInterceptor standard(java.lang.String normalServerName,
                                      java.lang.String mobileServerName,
                                      java.lang.String cookieDomain)

Creates a site switcher that redirects to a custom domain for normal site requests that either originate from a mobile device or indicate a mobile site preference. Uses a CookieSitePreferenceRepository that saves a cookie that is shared between the two domains.

Parameters:

normalServerName - the 'normal' domain name e.g. "normal.com"

mobileServerName - the 'mobile domain name e.g. "mobile.com"

cookieDomain - the name to use for saving the cookie

See Also:

standard(String, String, String, Boolean), standard(String, String, String, String), StandardSiteUrlFactory

standard

public static SiteSwitcherHandlerInterceptor standard(java.lang.String normalServerName,
                                      java.lang.String mobileServerName,
                                      java.lang.String cookieDomain,
                                      java.lang.Boolean tabletIsMobile)

Creates a site switcher that redirects to a custom domain for normal site requests that either originate from a mobile device or indicate a mobile site preference. Uses a CookieSitePreferenceRepository that saves a cookie that is shared between the two domains.

Parameters:

normalServerName - the 'normal' domain name e.g. "normal.com"

mobileServerName - the 'mobile domain name e.g. "mobile.com"

cookieDomain - the name to use for saving the cookie

tabletIsMobile - true if tablets should be presented with the 'mobile' site

See Also:

standard(String, String, String), standard(String, String, String, String), StandardSiteUrlFactory

standard

public static SiteSwitcherHandlerInterceptor standard(java.lang.String normalServerName,
                                      java.lang.String mobileServerName,
                                      java.lang.String tabletServerName,
                                      java.lang.String cookieDomain)

Creates a site switcher that redirects to a custom domain for normal site requests that either originate from a mobile device or indicate a mobile site preference. Uses a CookieSitePreferenceRepository that saves a cookie that is shared between the two domains.

Parameters:

normalServerName - the 'normal' domain name e.g. "normal.com"

mobileServerName - the 'mobile domain name e.g. "mobile.com"

tabletServerName - the 'tablet' domain name e.g. "tablet.com"

cookieDomain - the name to use for saving the cookie

See Also:

standard(String, String, String), standard(String, String, String, Boolean), StandardSiteUrlFactory

urlPath

public static SiteSwitcherHandlerInterceptor urlPath(java.lang.String mobilePath)

Creates a site switcher that redirects to a path on the current domain for normal site requests that either originate from a mobile device or indicate a mobile site preference. Uses a CookieSitePreferenceRepository that saves a cookie that is stored on the root path.

urlPath

public static SiteSwitcherHandlerInterceptor urlPath(java.lang.String mobilePath,
                                     java.lang.String rootPath)

Creates a site switcher that redirects to a path on the current domain for normal site requests that either originate from a mobile device or indicate a mobile site preference. Allows you to configure a root path for an application. For example, if your app is running at http://www.domain.com/myapp, then the root path is /myapp. Uses a CookieSitePreferenceRepository that saves a cookie that is stored on the root path.

urlPath

public static SiteSwitcherHandlerInterceptor urlPath(java.lang.String mobilePath,
                                     java.lang.String tabletPath,
                                     java.lang.String rootPath)

Creates a site switcher that redirects to a path on the current domain for normal site requests that either originate from a mobile device or tablet device, or indicate a mobile or tablet site preference. Allows you to configure a root path for an application. For example, if your app is running at http://www.domain.com/myapp, then the root path is /myapp. Uses a CookieSitePreferenceRepository that saves a cookie that is stored on the root path.