Package org.apache.camel.component.platform.http.cookie

Class CookieConfiguration

java.lang.Object

org.apache.camel.component.platform.http.cookie.CookieConfiguration

@UriParams
@Configurer(extended=true)
public class CookieConfiguration
extends Object

Attributes that are set when creating Cookies.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CookieConfiguration.Builder
static enum	CookieConfiguration.CookieSameSite	The Cookie SameSite policy that declares whether a Cookie should be sent with cross-site requests.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_HTTP_ONLY_FLAG
static final String	DEFAULT_PATH
static final CookieConfiguration.CookieSameSite	DEFAULT_SAME_SITE
static final boolean	DEFAULT_SECURE_FLAG

Constructor Summary

Constructors

Constructor	Description
CookieConfiguration()
CookieConfiguration(String cookiePath, String cookieDomain, Long cookieMaxAge, boolean cookieSecure, boolean cookieHttpOnly, CookieConfiguration.CookieSameSite cookieSameSite)

Method Summary

Modifier and Type	Method	Description
String	getCookieDomain()
Long	getCookieMaxAge()
String	getCookiePath()
CookieConfiguration.CookieSameSite	getCookieSameSite()
boolean	isCookieHttpOnly()
boolean	isCookieSecure()
void	setCookieDomain(String cookieDomain)	Sets which server can receive cookies.
void	setCookieHttpOnly(boolean cookieHttpOnly)	Sets whether to prevent client side scripts from accessing created cookies.
void	setCookieMaxAge(Long cookieMaxAge)	Sets the maximum cookie age in seconds.
void	setCookiePath(String cookiePath)	Sets the URL path that must exist in the requested URL in order to send the Cookie.
void	setCookieSameSite(CookieConfiguration.CookieSameSite cookieSameSite)	Sets whether to prevent the browser from sending cookies along with cross-site requests.
void	setCookieSecure(boolean cookieSecure)	Sets whether the cookie is only sent to the server with an encrypted request over HTTPS.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PATH

public static final String DEFAULT_PATH

See Also:

• Constant Field Values

DEFAULT_SECURE_FLAG

public static final boolean DEFAULT_SECURE_FLAG

See Also:

• Constant Field Values

DEFAULT_HTTP_ONLY_FLAG

public static final boolean DEFAULT_HTTP_ONLY_FLAG

See Also:

• Constant Field Values

DEFAULT_SAME_SITE

public static final CookieConfiguration.CookieSameSite DEFAULT_SAME_SITE

Constructor Details

CookieConfiguration

public CookieConfiguration()

CookieConfiguration

public CookieConfiguration(String cookiePath,
 String cookieDomain,
 Long cookieMaxAge,
 boolean cookieSecure,
 boolean cookieHttpOnly,
 CookieConfiguration.CookieSameSite cookieSameSite)

Method Details

setCookiePath

public void setCookiePath(String cookiePath)

Sets the URL path that must exist in the requested URL in order to send the Cookie.

getCookiePath

public String getCookiePath()

setCookieDomain

public void setCookieDomain(String cookieDomain)

Sets which server can receive cookies.

getCookieDomain

public String getCookieDomain()

setCookieMaxAge

public void setCookieMaxAge(Long cookieMaxAge)

Sets the maximum cookie age in seconds.

getCookieMaxAge

public Long getCookieMaxAge()

setCookieSecure

public void setCookieSecure(boolean cookieSecure)

Sets whether the cookie is only sent to the server with an encrypted request over HTTPS.

isCookieSecure

public boolean isCookieSecure()

setCookieHttpOnly

public void setCookieHttpOnly(boolean cookieHttpOnly)

Sets whether to prevent client side scripts from accessing created cookies.

isCookieHttpOnly

public boolean isCookieHttpOnly()

setCookieSameSite

public void setCookieSameSite(CookieConfiguration.CookieSameSite cookieSameSite)

Sets whether to prevent the browser from sending cookies along with cross-site requests.

getCookieSameSite

public CookieConfiguration.CookieSameSite getCookieSameSite()