com.broadleafcommerce.cartoperation.web.autoconfigure

Class CartCookieProperties

java.lang.Object

com.broadleafcommerce.cartoperation.web.autoconfigure.CartCookieProperties

@Validated
 @ConfigurationProperties(value="broadleaf.cartoperation.cart-cookie")
public class CartCookieProperties
extends Object

Author:

Phillip Verheyden (phillipuniverse), Jeff Fischer, Chris Kittrell (ckittrell)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CartCookieProperties.Jwt

Constructor Summary

Constructors

Constructor and Description
CartCookieProperties()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Duration	getCartTtl() Specifies how long the cart cookie should be considered active.
String	getCookieName() Name of the cart cookie.
String	getCookieSameSiteValue() The value to use for the SameSite attribute on the cart cookie.
CartCookieProperties.Jwt	getJwt()
int	hashCode()
boolean	isApplicationIdIncludedInCookieName() Whether or not the applicationId should be appended to the cart cookie name.
void	setApplicationIdIncludedInCookieName(boolean applicationIdIncludedInCookieName) Whether or not the applicationId should be appended to the cart cookie name.
void	setCartTtl(Duration cartTtl) Specifies how long the cart cookie should be considered active.
void	setCookieName(String cookieName) Name of the cart cookie.
void	setCookieSameSiteValue(String cookieSameSiteValue) The value to use for the SameSite attribute on the cart cookie.
void	setJwt(CartCookieProperties.Jwt jwt)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CartCookieProperties

public CartCookieProperties()

Method Detail

getCookieName

public String getCookieName()

Name of the cart cookie. If applicationIdIncludedInCookieName is true, then the provided applicationId will be appended to the end of the cookie name.

getCookieSameSiteValue

public String getCookieSameSiteValue()

The value to use for the SameSite attribute on the cart cookie. Can be "None", "Lax", or "Strict".

isApplicationIdIncludedInCookieName

public boolean isApplicationIdIncludedInCookieName()

Whether or not the applicationId should be appended to the cart cookie name. This should be used if the cookies of different applications cannot be distinguished by their domain. For example, if a request param is used to resolve the application, then the cookies will be accessible via the same domain and therefore it's required that the application id is appended to the cookie name so that we can resolve the correct cart for that application.

getCartTtl

public Duration getCartTtl()

Specifies how long the cart cookie should be considered active.

getJwt

public CartCookieProperties.Jwt getJwt()

setCookieName

public void setCookieName(String cookieName)

Name of the cart cookie. If applicationIdIncludedInCookieName is true, then the provided applicationId will be appended to the end of the cookie name.

setCookieSameSiteValue

public void setCookieSameSiteValue(String cookieSameSiteValue)

The value to use for the SameSite attribute on the cart cookie. Can be "None", "Lax", or "Strict".

setApplicationIdIncludedInCookieName

public void setApplicationIdIncludedInCookieName(boolean applicationIdIncludedInCookieName)

Whether or not the applicationId should be appended to the cart cookie name. This should be used if the cookies of different applications cannot be distinguished by their domain. For example, if a request param is used to resolve the application, then the cookies will be accessible via the same domain and therefore it's required that the application id is appended to the cookie name so that we can resolve the correct cart for that application.

setCartTtl

public void setCartTtl(Duration cartTtl)

Specifies how long the cart cookie should be considered active.

setJwt

public void setJwt(CartCookieProperties.Jwt jwt)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object