io.mangoo.utils

Class CookieBuilder

java.lang.Object

io.mangoo.utils.CookieBuilder

public class CookieBuilder
extends Object

Author:

svenkubiak, WilliamDunne

Constructor Summary

Constructors

Constructor and Description
CookieBuilder()

Method Summary

Modifier and Type	Method and Description
io.undertow.server.handlers.Cookie	build()
static CookieBuilder	create()
CookieBuilder	discard(boolean discard) Sets discarding of the cookie Default is false
CookieBuilder	domain(String domain) Sets the domain of the cookie Default is null
CookieBuilder	expires(LocalDateTime expires) Sets the date when the cookie expires Default is now plus 1 day
CookieBuilder	httpOnly(boolean httpOnly) Sets if the cookie can only be used of HTTP connections Default is false
CookieBuilder	maxAge(Integer maxAge) Sets the max age of the cookie Default value is null
CookieBuilder	name(String name) Sets the name of the cookie Default is ""
CookieBuilder	path(String path) Sets the path of the cookie Default is /
CookieBuilder	secure(boolean secure) Sets if the cookie can only be used of HTTPS connections Default is false
CookieBuilder	value(String value) Sets the value of the cookie Default is ""

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieBuilder

public CookieBuilder()

Method Detail

create

public static CookieBuilder create()

Returns:

A new CookieBuilder instance

name

public CookieBuilder name(String name)

Sets the name of the cookie Default is ""

Parameters:

name - The name of the cookie

Returns:

CookieBuilder instance

value

public CookieBuilder value(String value)

Sets the value of the cookie Default is ""

Parameters:

value - The value of the cookie

Returns:

CookieBuilder instance

path

public CookieBuilder path(String path)

Sets the path of the cookie Default is /

Parameters:

path - The path of the cookie

Returns:

CookieBuilder instance

expires

public CookieBuilder expires(LocalDateTime expires)

Sets the date when the cookie expires Default is now plus 1 day

Parameters:

expires - The expires LocalDateTime

Returns:

CookieBuilder instance

maxAge

public CookieBuilder maxAge(Integer maxAge)

Sets the max age of the cookie Default value is null

Parameters:

maxAge - The max age of the cookie

Returns:

CookieBuilder instance

domain

public CookieBuilder domain(String domain)

Sets the domain of the cookie Default is null

Parameters:

domain - The domain of the cookie

Returns:

CookieBuilder instance

discard

public CookieBuilder discard(boolean discard)

Sets discarding of the cookie Default is false

Parameters:

discard - True if cookie should be discard, false otherwise

Returns:

CookieBuilder instance

secure

public CookieBuilder secure(boolean secure)

Sets if the cookie can only be used of HTTPS connections Default is false

Parameters:

secure - True if the cookie can only be used via HTTPS, false otherwise

Returns:

CookieBuilder instance

httpOnly

public CookieBuilder httpOnly(boolean httpOnly)

Sets if the cookie can only be used of HTTP connections Default is false

Parameters:

httpOnly - True if the cookie can only be send via HTTP, false otherwise

Returns:

CookieBuilder instance

build

public io.undertow.server.handlers.Cookie build()