io.micronaut.http.netty.cookies

Class NettyCookie

java.lang.Object

io.micronaut.http.netty.cookies.NettyCookie

All Implemented Interfaces:

Cookie, java.io.Serializable, java.lang.Comparable<Cookie>

@Internal
public class NettyCookie
extends java.lang.Object
implements Cookie

A wrapper around a Netty cookie.

Since:

1.0

Author:

Graeme Rocher

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NettyCookie(io.netty.handler.codec.http.cookie.Cookie nettyCookie)
NettyCookie(java.lang.String name, java.lang.String value)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Cookie o)
Cookie	domain(java.lang.String domain) Sets the domain of the cookie.
java.lang.String	getDomain() Gets the domain name of this Cookie.
long	getMaxAge()
java.lang.String	getName()
io.netty.handler.codec.http.cookie.Cookie	getNettyCookie()
java.lang.String	getPath() The path of the cookie.
java.util.Optional<SameSite>	getSameSite() Checks to see if this Cookie can be sent along cross-site requests.
java.lang.String	getValue()
Cookie	httpOnly(boolean httpOnly) Sets whether the cookie is HTTP-Only.
boolean	isHttpOnly() Checks to see if this Cookie can only be accessed via HTTP.
boolean	isSecure()
Cookie	maxAge(long maxAge) Sets the max age of the cookie in seconds.
Cookie	path(java.lang.String path) Sets the path of the cookie.
Cookie	sameSite(SameSite sameSite) Determines if this this Cookie can be sent along cross-site requests.
Cookie	secure(boolean secure) Sets whether the cookie is secure.
Cookie	value(java.lang.String value) Sets the value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.cookie.Cookie

configure, configure, maxAge, of

Constructor Detail

NettyCookie

public NettyCookie(io.netty.handler.codec.http.cookie.Cookie nettyCookie)

Parameters:

nettyCookie - The Netty cookie

NettyCookie

public NettyCookie(java.lang.String name,
                   java.lang.String value)

Parameters:

name - The name

value - The value

Method Detail

getNettyCookie

public io.netty.handler.codec.http.cookie.Cookie getNettyCookie()

Returns:

The Netty cookie

getName

@NonNull
public java.lang.String getName()

Specified by:

getName in interface Cookie

Returns:

The name of the cookie

getValue

@NonNull
public java.lang.String getValue()

Specified by:

getValue in interface Cookie

Returns:

The value of the cookie

getDomain

public java.lang.String getDomain()

Description copied from interface: Cookie

Gets the domain name of this Cookie.

Domain names are formatted according to RFC 2109.

Specified by:

getDomain in interface Cookie

Returns:

the domain name of this Cookie

getPath

public java.lang.String getPath()

Description copied from interface: Cookie

The path of the cookie. The cookie is visible to all paths below the request path on the server.

Specified by:

getPath in interface Cookie

Returns:

The cookie path

isHttpOnly

public boolean isHttpOnly()

Description copied from interface: Cookie

Checks to see if this Cookie can only be accessed via HTTP. If this returns true, the Cookie cannot be accessed through client side script - But only if the browser supports it.

See here for reference

Specified by:

isHttpOnly in interface Cookie

Returns:

True if this Cookie is HTTP-only or false if it isn't

isSecure

public boolean isSecure()

Specified by:

isSecure in interface Cookie

Returns:

True if the cookie is secure

getMaxAge

public long getMaxAge()

Specified by:

getMaxAge in interface Cookie

Returns:

The maximum age of the cookie in seconds

maxAge

@NonNull
public Cookie maxAge(long maxAge)

Description copied from interface: Cookie

Sets the max age of the cookie in seconds.

Specified by:

maxAge in interface Cookie

Parameters:

maxAge - The max age

Returns:

This cookie

getSameSite

public java.util.Optional<SameSite> getSameSite()

Description copied from interface: Cookie

Checks to see if this Cookie can be sent along cross-site requests. For more information, please look here

Specified by:

getSameSite in interface Cookie

Returns:

The SameSite attribute of the cookie

sameSite

@NonNull
public Cookie sameSite(@Nullable
                                SameSite sameSite)

Description copied from interface: Cookie

Determines if this this Cookie can be sent along cross-site requests. For more information, please look here

Specified by:

sameSite in interface Cookie

Parameters:

sameSite - SameSite value

Returns:

This cookie

value

@NonNull
public Cookie value(@NonNull
                             java.lang.String value)

Description copied from interface: Cookie

Sets the value.

Specified by:

value in interface Cookie

Parameters:

value - The value of the cookie

Returns:

This cookie

domain

@NonNull
public Cookie domain(java.lang.String domain)

Description copied from interface: Cookie

Sets the domain of the cookie.

Specified by:

domain in interface Cookie

Parameters:

domain - The domain of the cookie

Returns:

This cookie

path

@NonNull
public Cookie path(java.lang.String path)

Description copied from interface: Cookie

Sets the path of the cookie.

Specified by:

path in interface Cookie

Parameters:

path - The path of the cookie

Returns:

This cookie

secure

@NonNull
public Cookie secure(boolean secure)

Description copied from interface: Cookie

Sets whether the cookie is secure.

Specified by:

secure in interface Cookie

Parameters:

secure - Is the cookie secure

Returns:

This cookie

httpOnly

@NonNull
public Cookie httpOnly(boolean httpOnly)

Description copied from interface: Cookie

Sets whether the cookie is HTTP-Only.

Specified by:

httpOnly in interface Cookie

Parameters:

httpOnly - Is the cookie HTTP-Only

Returns:

This cookie

compareTo

public int compareTo(Cookie o)

Specified by:

compareTo in interface java.lang.Comparable<Cookie>