io.netty.handler.codec.http

Class ClientCookieEncoder

java.lang.Object

io.netty.handler.codec.http.ClientCookieEncoder

public final class ClientCookieEncoder
extends Object

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

Method Summary

Methods

Modifier and Type	Method and Description
static String	encode(Cookie... cookies) Encodes the specified cookies into a single Cookie header value.
static String	encode(Cookie cookie) Encodes the specified cookie into a Cookie header value.
static String	encode(Iterable<Cookie> cookies) Encodes the specified cookies into a single Cookie header value.
static String	encode(String name, String value) Encodes the specified cookie into a Cookie header value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

encode

public static String encode(String name,
            String value)

Encodes the specified cookie into a Cookie header value.

Parameters:

name - the cookie name

value - the cookie value

Returns:

a Rfc6265 style Cookie header value

encode

public static 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 static 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 static String encode(Iterable<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.