io.muserver

Class Cookie

java.lang.Object

io.muserver.Cookie

public class Cookie
extends Object

A cookie that is sent from the server to the client.

To create cookies, you can create a builder by calling builder().

Constructor Summary

Constructors

Constructor and Description
Cookie(String name, String value) Deprecated. Please use CookieBuilder.newCookie() instead

Method Summary

Modifier and Type	Method and Description
static CookieBuilder	builder() Creates a new cookie builder with secure, Strict SameSite and httpOnly selected.
String	domain()
boolean	equals(Object o)
int	hashCode()
boolean	isHttpOnly()
boolean	isSecure()
long	maxAge()
String	name()
String	path()
String	sameSite()
static Cookie	secureCookie(String name, String value) Deprecated. Please use CookieBuilder.newSecureCookie() instead
void	setDomain(String domain) Deprecated. Please create cookies with the CookieBuilder
void	setHttpOnly(boolean httpOnly) Deprecated. Please create cookies with the CookieBuilder
void	setMaxAge(long maxAgeInSeconds) Deprecated. Please create cookies with the CookieBuilder
void	setPath(String path) Deprecated. Please create cookies with the CookieBuilder
void	setSecure(boolean secure) Deprecated. Please create cookies with the CookieBuilder
void	setValue(String value) Deprecated. Please create cookies with the CookieBuilder
String	toString()
String	value()

Methods inherited from class java.lang.Object

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

Constructor Detail

Cookie

@Deprecated
public Cookie(String name,
                           String value)

Deprecated. Please use CookieBuilder.newCookie() instead

Creates a new cookie with secure settings such as HttpOnly and Secure set to true.

Parameters:

name - The name of the cookie

value - The value of the cookie

Method Detail

secureCookie

@Deprecated
public static Cookie secureCookie(String name,
                                               String value)

Deprecated. Please use CookieBuilder.newSecureCookie() instead

Creates a new cookie with secure settings such as HttpOnly and Secure set to true.

Parameters:

name - The name of the cookie

value - The value of the cookie

Returns:

Returns a new cookie that can be sent to the response

name

public String name()

Returns:

The cookie name

value

public String value()

Returns:

The cookie value

setValue

@Deprecated
public void setValue(String value)

Deprecated. Please create cookies with the CookieBuilder

Sets the value of the cookie.

Parameters:

value - The value to set.

domain

public String domain()

Returns:

The domain this cookie is valid for

setDomain

@Deprecated
public void setDomain(String domain)

Deprecated. Please create cookies with the CookieBuilder

Parameters:

domain - domain

path

public String path()

Returns:

The path this cookie applies to

setPath

@Deprecated
public void setPath(String path)

Deprecated. Please create cookies with the CookieBuilder

Parameters:

path - path

maxAge

public long maxAge()

Returns:

The max age in seconds of this cookie

sameSite

public String sameSite()

Returns:

The SameSite value of the cookie, for example "Strict", "Lax", or "None"

setMaxAge

@Deprecated
public void setMaxAge(long maxAgeInSeconds)

Deprecated. Please create cookies with the CookieBuilder

Parameters:

maxAgeInSeconds - max

isSecure

public boolean isSecure()

Returns:

True if this cookie is only readable over https

setSecure

@Deprecated
public void setSecure(boolean secure)

Deprecated. Please create cookies with the CookieBuilder

Parameters:

secure - secure

isHttpOnly

public boolean isHttpOnly()

Returns:

True if this cookie is only available via HTTP. If false, client side script will not be able to read the cookie (if the client supports this).

setHttpOnly

@Deprecated
public void setHttpOnly(boolean httpOnly)

Deprecated. Please create cookies with the CookieBuilder

Parameters:

httpOnly - httpOnly

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static CookieBuilder builder()

Creates a new cookie builder with secure, Strict SameSite and httpOnly selected.

Returns:

A new builder