Module io.inverno.mod.http.base

Package io.inverno.mod.http.base.internal.header

Class SetCookieCodec.SetCookie

java.lang.Object

io.inverno.mod.http.base.internal.header.GenericHeader

io.inverno.mod.http.base.internal.header.ParameterizedHeader

io.inverno.mod.http.base.internal.header.SetCookieCodec.SetCookie

All Implemented Interfaces:

Cookie, Header, Headers.SetCookie, SetCookie, SetCookie.Configurator

Enclosing class:

SetCookieCodec

public static final class SetCookieCodec.SetCookie
extends ParameterizedHeader
implements Headers.SetCookie, SetCookie, SetCookie.Configurator

Headers.SetCookie header implemetation.

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• ParameterizedHeader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SetCookieCodec.SetCookie.Builder	Set-Cookie HeaderBuilder implementation.

Nested classes/interfaces inherited from class io.inverno.mod.http.base.internal.header.ParameterizedHeader

ParameterizedHeader.AbstractBuilder<A extends ParameterizedHeader,B extends ParameterizedHeader.AbstractBuilder<A,B>>

Nested classes/interfaces inherited from interface io.inverno.mod.http.base.header.Headers.SetCookie

Headers.SetCookie.SameSitePolicy

Nested classes/interfaces inherited from interface io.inverno.mod.http.base.header.SetCookie

SetCookie.Configurator

Field Summary

Fields inherited from class io.inverno.mod.http.base.internal.header.ParameterizedHeader

parameterizedValue, parameters

Fields inherited from class io.inverno.mod.http.base.internal.header.GenericHeader

headerName, headerValue

Fields inherited from interface io.inverno.mod.http.base.header.Headers.SetCookie

DOMAIN, EXPIRES, HTTPONLY, MAX_AGE, PATH, SAME_SITE, SECURE

Constructor Summary

Constructors

Constructor	Description
SetCookie()	Creates an empty set-cookie header.

Method Summary

Modifier and Type	Method	Description
SetCookie.Configurator	domain(String domain)	Sets the cookie domain attribute.
SetCookie.Configurator	expires(ZonedDateTime expires)	Sets the cookie expires attribute.
String	getDomain()	Returns the cookie max age.
ZonedDateTime	getExpires()	Returns the cookie expires value.
Integer	getMaxAge()	Returns the cookie max age.
String	getName()	Returns the cookie name.
String	getPath()	Returns the cookie path.
Headers.SetCookie.SameSitePolicy	getSameSite()	Returns cookie's same site attribute.
String	getValue()	Returns the cookie value.
SetCookie.Configurator	httpOnly(boolean httpOnly)	Sets the cookie http only flag attribute.
Boolean	isHttpOnly()	Returns the cookie HTTP only flag.
Boolean	isSecure()	Returns the cookie secure flag.
SetCookie.Configurator	maxAge(int maxAge)	Sets the cookie max age attribute in seconds.
SetCookie.Configurator	name(String name)	Sets the cookie name.
SetCookie.Configurator	path(String path)	Sets the cookie path attribute.
SetCookie.Configurator	sameSite(Headers.SetCookie.SameSitePolicy sameSite)	Sets the cookie same site flag attribute.
SetCookie.Configurator	secure(boolean secure)	Sets the cookie secure flag attribute.
SetCookie.Configurator	value(String value)	Sets the cookie value.

Methods inherited from class io.inverno.mod.http.base.internal.header.ParameterizedHeader

equals, getParameterizedValue, getParameters, hashCode

Methods inherited from class io.inverno.mod.http.base.internal.header.GenericHeader

getHeaderName, getHeaderValue, setHeaderValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.http.base.header.Header

getHeaderName, getHeaderValue

Constructor Details

SetCookie

public SetCookie()

Creates an empty set-cookie header.

Method Details

getName

public String getName()

Description copied from interface: Headers.SetCookie

Returns the cookie name.

Specified by:

getName in interface Cookie

Specified by:

getName in interface Headers.SetCookie

Returns:

the cookie name or null

getValue

public String getValue()

Description copied from interface: Headers.SetCookie

Returns the cookie value.

Specified by:

getValue in interface Cookie

Specified by:

getValue in interface Headers.SetCookie

Returns:

the cookie value or null

getExpires

public ZonedDateTime getExpires()

Description copied from interface: Headers.SetCookie

