io.muserver

Class CookieBuilder

java.lang.Object

io.muserver.CookieBuilder

public class CookieBuilder
extends Object

A builder to create cookies that will be sent on a Response with MuResponse.addCookie(Cookie)

Constructor Summary

Constructors

Constructor and Description
CookieBuilder()

Method Summary

Modifier and Type	Method and Description
Cookie	build()
CookieBuilder	httpOnly(boolean httpOnly) Instructs browsers on whether or not the cookie can be accessed via JavaScript.
CookieBuilder	makeSessionCookie() Makes this cookie expire when the browser session expires (which may be when the user closes their browser).
static CookieBuilder	newCookie() Creates a new session cookie
static CookieBuilder	newSecureCookie() Creates a new session cookie that is only sent over HTTPS and cannot be accessed with JavaScript.
CookieBuilder	secure(boolean secure) Instructs clients on whether or not cookies can be sent over non-secure (HTTP) connections.
CookieBuilder	withDomain(String domain) Sets the host that clients should send the cookie over.
CookieBuilder	withMaxAgeInSeconds(long maxAge) Specifies how long the cookie will last for.
CookieBuilder	withName(String name) Sets the name of the cookie.
CookieBuilder	withPath(String path) Sets the path prefix that the cookie will be sent with, or null to send to all paths.
CookieBuilder	withUrlEncodedValue(String value) Sets the value of the cookie by URL Encoding the given value.
CookieBuilder	withValue(String value) Sets the value of the cookie.

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieBuilder

public CookieBuilder()

Method Detail

withName

public CookieBuilder withName(String name)

Sets the name of the cookie.

Parameters:

name - The name of the cookie

Returns:

This builder

withValue

public CookieBuilder withValue(String value)

Sets the value of the cookie.

Note that only a subset of ASCII characters are allowed (any other characters must be encoded). Consider using withUrlEncodedValue(String) instead if you want to use arbitrary values.

Parameters:

value - The value to use for the cookie, which can be any US-ASCII characters excluding CTLs, whitespace, double quotes, comma, semicolon, and backslash.

Returns:

This builder

Throws:

IllegalArgumentException - If the value contains illegal characters

withUrlEncodedValue

public CookieBuilder withUrlEncodedValue(String value)

Sets the value of the cookie by URL Encoding the given value.

Parameters:

value - A value containing any characters that will be URL Encoded.

Returns:

This builder

withDomain

public CookieBuilder withDomain(String domain)

Sets the host that clients should send the cookie over. By default it is the current domain (but not subdomains).

To allow sub-domains, specify the current domain (e.g. with request.uri().getHost()).

Parameters:

domain - The host part of a URL (without scheme or port), e.g. example.org

Returns:

This builder

withPath

public CookieBuilder withPath(String path)

Sets the path prefix that the cookie will be sent with, or null to send to all paths.

Parameters:

path - A path such as /order which would cause cookies to be sent with requests to paths such as /order and /order/checkout etc.

Returns:

This builder

withMaxAgeInSeconds

public CookieBuilder withMaxAgeInSeconds(long maxAge)

Specifies how long the cookie will last for.

A value of 0 will cause most browsers to delete the cookie immediately.

Use makeSessionCookie() to make this a session cookie that will cause most browsers to delete the cookie when they close their browser.

Parameters:

maxAge - The age to live in seconds.

Returns:

This builder

makeSessionCookie

public CookieBuilder makeSessionCookie()

Makes this cookie expire when the browser session expires (which may be when the user closes their browser).

This overwrites any value set with withMaxAgeInSeconds(long)

Returns:

This builder

secure

public CookieBuilder secure(boolean secure)

Instructs clients on whether or not cookies can be sent over non-secure (HTTP) connections.

It is strongly recommended to use this if your site is HTTPS only as it may prevent private information being sent over HTTP.

Parameters:

secure - true to make this cookie HTTPS-only, or false to allow HTTPS and HTTP.

Returns:

This builder

httpOnly

public CookieBuilder httpOnly(boolean httpOnly)

Instructs browsers on whether or not the cookie can be accessed via JavaScript. This is a secure feature that should be used unless JavaScript access is required.

Parameters:

httpOnly - true to make it so JavaScript cannot access this cookie; otherwise false

Returns:

This builder

newCookie

public static CookieBuilder newCookie()

Creates a new session cookie

Returns:

A builder to create a new cookie;

newSecureCookie

public static CookieBuilder newSecureCookie()

Creates a new session cookie that is only sent over HTTPS and cannot be accessed with JavaScript.

Returns:

A builder to create a new cookie;

build

public Cookie build()

Returns:

Returns a newly created cookie.