play.core.cookie.encoding

Class ServerCookieEncoder

Object

play.core.cookie.encoding.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.

See Also:

ServerCookieDecoder

Field Summary

Fields

Modifier and Type	Field and Description
static ServerCookieEncoder	LAX Lax instance that doesn't validate name and value
static ServerCookieEncoder	STRICT Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265

Method Summary

Modifier and Type	Method and Description
List<String>	encode(Collection<? extends Cookie> cookies) Batch encodes cookies into Set-Cookie header values.
List<String>	encode(Cookie... cookies) Batch encodes cookies into Set-Cookie header values.
String	encode(Cookie cookie) Encodes the specified cookie into a Set-Cookie header value.
List<String>	encode(Iterable<? extends Cookie> cookies) Batch encodes cookies into Set-Cookie header values.
String	encode(String name, String value) Encodes the specified cookie name-value pair into a Set-Cookie header value.
protected void	validateCookie(String name, String value)

Methods inherited from class Object

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

Field Detail

STRICT

public static final ServerCookieEncoder STRICT

Strict encoder that validates that name and value chars are in the valid scope defined in RFC6265

LAX

public static final ServerCookieEncoder LAX

Lax instance that doesn't validate name and value

Method Detail

encode

public 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 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 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 List<String> encode(Collection<? extends 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 List<String> encode(Iterable<? extends Cookie> cookies)

Batch encodes cookies into Set-Cookie header values.

Parameters:

cookies - a bunch of cookies

Returns:

the corresponding bunch of Set-Cookie headers

validateCookie

protected void validateCookie(String name,
                              String value)