spring-boot/org.springframework.boot.web.servlet.server/CookieSameSiteSupplier

CookieSameSiteSupplier

@FunctionalInterface
interface CookieSameSiteSupplier

Strategy interface that can be used with ConfigurableServletWebServerFactory implementations in order to supply custom SameSite values for specific cookies.

Basic CookieSameSiteSupplier implementations can be constructed using the of... factory methods, typically combined with name matching. For example: 

CookieSameSiteSupplier.ofLax().whenHasName("mycookie");
Content copied to clipboard

Author

Phillip Webb

Since

2.6.0

See also

Functions

Link copied to clipboard
abstract fun getSameSite(cookie: Cookie): Cookie.SameSite
Get the SameSite values that should be used for the given Cookie.
Link copied to clipboard
open fun of(sameSite: Cookie.SameSite): CookieSameSiteSupplier
Return a new CookieSameSiteSupplier that always returns the given SameSite value.
Link copied to clipboard
open fun ofLax(): CookieSameSiteSupplier
Return a new CookieSameSiteSupplier that always returns LAX.
Link copied to clipboard
open fun ofNone(): CookieSameSiteSupplier
Return a new CookieSameSiteSupplier that always returns NONE.
Link copied to clipboard
open fun ofStrict(): CookieSameSiteSupplier
Return a new CookieSameSiteSupplier that always returns STRICT.
Link copied to clipboard
open fun when(predicate: Predicate<Cookie>): CookieSameSiteSupplier
Limit this supplier so that it's only called if the predicate accepts the Cookie.
Link copied to clipboard
open fun whenHasName(name: String): CookieSameSiteSupplier
open fun whenHasName(nameSupplier: Supplier<String>): CookieSameSiteSupplier
Limit this supplier so that it's only called if the Cookie has the given name.
Link copied to clipboard
open fun whenHasNameMatching(regex: String): CookieSameSiteSupplier
Limit this supplier so that it's only called if the Cookie name matches the given regex.
open fun whenHasNameMatching(pattern: Pattern): CookieSameSiteSupplier
Limit this supplier so that it's only called if the Cookie name matches the given Pattern.