Class ThemeChangeInterceptor

java.lang.Object
org.springframework.web.servlet.theme.ThemeChangeInterceptor
All Implemented Interfaces:
HandlerInterceptor

public class ThemeChangeInterceptor extends Object implements HandlerInterceptor
Interceptor that allows for changing the current theme on every request, via a configurable request parameter (default parameter name: "theme").
Since:
20.06.2003
Author:
Juergen Hoeller
See Also:
  • Field Details

    • DEFAULT_PARAM_NAME

      public static final String DEFAULT_PARAM_NAME
      Default name of the theme specification parameter: "theme".
      See Also:
  • Constructor Details

    • ThemeChangeInterceptor

      public ThemeChangeInterceptor()
  • Method Details

    • setParamName

      public void setParamName(String paramName)
      Set the name of the parameter that contains a theme specification in a theme change request. Default is "theme".
    • getParamName

      public String getParamName()
      Return the name of the parameter that contains a theme specification in a theme change request.
    • preHandle

      public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException
      Description copied from interface: HandlerInterceptor
      Interception point before the execution of a handler. Called after HandlerMapping determined an appropriate handler object, but before HandlerAdapter invokes the handler.

      DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can decide to abort the execution chain, typically sending an HTTP error or writing a custom response.

      Note: special considerations apply for asynchronous request processing. For more details see AsyncHandlerInterceptor.

      The default implementation returns true.

      Specified by:
      preHandle in interface HandlerInterceptor
      Parameters:
      request - current HTTP request
      response - current HTTP response
      handler - chosen handler to execute, for type and/or instance evaluation
      Returns:
      true if the execution chain should proceed with the next interceptor or the handler itself. Else, DispatcherServlet assumes that this interceptor has already dealt with the response itself.
      Throws:
      ServletException