org.jooby

Interface Cookie

public interface Cookie

Creates a cookie, a small amount of information sent by a server to a Web browser, saved by the browser, and later sent back to the server. A cookie's value can uniquely identify a client, so cookies are commonly used for session management.

A cookie has a name, a single value, and optional attributes such as a comment, path and domain qualifiers, a maximum age, and a version number.

The server sends cookies to the browser by using the Response.cookie(Cookie) method, which adds fields to HTTP response headers to send cookies to the browser, one at a time. The browser is expected to support 20 cookies for each Web server, 300 cookies total, and may limit cookie size to 4 KB each.

The browser returns cookies to the server by adding fields to HTTP request headers. Cookies can be retrieved from a request by using the Request.cookie(String) method. Several cookies might have the same name but different path attributes.

This class supports both the Version 0 (by Netscape) and Version 1 (by RFC 2109) cookie specifications. By default, cookies are created using Version 0 to ensure the best interoperability.

Since:

0.1.0

Author:

edgar and various

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Cookie.Definition Build a Cookie.
static class	Cookie.Signature Sign cookies using a HMAC algorithm plus SHA-256 hash.

Field Summary

Fields

Modifier and Type	Field and Description
static Function<String,Map<String,String>>	URL_DECODER Decode a cookie value using, like: k=v, multiple k=v pair are separated by &.
static Function<Map<String,String>,String>	URL_ENCODER Encode a hash into cookie value, like: k1=v1&...&kn=vn.

Method Summary

Modifier and Type	Method and Description
Optional<String>	comment()
Optional<String>	domain()
String	encode()
boolean	httpOnly()
int	maxAge() Gets the maximum age of this cookie (in seconds).
String	name()
Optional<String>	path()
boolean	secure() Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
Optional<String>	value()

Field Detail

URL_DECODER

static final Function<String,Map<String,String>> URL_DECODER

Decode a cookie value using, like: k=v, multiple k=v pair are separated by &. Also, k and v are decoded using URLDecoder.

URL_ENCODER

static final Function<Map<String,String>,String> URL_ENCODER

Encode a hash into cookie value, like: k1=v1&...&kn=vn. Also, key and value are encoded using URLEncoder.

Method Detail

name

@Nonnull
String name()

Returns:

Cookie's name.

value

@Nonnull
Optional<String> value()

Returns:

Cookie's value.

comment

@Nonnull
Optional<String> comment()

Returns:

An optional comment.

domain

@Nonnull
Optional<String> domain()

Returns:

Cookie's domain.

maxAge

int maxAge()

Gets the maximum age of this cookie (in seconds).

By default, -1 is returned, which indicates that the cookie will persist until browser shutdown.

Returns:

An integer specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until browser shutdown

path

@Nonnull
Optional<String> path()

Returns:

Cookie's path.

secure

boolean secure()

Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.

Returns:

true if the browser uses a secure protocol, false otherwise.

httpOnly

boolean httpOnly()

Returns:

True if HTTP Only.

encode

@Nonnull
String encode()

Returns:

Encode the cookie.