CookieSameSiteSupplier (spring-boot 2.6.7)

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface CookieSameSiteSupplier
```
Strategy interface that can be used with ConfigurableServletWebServerFactory implementations in order to supply custom Cookie.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");
 
```
Since:

2.6.0

See Also:

ConfigurableServletWebServerFactory.addCookieSameSiteSuppliers(CookieSameSiteSupplier...)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Cookie.SameSite`	`getSameSite(javax.servlet.http.Cookie cookie)` Get the `Cookie.SameSite` values that should be used for the given `Cookie`.
`static CookieSameSiteSupplier`	`of(Cookie.SameSite sameSite)` Return a new `CookieSameSiteSupplier` that always returns the given `Cookie.SameSite` value.
`static CookieSameSiteSupplier`	`ofLax()` Return a new `CookieSameSiteSupplier` that always returns `Cookie.SameSite.LAX`.
`static CookieSameSiteSupplier`	`ofNone()` Return a new `CookieSameSiteSupplier` that always returns `Cookie.SameSite.NONE`.
`static CookieSameSiteSupplier`	`ofStrict()` Return a new `CookieSameSiteSupplier` that always returns `Cookie.SameSite.STRICT`.
`default CookieSameSiteSupplier`	`when(java.util.function.Predicate<javax.servlet.http.Cookie> predicate)` Limit this supplier so that it's only called if the predicate accepts the Cookie.
`default CookieSameSiteSupplier`	`whenHasName(java.lang.String name)` Limit this supplier so that it's only called if the Cookie has the given name.
`default CookieSameSiteSupplier`	`whenHasName(java.util.function.Supplier<java.lang.String> nameSupplier)` Limit this supplier so that it's only called if the Cookie has the given name.
`default CookieSameSiteSupplier`	`whenHasNameMatching(java.util.regex.Pattern pattern)` Limit this supplier so that it's only called if the Cookie name matches the given `Pattern`.
`default CookieSameSiteSupplier`	`whenHasNameMatching(java.lang.String regex)` Limit this supplier so that it's only called if the Cookie name matches the given regex.

- Method Detail
  - getSameSite
```
Cookie.SameSite getSameSite(javax.servlet.http.Cookie cookie)
```
    Get the Cookie.SameSite values that should be used for the given Cookie.
    
    Parameters:
    
    cookie - the cookie to check
    
    Returns:
    
    the Cookie.SameSite value to use or null if the next supplier should be checked
  - whenHasName
```
default CookieSameSiteSupplier whenHasName(java.lang.String name)
```
    Limit this supplier so that it's only called if the Cookie has the given name.
    
    Parameters:
    
    name - the name to check
    
    Returns:
    
    a new CookieSameSiteSupplier that only calls this supplier when the name matches
  - whenHasName
```
default CookieSameSiteSupplier whenHasName(java.util.function.Supplier<java.lang.String> nameSupplier)
```
    Limit this supplier so that it's only called if the Cookie has the given name.
    
    Parameters:
    
    nameSupplier - a supplier providing the name to check
    
    Returns:
    
    a new CookieSameSiteSupplier that only calls this supplier when the name matches
  - whenHasNameMatching
```
default CookieSameSiteSupplier whenHasNameMatching(java.lang.String regex)
```
    Limit this supplier so that it's only called if the Cookie name matches the given regex.
    
    Parameters:
    
    regex - the regex pattern that must match
    
    Returns:
    
    a new CookieSameSiteSupplier that only calls this supplier when the name matches the regex
  - whenHasNameMatching
```
default CookieSameSiteSupplier whenHasNameMatching(java.util.regex.Pattern pattern)
```
    Limit this supplier so that it's only called if the Cookie name matches the given Pattern.
    
    Parameters:
    
    pattern - the regex pattern that must match
    
    Returns:
    
    a new CookieSameSiteSupplier that only calls this supplier when the name matches the pattern
  - when
```
default CookieSameSiteSupplier when(java.util.function.Predicate<javax.servlet.http.Cookie> predicate)
```
    Limit this supplier so that it's only called if the predicate accepts the Cookie.
    
    Parameters:
    
    predicate - the predicate used to match the cookie
    
    Returns:
    
    a new CookieSameSiteSupplier that only calls this supplier when the cookie matches the predicate
  - ofNone
```
static CookieSameSiteSupplier ofNone()
```
    Return a new CookieSameSiteSupplier that always returns Cookie.SameSite.NONE.
    
    Returns:
    
    the supplier instance
  - ofLax
```
static CookieSameSiteSupplier ofLax()
```
    Return a new CookieSameSiteSupplier that always returns Cookie.SameSite.LAX.
    
    Returns:
    
    the supplier instance
  - ofStrict
```
static CookieSameSiteSupplier ofStrict()
```
    Return a new CookieSameSiteSupplier that always returns Cookie.SameSite.STRICT.
    
    Returns:
    
    the supplier instance
  - of
```
static CookieSameSiteSupplier of(Cookie.SameSite sameSite)
```
    Return a new CookieSameSiteSupplier that always returns the given Cookie.SameSite value.
    
    Parameters:
    
    sameSite - the value to return
    
    Returns:
    
    the supplier instance

Interface CookieSameSiteSupplier

Method Summary

Method Detail

getSameSite

whenHasName

whenHasName

whenHasNameMatching

whenHasNameMatching

when

ofNone

ofLax

ofStrict

of