Module io.inverno.mod.http.base

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

Interface Headers.SetCookie

All Superinterfaces:

Header

Enclosing class:

Headers

public static interface Headers.SetCookie
extends Header

Set-cookie HTTP header as defined by RFC 6265 Section 4.1.

Since:

1.0

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Headers.SetCookie.SameSitePolicy	Defines a same site policy as defined by SameSite cookie.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOMAIN	Domain parameter
static final String	EXPIRES	Expires parameter
static final String	HTTPONLY	HttpOnly parameter
static final String	MAX_AGE	Max-Age parameter
static final String	PATH	Path parameter
static final String	SAME_SITE	HttpOnly parameter
static final String	SECURE	Secure parameter

Method Summary

Modifier and Type	Method	Description
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.
Boolean	isHttpOnly()	Returns the cookie HTTP only flag.
Boolean	isSecure()	Returns the cookie secure flag.

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

getHeaderName, getHeaderValue

Field Details

EXPIRES

static final String EXPIRES

Expires parameter

See Also:

• Constant Field Values

MAX_AGE

static final String MAX_AGE

Max-Age parameter

See Also:

• Constant Field Values

DOMAIN

static final String DOMAIN

Domain parameter

See Also:

• Constant Field Values

PATH

static final String PATH

Path parameter

See Also:

• Constant Field Values

SECURE

static final String SECURE

Secure parameter

See Also:

• Constant Field Values

HTTPONLY

static final String HTTPONLY

HttpOnly parameter

See Also:

• Constant Field Values

SAME_SITE

static final String SAME_SITE

HttpOnly parameter

See Also:

• Constant Field Values

Method Details

getName

String getName()

Returns the cookie name.

Returns:

the cookie name or null

getValue

String getValue()

Returns the cookie value.

Returns:

the cookie value or null

getExpires

ZonedDateTime getExpires()

Returns the cookie expires value.

Returns:

the cookie expires value or null

getMaxAge

Integer getMaxAge()

Returns the cookie max age.

Returns:

the cookie max age or null

getDomain

String getDomain()

Returns the cookie max age.

Returns:

the cookie max age or null

getPath

String getPath()

Returns the cookie path.

Returns:

the cookie path or null

isSecure

Boolean isSecure()

Returns the cookie secure flag.

Returns:

the cookie secure flag or null

isHttpOnly

Boolean isHttpOnly()

Returns the cookie HTTP only flag.

Returns:

the cookie HTTP only flag or null

getSameSite

Headers.SetCookie.SameSitePolicy getSameSite()

Returns cookie's same site attribute.

Returns:

the same site attribute or null