Module org.eclipse.jetty.http

Package org.eclipse.jetty.http

Enum Class CookieCompliance.Violation

java.lang.Object

java.lang.Enum<CookieCompliance.Violation>

org.eclipse.jetty.http.CookieCompliance.Violation

All Implemented Interfaces:

Serializable, Comparable<CookieCompliance.Violation>, Constable, ComplianceViolation

Enclosing class:

CookieCompliance

public static enum CookieCompliance.Violation
extends Enum<CookieCompliance.Violation>
implements ComplianceViolation

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.eclipse.jetty.http.ComplianceViolation

ComplianceViolation.CapturingListener, ComplianceViolation.Event, ComplianceViolation.Listener, ComplianceViolation.LoggingListener, ComplianceViolation.Mode

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTRIBUTE_VALUES	A cookie attribute value was found and its value is retained.
ATTRIBUTES	A cookie attribute was found.
BAD_QUOTES	Quotes are not balanced or are embedded in value.
COMMA_NOT_VALID_OCTET	Deprecated. Use SPECIAL_CHARS_IN_QUOTES
COMMA_SEPARATOR	A comma was found as separator between cookies.
ESCAPE_IN_QUOTES	A backslash was found in a quoted cookie value.
INVALID_COOKIES	An invalid cookie was found, without a more specific violation.
OPTIONAL_WHITE_SPACE	Whitespace was found around the cookie name and/or around the cookie value.
RESERVED_NAMES_NOT_DOLLAR_PREFIXED	Deprecated. no replacement because was mistakenly considered a violation
SPACE_IN_VALUES	Allow spaces within values without quotes.
SPECIAL_CHARS_IN_QUOTES	Special characters were found in a quoted cookie value.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.http.ComplianceViolation

isAllowedBy

Enum Constant Details

COMMA_NOT_VALID_OCTET

@Deprecated
public static final CookieCompliance.Violation COMMA_NOT_VALID_OCTET

Deprecated.

Use SPECIAL_CHARS_IN_QUOTES

A comma was found in a cookie value.

COMMA_SEPARATOR

public static final CookieCompliance.Violation COMMA_SEPARATOR

A comma was found as separator between cookies.

RESERVED_NAMES_NOT_DOLLAR_PREFIXED

@Deprecated
public static final CookieCompliance.Violation RESERVED_NAMES_NOT_DOLLAR_PREFIXED

Deprecated.

no replacement because was mistakenly considered a violation

SPECIAL_CHARS_IN_QUOTES

public static final CookieCompliance.Violation SPECIAL_CHARS_IN_QUOTES

Special characters were found in a quoted cookie value.

ESCAPE_IN_QUOTES

public static final CookieCompliance.Violation ESCAPE_IN_QUOTES

A backslash was found in a quoted cookie value.

BAD_QUOTES

public static final CookieCompliance.Violation BAD_QUOTES

Quotes are not balanced or are embedded in value.

INVALID_COOKIES

public static final CookieCompliance.Violation INVALID_COOKIES

An invalid cookie was found, without a more specific violation. When this violation is not allowed, an exception is thrown.

ATTRIBUTES

public static final CookieCompliance.Violation ATTRIBUTES

A cookie attribute was found. The attribute value is retained only if ATTRIBUTE_VALUES is allowed.

ATTRIBUTE_VALUES

public static final CookieCompliance.Violation ATTRIBUTE_VALUES

A cookie attribute value was found and its value is retained. Allowing ATTRIBUTE_VALUE implies allowing ATTRIBUTES.

OPTIONAL_WHITE_SPACE

public static final CookieCompliance.Violation OPTIONAL_WHITE_SPACE

Whitespace was found around the cookie name and/or around the cookie value.

SPACE_IN_VALUES

public static final CookieCompliance.Violation SPACE_IN_VALUES

Allow spaces within values without quotes.

Method Details

values

public static CookieCompliance.Violation[] 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 CookieCompliance.Violation 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

getName

public String getName()

Specified by:

getName in interface ComplianceViolation

Returns:

The name of the violation.

getURL

public String getURL()

Specified by:

getURL in interface ComplianceViolation

Returns:

A URL to the specification that provides more information regarding the requirement that may be violated.

getDescription

public String getDescription()

Specified by:

getDescription in interface ComplianceViolation

Returns:

A short description of the violation.