Package org.apache.tomcat.util.http
Class Rfc6265CookieProcessor
java.lang.Object
org.apache.tomcat.util.http.CookieProcessorBase
org.apache.tomcat.util.http.Rfc6265CookieProcessor
- All Implemented Interfaces:
CookieProcessor
-
Field Summary
Fields inherited from class org.apache.tomcat.util.http.CookieProcessorBase
ANCIENT_DATE, COOKIE_DATE_FORMAT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongenerateHeader
(Cookie cookie) Generate theSet-Cookie
HTTP header value for the given Cookie.generateHeader
(Cookie cookie, HttpServletRequest request) Generate theSet-Cookie
HTTP header value for the given Cookie.Obtain the character set that will be used when converting between bytes and characters when parsing and/or generating HTTP headers for cookies.void
parseCookieHeader
(MimeHeaders headers, ServerCookies serverCookies) Parse the provided headers into server cookie objects.Methods inherited from class org.apache.tomcat.util.http.CookieProcessorBase
getCookiesWithoutEquals, getCookiesWithoutEqualsInternal, getPartitioned, getSameSiteCookies, setCookiesWithoutEquals, setPartitioned, setSameSiteCookies
-
Constructor Details
-
Rfc6265CookieProcessor
public Rfc6265CookieProcessor()
-
-
Method Details
-
getCharset
Description copied from interface:CookieProcessor
Obtain the character set that will be used when converting between bytes and characters when parsing and/or generating HTTP headers for cookies.- Returns:
- The character set used for byte<->character conversions
-
parseCookieHeader
Description copied from interface:CookieProcessor
Parse the provided headers into server cookie objects.- Parameters:
headers
- The HTTP headers to parseserverCookies
- The server cookies object to populate with the results of the parsing
-
generateHeader
Description copied from interface:CookieProcessor
Generate theSet-Cookie
HTTP header value for the given Cookie.- Parameters:
cookie
- The cookie for which the header will be generated- Returns:
- The header value in a form that can be added directly to the response
-
generateHeader
Description copied from interface:CookieProcessor
Generate theSet-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.The default implementation calls the deprecated
CookieProcessor.generateHeader(Cookie)
method. Implementors should not rely on this default method as it is present only for transitional compatibility and will be removed in Tomcat 10 at the same time as theCookieProcessor.generateHeader(Cookie)
method.- Parameters:
cookie
- The cookie for which the header will be generatedrequest
- The servlet request- Returns:
- The header value in a form that can be added directly to the response
-