Package org.springframework.web.util

Class CookieGenerator

java.lang.Object
org.springframework.web.util.CookieGenerator
Direct Known Subclasses:
CookieThemeResolver
@Deprecated(since="6.0", forRemoval=true) public class CookieGenerator extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
as of 6.0 in favor of ResponseCookie for removal in 7.1
Helper class for cookie generation, carrying cookie descriptor settings as bean properties and being able to add and remove cookie to/from a given response.

Can serve as base class for components that generate specific cookies.

Since:
1.1.4
Author:
Juergen Hoeller
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_COOKIE_PATH
    Deprecated, for removal: This API element is subject to removal in a future version.
    Default path that cookies will be visible to: "/", i.e.
    protected final org.apache.commons.logging.Log
    logger
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CookieGenerator()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCookie(HttpServletResponse response, String cookieValue)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Add a cookie with the given value to the response, using the cookie descriptor settings of this generator.
    protected Cookie
    createCookie(String cookieValue)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a cookie with the given value, using the cookie descriptor settings of this generator (except for "cookieMaxAge").
    @Nullable String
    getCookieDomain()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the domain for cookies created by this generator, if any.
    @Nullable Integer
    getCookieMaxAge()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the maximum age for cookies created by this generator.
    @Nullable String
    getCookieName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the given name for cookies created by this generator.
    String
    getCookiePath()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the path for cookies created by this generator.
    boolean
    isCookieHttpOnly()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return whether the cookie is supposed to be marked with the "HttpOnly" attribute.
    boolean
    isCookieSecure()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).
    void
    removeCookie(HttpServletResponse response)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Remove the cookie that this generator describes from the response.
    void
    setCookieDomain(@Nullable String cookieDomain)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use the given domain for cookies created by this generator.
    void
    setCookieHttpOnly(boolean cookieHttpOnly)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set whether the cookie is supposed to be marked with the "HttpOnly" attribute.
    void
    setCookieMaxAge(@Nullable Integer cookieMaxAge)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use the given maximum age (in seconds) for cookies created by this generator.
    void
    setCookieName(@Nullable String cookieName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use the given name for cookies created by this generator.
    void
    setCookiePath(String cookiePath)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use the given path for cookies created by this generator.
    void
    setCookieSecure(boolean cookieSecure)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).

    Methods inherited from class java.lang.Object

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

  • Field Details

    • logger

      protected final org.apache.commons.logging.Log logger
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • CookieGenerator

      public CookieGenerator()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • setCookieName

      public void setCookieName(@Nullable String cookieName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use the given name for cookies created by this generator.
      See Also:

    • getCookieName

      public @Nullable String getCookieName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the given name for cookies created by this generator.

    • setCookieDomain

      public void setCookieDomain(@Nullable String cookieDomain)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use the given domain for cookies created by this generator. The cookie is only visible to servers in this domain.
      See Also:

    • getCookieDomain

      public @Nullable String getCookieDomain()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the domain for cookies created by this generator, if any.

    • setCookiePath

      public void setCookiePath(String cookiePath)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use the given path for cookies created by this generator. The cookie is only visible to URLs in this path and below.
      See Also:

    • getCookiePath

      public String getCookiePath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the path for cookies created by this generator.

    • setCookieMaxAge

      public void setCookieMaxAge(@Nullable Integer cookieMaxAge)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use the given maximum age (in seconds) for cookies created by this generator. Useful special value: -1 ... not persistent, deleted when client shuts down.

      Default is no specific maximum age at all, using the Servlet container's default.

      See Also:

    • getCookieMaxAge

      public @Nullable Integer getCookieMaxAge()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the maximum age for cookies created by this generator.

    • setCookieSecure

      public void setCookieSecure(boolean cookieSecure)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL). This is an indication to the receiving browser, not processed by the HTTP server itself.

      Default is "false".

      See Also:

    • isCookieSecure

      public boolean isCookieSecure()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return whether the cookie should only be sent using a secure protocol, such as HTTPS (SSL).

    • setCookieHttpOnly

      public void setCookieHttpOnly(boolean cookieHttpOnly)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set whether the cookie is supposed to be marked with the "HttpOnly" attribute.

      Default is "false".

      See Also:

    • isCookieHttpOnly

      public boolean isCookieHttpOnly()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return whether the cookie is supposed to be marked with the "HttpOnly" attribute.

    • addCookie

      public void addCookie(HttpServletResponse response, String cookieValue)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Add a cookie with the given value to the response, using the cookie descriptor settings of this generator.

      Delegates to createCookie(java.lang.String) for cookie creation.

      Parameters:
      response - the HTTP response to add the cookie to
      cookieValue - the value of the cookie to add
      See Also:

    • removeCookie

      public void removeCookie(HttpServletResponse response)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Remove the cookie that this generator describes from the response. Will generate a cookie with empty value and max age 0.

      Delegates to createCookie(java.lang.String) for cookie creation.

      Parameters:
      response - the HTTP response to remove the cookie from
      See Also:

    • createCookie

      protected Cookie createCookie(String cookieValue)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a cookie with the given value, using the cookie descriptor settings of this generator (except for "cookieMaxAge").
      Parameters:
      cookieValue - the value of the cookie to crate
      Returns:
      the cookie
      See Also: