public interface CookieProcessor
Modifier and Type | Method and Description |
---|---|
String |
generateHeader(Cookie cookie)
Deprecated.
This method has been replaced with
generateHeader(Cookie, HttpServletRequest) and will
be removed from Tomcat 10 onwards. |
String |
generateHeader(Cookie cookie,
HttpServletRequest request)
Generate the
Set-Cookie HTTP header value for the given Cookie. |
Charset |
getCharset()
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.
|
void parseCookieHeader(MimeHeaders headers, ServerCookies serverCookies)
headers
- The HTTP headers to parseserverCookies
- The server cookies object to populate with the
results of the parsing@Deprecated String generateHeader(Cookie cookie)
generateHeader(Cookie, HttpServletRequest)
and will
be removed from Tomcat 10 onwards.Set-Cookie
HTTP header value for the given Cookie.cookie
- The cookie for which the header will be generatedString generateHeader(Cookie cookie, HttpServletRequest request)
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.request
- The servlet requestcookie
- The cookie for which the header will be generatedCharset getCharset()
Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.