Class ClientCookieEncoder
- java.lang.Object
-
- org.jboss.netty.handler.codec.http.cookie.CookieEncoder
-
- org.jboss.netty.handler.codec.http.cookie.ClientCookieEncoder
-
public final class ClientCookieEncoder extends CookieEncoder
A RFC6265 compliant cookie encoder to be used client side, so only name=value pairs are sent. User-Agents are not supposed to interpret cookies, so, if present,Cookie#rawValue()
will be used. Otherwise,Cookie.value()
will be used unquoted. Note that multiple cookies are supposed to be sent at once in a single "Cookie" header.// Example
HttpRequest
req = ...; res.setHeader("Cookie",ClientCookieEncoder
.encode("JSESSIONID", "1234"));- See Also:
ClientCookieDecoder
-
-
Field Summary
Fields Modifier and Type Field Description static ClientCookieEncoder
LAX
Lax instance that doesn't validate name and valuestatic ClientCookieEncoder
STRICT
Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265
-
Constructor Summary
Constructors Modifier Constructor Description private
ClientCookieEncoder(boolean strict)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
encode(java.lang.Iterable<? extends Cookie> cookies)
Encodes the specified cookies into a single Cookie header value.private void
encode(java.lang.StringBuilder buf, Cookie c)
java.lang.String
encode(java.lang.String name, java.lang.String value)
Encodes the specified cookie into a Cookie header value.java.lang.String
encode(Cookie cookie)
Encodes the specified cookie into a Cookie header value.java.lang.String
encode(Cookie... cookies)
Encodes the specified cookies into a single Cookie header value.-
Methods inherited from class org.jboss.netty.handler.codec.http.cookie.CookieEncoder
validateCookie
-
-
-
-
Field Detail
-
STRICT
public static final ClientCookieEncoder STRICT
Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265
-
LAX
public static final ClientCookieEncoder LAX
Lax instance that doesn't validate name and value
-
-
Method Detail
-
encode
public java.lang.String encode(java.lang.String name, java.lang.String value)
Encodes the specified cookie into a Cookie header value.- Parameters:
name
- the cookie namevalue
- the cookie value- Returns:
- a Rfc6265 style Cookie header value
-
encode
public java.lang.String encode(Cookie cookie)
Encodes the specified cookie into a Cookie header value.- Parameters:
specified
- the cookie- Returns:
- a Rfc6265 style Cookie header value
-
encode
public java.lang.String encode(Cookie... cookies)
Encodes the specified cookies into a single Cookie header value.- Parameters:
cookies
- some cookies- Returns:
- a Rfc6265 style Cookie header value, null if no cookies are passed.
-
encode
public java.lang.String encode(java.lang.Iterable<? extends Cookie> cookies)
Encodes the specified cookies into a single Cookie header value.- Parameters:
cookies
- some cookies- Returns:
- a Rfc6265 style Cookie header value, null if no cookies are passed.
-
encode
private void encode(java.lang.StringBuilder buf, Cookie c)
-
-