Module io.helidon.http

Package io.helidon.http

Class SetCookie

java.lang.Object

io.helidon.http.SetCookie

public class SetCookie
extends Object

Represents 'Set-Cookie' header value specified by RFC6265.

It is mutable and fluent builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SetCookie.Builder	A fluent API builder for SetCookie.
static enum	SetCookie.SameSite	The SameSite attribute of the Set-Cookie HTTP response header allows you to declare if your cookie should be restricted to a first-party or same-site context.

Method Summary

Modifier and Type	Method	Description
static SetCookie.Builder	builder(String name, String value)	Creates a new fluent API builder.
static SetCookie	create(String name, String value)	Creates new instance.
Optional<String>	domain()	Domain of cookie.
Optional<ZonedDateTime>	expires()	Expiration of cookie.
boolean	httpOnly()	HttpOnly attribute of cookie.
Optional<Duration>	maxAge()	Max age of cookie.
String	name()	Name of the cookie.
static SetCookie	parse(String setCookie)	Parses new instance of SetCookie from the String representation.
Optional<String>	path()	Path of cookie.
Optional<SetCookie.SameSite>	sameSite()	Same site attribute of cookie.
boolean	secure()	Secure attribute of cookie.
String	text()	Text representation of this cookie.
String	toString()	Returns content of this instance as a 'Set-Cookie:' header value specified by RFC6265.
String	value()	Value of the cookie.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SetCookie.Builder builder(String name,
 String value)

Creates a new fluent API builder.

Parameters:

name - a cookie name.

value - a cookie value.

Returns:

a new fluent API builder

parse

public static SetCookie parse(String setCookie)

Parses new instance of SetCookie from the String representation.

Parameters:

setCookie - string representation

Returns:

new instance

create

public static SetCookie create(String name,
 String value)

Creates new instance.

Parameters:

name - a cookie name.

value - a cookie value.

Returns:

a new instance with just the name and value configured

name

public String name()

Name of the cookie.

Returns:

the name.

value

public String value()

Value of the cookie.

Returns:

value

expires

public Optional<ZonedDateTime> expires()

Expiration of cookie.

Returns:

expiration if defined

maxAge

public Optional<Duration> maxAge()

Max age of cookie.

Returns:

max age if defined

domain

public Optional<String> domain()

Domain of cookie.

Returns:

domain if defined

path

public Optional<String> path()

Path of cookie.

Returns:

path if defined

secure

public boolean secure()

Secure attribute of cookie.

Returns:

whether secure was set

httpOnly

public boolean httpOnly()

HttpOnly attribute of cookie.

Returns:

whether HttpOnly was set

sameSite

public Optional<SetCookie.SameSite> sameSite()

Same site attribute of cookie.

Returns:

same site if defined

text

public String text()

Text representation of this cookie.

Returns:

cookie text

toString

public String toString()

Returns content of this instance as a 'Set-Cookie:' header value specified by RFC6265.

Overrides:

toString in class Object

Returns:

a 'Set-Cookie:' header value.