Class CookieProcessorBase

java.lang.Object
org.apache.tomcat.util.http.CookieProcessorBase
All Implemented Interfaces:
CookieProcessor
Direct Known Subclasses:
LegacyCookieProcessor, Rfc6265CookieProcessor

public abstract class CookieProcessorBase extends Object implements CookieProcessor
  • Field Details

    • ANCIENT_DATE

      protected static final String ANCIENT_DATE
  • Constructor Details

    • CookieProcessorBase

      public CookieProcessorBase()
  • Method Details

    • getSameSiteCookies

      public SameSiteCookies getSameSiteCookies()
    • setSameSiteCookies

      public void setSameSiteCookies(String sameSiteCookies)
    • getPartitioned

      public boolean getPartitioned()
      Should the Partitioned attribute be added by default to cookies created for this web application.

      The name of the attribute used to indicate a partitioned cookie as part of CHIPS is not defined by an RFC and may change in a non-backwards compatible way once equivalent functionality is included in an RFC.

      Returns:
      true if the Partitioned attribute should be added by default to cookies created for this web application, otherwise false
    • setPartitioned

      public void setPartitioned(boolean partitioned)
      Configure whether the Partitioned attribute should be added by default to cookies created for this web application.

      The name of the attribute used to indicate a partitioned cookie as part of CHIPS is not defined by an RFC and may change in a non-backwards compatible way once equivalent functionality is included in an RFC.

      Parameters:
      partitioned - true if the Partitioned attribute should be added by default to cookies created for this web application, otherwise false
    • generateHeader

      @Deprecated public String generateHeader(Cookie cookie, HttpServletRequest request)
      Deprecated.
      This implementation calls the deprecated CookieProcessor.generateHeader(Cookie) method. Implementors should not rely on this method as it is present only for transitional compatibility and will be removed in Tomcat 9.
      Generate the Set-Cookie HTTP header value for the given Cookie. This method receives as parameter the servlet request so that it can make decisions based on request properties. One such use-case is decide if the SameSite attribute should be added to the cookie based on the User-Agent or other request header because there are browser versions incompatible with the SameSite attribute. This is described by the Chromium project.
      Specified by:
      generateHeader in interface CookieProcessor
      Parameters:
      cookie - The cookie for which the header will be generated
      request - The servlet request
      Returns:
      The header value in a form that can be added directly to the response