play.mvc

Class Http.CookieBuilder

java.lang.Object

play.mvc.Http.CookieBuilder

Enclosing class:

Http

public static class Http.CookieBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
Http.Cookie	build()
Http.CookieBuilder	withDomain(java.lang.String domain)
Http.CookieBuilder	withHttpOnly(boolean httpOnly)
Http.CookieBuilder	withMaxAge(java.time.Duration maxAge) Set the maximum age of the cookie.
Http.CookieBuilder	withMaxAge(java.lang.Integer maxAge) Deprecated. As of 2.6.0, use withMaxAge(Duration) instead.
Http.CookieBuilder	withName(java.lang.String name)
Http.CookieBuilder	withPath(java.lang.String path)
Http.CookieBuilder	withSameSite(Http.Cookie.SameSite sameSite)
Http.CookieBuilder	withSecure(boolean secure)
Http.CookieBuilder	withValue(java.lang.String value)

Methods inherited from class java.lang.Object

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

Method Detail

withName

public Http.CookieBuilder withName(java.lang.String name)

Parameters:

name - The name of the cookie

Returns:

the cookie builder with the new name

withValue

public Http.CookieBuilder withValue(java.lang.String value)

Parameters:

value - The value of the cookie

Returns:

the cookie builder with the new value

withMaxAge

@Deprecated
public Http.CookieBuilder withMaxAge(java.lang.Integer maxAge)

Deprecated. As of 2.6.0, use withMaxAge(Duration) instead.

Parameters:

maxAge - The maxAge of the cookie in seconds

Returns:

the cookie builder with the new maxAge

withMaxAge

public Http.CookieBuilder withMaxAge(java.time.Duration maxAge)

Set the maximum age of the cookie.

For example, to set a maxAge of 40 days: builder.withMaxAge(Duration.of(40, ChronoUnit.DAYS))

Parameters:

maxAge - a duration representing the maximum age of the cookie. Will be truncated to the nearest second.

Returns:

the cookie builder with the new maxAge

withPath

public Http.CookieBuilder withPath(java.lang.String path)

Parameters:

path - The path of the cookie

Returns:

the cookie builder with the new path

withDomain

public Http.CookieBuilder withDomain(java.lang.String domain)

Parameters:

domain - The domain of the cookie

Returns:

the cookie builder with the new domain

withSecure

public Http.CookieBuilder withSecure(boolean secure)

Parameters:

secure - specify if the cookie is secure

Returns:

the cookie builder with the new is secure flag

withHttpOnly

public Http.CookieBuilder withHttpOnly(boolean httpOnly)

Parameters:

httpOnly - specify if the cookie is httpOnly

Returns:

the cookie builder with the new is httpOnly flag

withSameSite

public Http.CookieBuilder withSameSite(Http.Cookie.SameSite sameSite)

Parameters:

sameSite - specify if the cookie is SameSite

Returns:

the cookie builder with the new SameSite flag

build

public Http.Cookie build()

Returns:

a new cookie with the current builder parameters