CookieThemeResolver (Spring Framework 5.1.0.RELEASE API)

java.lang.Object
- org.springframework.web.util.CookieGenerator
- - org.springframework.web.servlet.theme.CookieThemeResolver

All Implemented Interfaces:

ThemeResolver
```
public class CookieThemeResolver
extends CookieGenerator
implements ThemeResolver
```
ThemeResolver implementation that uses a cookie sent back to the user in case of a custom setting, with a fallback to the default theme. This is particularly useful for stateless applications without user sessions.
Custom controllers can thus override the user's theme by calling setThemeName, e.g. responding to a certain theme change request.

Since:

17.06.2003

Author:

Jean-Pierre Pawlak, Juergen Hoeller

See Also:

setThemeName(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_COOKIE_NAME` The default name of the cookie that holds the theme name.
`static java.lang.String`	`ORIGINAL_DEFAULT_THEME_NAME` The default theme name used if no alternative is provided.
`static java.lang.String`	`THEME_REQUEST_ATTRIBUTE_NAME` Name of the request attribute that holds the theme name.

Fields inherited from class org.springframework.web.util.CookieGenerator
DEFAULT_COOKIE_PATH, logger

Constructor Summary

Constructors
Constructor and Description

CookieThemeResolver()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDefaultThemeName()` Return the name of the default theme.
`java.lang.String`	`resolveThemeName(HttpServletRequest request)` Resolve the current theme name via the given request.
`void`	`setDefaultThemeName(java.lang.String defaultThemeName)` Set the name of the default theme.
`void`	`setThemeName(HttpServletRequest request, HttpServletResponse response, java.lang.String themeName)` Set the current theme name to the given one.

Methods inherited from class org.springframework.web.util.CookieGenerator
addCookie, createCookie, getCookieDomain, getCookieMaxAge, getCookieName, getCookiePath, isCookieHttpOnly, isCookieSecure, removeCookie, setCookieDomain, setCookieHttpOnly, setCookieMaxAge, setCookieName, setCookiePath, setCookieSecure

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ORIGINAL_DEFAULT_THEME_NAME
```
public static final java.lang.String ORIGINAL_DEFAULT_THEME_NAME
```
    The default theme name used if no alternative is provided.
    
    See Also:
    
    Constant Field Values
  - THEME_REQUEST_ATTRIBUTE_NAME
```
public static final java.lang.String THEME_REQUEST_ATTRIBUTE_NAME
```
    Name of the request attribute that holds the theme name. Only used for overriding a cookie value if the theme has been changed in the course of the current request! Use RequestContext.getTheme() to retrieve the current theme in controllers or views.
    
    See Also:
    
    RequestContext.getTheme()
  - DEFAULT_COOKIE_NAME
```
public static final java.lang.String DEFAULT_COOKIE_NAME
```
    The default name of the cookie that holds the theme name.
- Constructor Detail
  - CookieThemeResolver
```
public CookieThemeResolver()
```
- Method Detail
  - setDefaultThemeName
```
public void setDefaultThemeName(java.lang.String defaultThemeName)
```
    Set the name of the default theme.
  - getDefaultThemeName
```
public java.lang.String getDefaultThemeName()
```
    Return the name of the default theme.
  - resolveThemeName
```
public java.lang.String resolveThemeName(HttpServletRequest request)
```
    Description copied from interface: ThemeResolver
    
    Resolve the current theme name via the given request. Should return a default theme as fallback in any case.
    
    Specified by:
    
    resolveThemeName in interface ThemeResolver
    
    Parameters:
    
    request - request to be used for resolution
    
    Returns:
    
    the current theme name
  - setThemeName
```
public void setThemeName(HttpServletRequest request,
                         @Nullable
                         HttpServletResponse response,
                         @Nullable
                         java.lang.String themeName)
```
    Description copied from interface: ThemeResolver
    
    Set the current theme name to the given one.
    
    Specified by:
    
    setThemeName in interface ThemeResolver
    
    Parameters:
    
    request - request to be used for theme name modification
    
    response - response to be used for theme name modification
    
    themeName - the new theme name (null or empty to reset it)

Class CookieThemeResolver

Field Summary

Fields inherited from class org.springframework.web.util.CookieGenerator

Constructor Summary

Method Summary

Methods inherited from class org.springframework.web.util.CookieGenerator

Methods inherited from class java.lang.Object

Field Detail

ORIGINAL_DEFAULT_THEME_NAME

THEME_REQUEST_ATTRIBUTE_NAME

DEFAULT_COOKIE_NAME

Constructor Detail

CookieThemeResolver

Method Detail

setDefaultThemeName

getDefaultThemeName

resolveThemeName

setThemeName