Class CookieEncoder
java.lang.Object
org.jboss.netty.handler.codec.http.CookieEncoder
Encodes
Cookie
s into an HTTP header value. This encoder can encode
the HTTP cookie version 0, 1, and 2.
This encoder is stateful. It maintains an internal data structure that
holds the Cookie
s added by the addCookie(String, String)
method. Once encode()
is called, all added Cookie
s are
encoded into an HTTP header value and all Cookie
s in the internal
data structure are removed so that the encoder can start over.
// Client-side exampleHttpRequest
req = ...;CookieEncoder
encoder = newCookieEncoder
(false); encoder.addCookie("JSESSIONID", "1234"); res.setHeader("Cookie", encoder.encode()); // Server-side exampleHttpResponse
res = ...;CookieEncoder
encoder = newCookieEncoder
(true); encoder.addCookie("JSESSIONID", "1234"); res.setHeader("Set-Cookie", encoder.encode());
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCookieEncoder
(boolean server) Creates a new encoder.CookieEncoder
(boolean server, boolean strict) Creates a new encoder. -
Method Summary
-
Field Details
-
cookies
-
server
private final boolean server -
strict
private final boolean strict
-
-
Constructor Details
-
CookieEncoder
public CookieEncoder(boolean server) Creates a new encoder.- Parameters:
server
-true
if and only if this encoder is supposed to encode server-side cookies.false
if and only if this encoder is supposed to encode client-side cookies.
-
CookieEncoder
public CookieEncoder(boolean server, boolean strict) Creates a new encoder.- Parameters:
server
-true
if and only if this encoder is supposed to encode server-side cookies.false
if and only if this encoder is supposed to encode client-side cookies.strict
-true
if and only if this encoder is supposed to validate characters according to RFC6265.
-
-
Method Details
-
addCookie
Adds a newCookie
created with the specified name and value to this encoder. -
addCookie
Adds the specifiedCookie
to this encoder. -
encode
Encodes theCookie
s which were added byaddCookie(Cookie)
so far into an HTTP header value. If noCookie
s were added, an empty string is returned. Be aware that calling this method will clear the content of theCookieEncoder
-
encodeServerSide
-
encodeClientSide
-