Class ServerCookieEncoder
java.lang.Object
io.netty.handler.codec.http.cookie.CookieEncoder
io.netty.handler.codec.http.cookie.ServerCookieEncoder
A RFC6265 compliant cookie encoder to be used server side,
so some fields are sent (Version is typically ignored).
As Netty's Cookie merges Expires and MaxAge into one single field, only Max-Age field is sent.
Note that multiple cookies must be sent as separate "Set-Cookie" headers.
// ExampleHttpResponse
res = ...; res.setHeader("Set-Cookie",ServerCookieEncoder
.encode("JSESSIONID", "1234"));
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ServerCookieEncoder
Lax instance that doesn't validate name and value, and that allows multiple cookies with the same name.static final ServerCookieEncoder
Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265, and (for methods that accept multiple cookies) that only one cookie is encoded with any given name.Fields inherited from class io.netty.handler.codec.http.cookie.CookieEncoder
strict
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeduplicate a list of encoded cookies by keeping only the last instance with a given name.Encodes the specified cookie into a Set-Cookie header value.Batch encodes cookies into Set-Cookie header values.Batch encodes cookies into Set-Cookie header values.Encodes the specified cookie name-value pair into a Set-Cookie header value.encode
(Collection<? extends Cookie> cookies) Batch encodes cookies into Set-Cookie header values.Methods inherited from class io.netty.handler.codec.http.cookie.CookieEncoder
validateCookie
-
Field Details
-
STRICT
Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265, and (for methods that accept multiple cookies) that only one cookie is encoded with any given name. (If multiple cookies have the same name, the last one is the one that is encoded.) -
LAX
Lax instance that doesn't validate name and value, and that allows multiple cookies with the same name.
-
-
Constructor Details
-
ServerCookieEncoder
private ServerCookieEncoder(boolean strict)
-
-
Method Details
-
encode
Encodes the specified cookie name-value pair into a Set-Cookie header value.- Parameters:
name
- the cookie namevalue
- the cookie value- Returns:
- a single Set-Cookie header value
-
encode
Encodes the specified cookie into a Set-Cookie header value.- Parameters:
cookie
- the cookie- Returns:
- a single Set-Cookie header value
-
dedup
Deduplicate a list of encoded cookies by keeping only the last instance with a given name.- Parameters:
encoded
- The list of encoded cookies.nameToLastIndex
- A map from cookie name to index of last cookie instance.- Returns:
- The encoded list with all but the last instance of a named cookie.
-
encode
Batch encodes cookies into Set-Cookie header values.- Parameters:
cookies
- a bunch of cookies- Returns:
- the corresponding bunch of Set-Cookie headers
-
encode
Batch encodes cookies into Set-Cookie header values.- Parameters:
cookies
- a bunch of cookies- Returns:
- the corresponding bunch of Set-Cookie headers
-
encode
Batch encodes cookies into Set-Cookie header values.- Parameters:
cookies
- a bunch of cookies- Returns:
- the corresponding bunch of Set-Cookie headers
-