org.springframework.extensions.surf.mvc

Class ThemeInterceptor

java.lang.Object

org.springframework.extensions.surf.mvc.AbstractWebFrameworkInterceptor

org.springframework.extensions.surf.mvc.ThemeInterceptor

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.request.WebRequestInterceptor, org.springframework.web.context.ServletContextAware

public class ThemeInterceptor
extends AbstractWebFrameworkInterceptor

Web Framework Handler Interceptor to apply Theme to the currently executing context.

Author:

muzquiano, kevinr, David Draper

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SESSION_CURRENT_THEME The constant "alfTheme" used as an HttpSession attribute key.

Constructor Summary

Constructors

Constructor and Description
ThemeInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterCompletion(org.springframework.web.context.request.WebRequest request, Exception ex)
protected String	getDefaultThemeId()
void	postHandle(org.springframework.web.context.request.WebRequest request, org.springframework.ui.ModelMap model)
void	preHandle(org.springframework.web.context.request.WebRequest webRequest) Determines the theme to use for the request.
void	setWebFrameworkConfig(WebFrameworkConfigElement webFrameworkConfig)

Methods inherited from class org.springframework.extensions.surf.mvc.AbstractWebFrameworkInterceptor

getApplicationContext, getObjectService, getRenderService, getServiceRegistry, getWebFrameworkConfiguration, setApplicationContext, setServiceRegistry, setServletContext

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_CURRENT_THEME

protected static final String SESSION_CURRENT_THEME

The constant "alfTheme" used as an HttpSession attribute key. TODO: Consider supporting a different session attribute key as this one is coupled to Alfresco.

See Also:

Constant Field Values

Constructor Detail

ThemeInterceptor

public ThemeInterceptor()

Method Detail

setWebFrameworkConfig

public void setWebFrameworkConfig(WebFrameworkConfigElement webFrameworkConfig)

preHandle

public void preHandle(org.springframework.web.context.request.WebRequest webRequest)
               throws Exception

Determines the theme to use for the request. The order of precedence for determining which theme to use is as follows:

1. Look on the request parameter for a specific requested theme
2. Look for a theme choice previously set as a session attribute
3. Look for the theme defined in the site configuration
4. Look for the theme defined in the web-framework configuration
5. Use "default"

TODO: Currently the code does not support web-framework configuration. TODO: Need to decide whether specifying a theme as a request parameter should update the session attribute?

Parameters:

webRequest - The request being processed.

Throws:

Exception

getDefaultThemeId

protected String getDefaultThemeId()

postHandle

public void postHandle(org.springframework.web.context.request.WebRequest request,
              org.springframework.ui.ModelMap model)
                throws Exception

Throws:

Exception

afterCompletion

public void afterCompletion(org.springframework.web.context.request.WebRequest request,
                   Exception ex)
                     throws Exception

Throws:

Exception