Enum Class HttpCookieHandling

java.lang.Object

java.lang.Enum<HttpCookieHandling>

org.springframework.boot.http.client.HttpCookieHandling

All Implemented Interfaces:

Serializable, Comparable<HttpCookieHandling>, Constable

public enum HttpCookieHandling
extends Enum<HttpCookieHandling>

Cookie handling strategies supported by HTTP clients.

Since:

4.1.0

Author:

Apoorv Darshan

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLE	Disable cookie handling (fail if the underlying library has no support).
ENABLE	Enable cookie handling (fail if the underlying library has no support).
ENABLE_WHEN_POSSIBLE	Enable cookie handling (if the underlying library has support).

Method Summary

Modifier and Type	Method	Description
static HttpCookieHandling	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HttpCookieHandling[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENABLE_WHEN_POSSIBLE

public static final HttpCookieHandling ENABLE_WHEN_POSSIBLE

Enable cookie handling (if the underlying library has support). When enabled, cookies received in a response are stored and automatically included in subsequent matching requests.

ENABLE

public static final HttpCookieHandling ENABLE

Enable cookie handling (fail if the underlying library has no support). When enabled, cookies received in a response are stored and automatically included in subsequent matching requests.

DISABLE

public static final HttpCookieHandling DISABLE

Disable cookie handling (fail if the underlying library has no support).

Method Details

values

public static HttpCookieHandling[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HttpCookieHandling valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null