io.netty.handler.codec.http

Class ServerCookieEncoder

java.lang.Object

io.netty.handler.codec.http.ServerCookieEncoder

public final class ServerCookieEncoder
extends Object

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 are supposed to be sent at once in a single "Set-Cookie" header.

 // Example
 HttpRequest req = ...;
 res.setHeader("Cookie", ServerCookieEncoder.encode("JSESSIONID", "1234"));
 

See Also:

ServerCookieDecoder

Method Summary

Methods

Modifier and Type	Method and Description
static List<String>	encode(Collection<Cookie> cookies) Batch encodes cookies into Set-Cookie header values.
static List<String>	encode(Cookie... cookies) Batch encodes cookies into Set-Cookie header values.
static String	encode(Cookie cookie) Encodes the specified cookie into a Set-Cookie header value.
static List<String>	encode(Iterable<Cookie> cookies) Batch encodes cookies into Set-Cookie header values.
static String	encode(String name, String value) Encodes the specified cookie name-value pair into a Set-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 name-value pair into a Set-Cookie header value.

Parameters:

name - the cookie name

value - the cookie value

Returns:

a single Set-Cookie header value

encode

public static String encode(Cookie cookie)

Encodes the specified cookie into a Set-Cookie header value.

Parameters:

cookie - the cookie

Returns:

a single Set-Cookie header value

encode

public static List<String> encode(Cookie... cookies)

Batch encodes cookies into Set-Cookie header values.

Parameters:

cookies - a bunch of cookies

Returns:

the corresponding bunch of Set-Cookie headers

encode

public static List<String> encode(Collection<Cookie> cookies)

Batch encodes cookies into Set-Cookie header values.

Parameters:

cookies - a bunch of cookies

Returns:

the corresponding bunch of Set-Cookie headers

encode

public static List<String> encode(Iterable<Cookie> cookies)

Batch encodes cookies into Set-Cookie header values.

Parameters:

cookies - a bunch of cookies

Returns:

the corresponding bunch of Set-Cookie headers