Returns the cookie expires value.

Specified by:

getExpires in interface Headers.SetCookie

Specified by:

getExpires in interface SetCookie

Returns:

the cookie expires value or null

getMaxAge

public Integer getMaxAge()

Description copied from interface: Headers.SetCookie

Returns the cookie max age.

Specified by:

getMaxAge in interface Headers.SetCookie

Specified by:

getMaxAge in interface SetCookie

Returns:

the cookie max age or null

getDomain

public String getDomain()

Description copied from interface: Headers.SetCookie

Returns the cookie max age.

Specified by:

getDomain in interface Headers.SetCookie

Specified by:

getDomain in interface SetCookie

Returns:

the cookie max age or null

getPath

public String getPath()

Description copied from interface: Headers.SetCookie

Returns the cookie path.

Specified by:

getPath in interface Headers.SetCookie

Specified by:

getPath in interface SetCookie

Returns:

the cookie path or null

isSecure

public Boolean isSecure()

Description copied from interface: Headers.SetCookie

Returns the cookie secure flag.

Specified by:

isSecure in interface Headers.SetCookie

Specified by:

isSecure in interface SetCookie

Returns:

the cookie secure flag or null

isHttpOnly

public Boolean isHttpOnly()

Description copied from interface: Headers.SetCookie

Returns the cookie HTTP only flag.

Specified by:

isHttpOnly in interface Headers.SetCookie

Specified by:

isHttpOnly in interface SetCookie

Returns:

the cookie HTTP only flag or null

getSameSite

public Headers.SetCookie.SameSitePolicy getSameSite()

Description copied from interface: Headers.SetCookie

Returns cookie's same site attribute.

Specified by:

getSameSite in interface Headers.SetCookie

Specified by:

getSameSite in interface SetCookie

Returns:

the same site attribute or null

name

public SetCookie.Configurator name(String name)

Description copied from interface: SetCookie.Configurator

Sets the cookie name.

Specified by:

name in interface SetCookie.Configurator

Parameters:

name - a cookie name

Returns:

the configurator

value

public SetCookie.Configurator value(String value)

Description copied from interface: SetCookie.Configurator

Sets the cookie value.

Specified by:

value in interface SetCookie.Configurator

Parameters:

value - a cookie value

Returns:

the configurator

expires

public SetCookie.Configurator expires(ZonedDateTime expires)

Description copied from interface: SetCookie.Configurator

Sets the cookie expires attribute.

Note that the resulting date time will be serialized at GMT time zone.

Specified by:

expires in interface SetCookie.Configurator

Parameters:

expires - the expires date time

Returns:

the configurator

maxAge

public SetCookie.Configurator maxAge(int maxAge)

Description copied from interface: SetCookie.Configurator

Sets the cookie max age attribute in seconds.

Specified by:

maxAge in interface SetCookie.Configurator

Parameters:

maxAge - the cookie max age

Returns:

the configurator

domain

public SetCookie.Configurator domain(String domain)

Description copied from interface: SetCookie.Configurator

Sets the cookie domain attribute.

Specified by:

domain in interface SetCookie.Configurator

Parameters:

domain - the cookie domain

Returns:

the configurator

path

public SetCookie.Configurator path(String path)

Description copied from interface: SetCookie.Configurator

Sets the cookie path attribute.

Specified by:

path in interface SetCookie.Configurator

Parameters:

path - the cookie path

Returns:

the configurator

secure

public SetCookie.Configurator secure(boolean secure)

Description copied from interface: SetCookie.Configurator

Sets the cookie secure flag attribute.

Specified by:

secure in interface SetCookie.Configurator

Parameters:

secure - the cookie secure flag

Returns:

the configurator

httpOnly

public SetCookie.Configurator httpOnly(boolean httpOnly)

Description copied from interface: SetCookie.Configurator

Sets the cookie http only flag attribute.

Specified by:

httpOnly in interface SetCookie.Configurator

Parameters:

httpOnly - the cookie http only flag

Returns:

the configurator

sameSite

public SetCookie.Configurator sameSite(Headers.SetCookie.SameSitePolicy sameSite)

Description copied from interface: SetCookie.Configurator

Sets the cookie same site flag attribute.

Specified by:

sameSite in interface SetCookie.Configurator

Parameters:

sameSite - a same site policy

Returns:

the configurator