org.forgerock.openig.http

Class CookieBuilder

java.lang.Object

org.forgerock.openig.http.CookieBuilder

public final class CookieBuilder
extends Object

Class to collate all static cookie configuration data for building response cookies.

Field Summary

Fields

Modifier and Type	Field and Description
static int	COOKIE_APPROX_BROWSER_LIMIT Browse cookie size limit.

Method Summary

Modifier and Type	Method and Description
Cookie	build() Create a Cookie based on the details held in this CookieBuilder.
static CookieBuilder	builder(JsonValue cookieConfig, String defaultName, String defaultPath) Create a CookieBuilder based on the JSON structure of:
static CookieBuilder	builder(String name) Create a CookieBuilder with just the cookie name set.
static int	calculateCookieHeaderSize(Cookie cookie) Convenience method to calculate the size of the Cookie when it is turned into a header.
CookieBuilder	domain(String domain) Set the domain and return a new instance of this builder.
String	getName() The name of the cookie that will be built from this CookieBuilder.
CookieBuilder	httpOnly(boolean httpOnly) Set the httpOnly flag and return a new instance of this builder.
CookieBuilder	path(String path) Set the path and return a new instance of this builder.
CookieBuilder	sameSite(Cookie.SameSite sameSite) Set the SameSite enum and return a new instance of this builder.
CookieBuilder	secure(boolean secure) Set the secure flag and return a new instance of this builder.

Methods inherited from class java.lang.Object

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

Field Detail

COOKIE_APPROX_BROWSER_LIMIT

public static final int COOKIE_APPROX_BROWSER_LIMIT

Browse cookie size limit. See: https://tools.ietf.org/html/rfc6265#section-6.1.

See Also:

Constant Field Values

Method Detail

builder

public static CookieBuilder builder(JsonValue cookieConfig,
                                    String defaultName,
                                    String defaultPath)

Create a CookieBuilder based on the JSON structure of:

  {
        "name"                    : Name of cookie. Defaults to {@literal defaultName}.
        "domain"                  : Domain that cookie is applicable to.
        "path"                    : Path to apply to the cookie. Defaults to {@literal defaultPath}.
        "secure"                  : Set to {@code true} if the cookie should be secure. Default is {@code false}.
        "httpOnly"                : Set to {@code true} if cookie should be httpOnly. Default is {@code true}.
        "sameSite"                : SameSite cookie configuration. Default is {@code null}.
       }
 
 

Parameters:

cookieConfig - The JSON containing the cookie details.

defaultName - The cookie name to use if not defined in the cookieConfig.

defaultPath - The cookie path to use if not defined in the cookieConfig.

Returns:

a CookieBuilder based on the values defined in the cookieConfig.

builder

public static CookieBuilder builder(String name)

Create a CookieBuilder with just the cookie name set.

Parameters:

name - The name to use for the cookie name.

Returns:

a CookieBuilder with just the cookie name set.

calculateCookieHeaderSize

public static int calculateCookieHeaderSize(Cookie cookie)

Convenience method to calculate the size of the Cookie when it is turned into a header. Can be useful when dealing with JWT based cookies to check if they are going to be too big compared to the COOKIE_APPROX_BROWSER_LIMIT.

Parameters:

cookie - The Cookie to use for the calculation.

Returns:

the length of the header for the passed Cookie.

getName

public String getName()

The name of the cookie that will be built from this CookieBuilder.

Returns:

the name of the cookie that will be built from this CookieBuilder.

domain

public CookieBuilder domain(String domain)

Set the domain and return a new instance of this builder.

Parameters:

domain - the value of domain to use.

Returns:

a new instance of the builder

path

public CookieBuilder path(String path)

Set the path and return a new instance of this builder.

Parameters:

path - the value of path to use.

Returns:

a new instance of the builder

secure

public CookieBuilder secure(boolean secure)

Set the secure flag and return a new instance of this builder.

Parameters:

secure - true if secure cookies should be enabled or false otherwise.

Returns:

a new instance of the builder

httpOnly

public CookieBuilder httpOnly(boolean httpOnly)

Set the httpOnly flag and return a new instance of this builder.

Parameters:

httpOnly - true if httpOnly cookies should be enabled or false otherwise.

Returns:

a new instance of the builder

sameSite

public CookieBuilder sameSite(Cookie.SameSite sameSite)

Set the SameSite enum and return a new instance of this builder.

Parameters:

sameSite - LAX or STRICT.

Returns:

a new instance of the builder

build

public Cookie build()

Create a Cookie based on the details held in this CookieBuilder.

Returns:

a Cookie based on the details held in this CookieBuilder.