Class CookieCompliance

java.lang.Object

org.eclipse.jetty.http.CookieCompliance

All Implemented Interfaces:

ComplianceViolation.Mode

public class CookieCompliance
extends Object
implements ComplianceViolation.Mode

The compliance mode for Cookie handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CookieCompliance.Violation

Field Summary

Fields

Modifier and Type	Field	Description
static final CookieCompliance	RFC2965	A CookieCompliance mode that allows RFC 2965 compliance but does not allow: CookieCompliance.Violation.BAD_QUOTES CookieCompliance.Violation.RESERVED_NAMES_NOT_DOLLAR_PREFIXED
static final CookieCompliance	RFC2965_LEGACY	A CookieCompliance mode that allows RFC 2965 compliance, but with exceptions that match the behavior of legacy Jetty releases.
static final CookieCompliance	RFC6265	A CookieCompliance mode that enforces RFC 6265 compliance, but allows:
static final CookieCompliance	RFC6265_LEGACY	A CookieCompliance mode that enforces RFC 6265 compliance, but allows:
static final CookieCompliance	RFC6265_STRICT	A CookieCompliance mode that enforces RFC 6265 compliance.

Constructor Summary

Constructors

Constructor	Description
CookieCompliance(String name, Set<CookieCompliance.Violation> violations)

Method Summary

Modifier and Type	Method	Description
boolean	allows(ComplianceViolation violation)
boolean	compliesWith(CookieCompliance mode)
static CookieCompliance	from(String spec)	Create compliance set from string.
Set<CookieCompliance.Violation>	getAllowed()
Set<CookieCompliance.Violation>	getKnown()
String	getName()
String	toString()
static CookieCompliance	valueOf(String name)

Methods inherited from class Object

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

Field Details

RFC6265

public static final CookieCompliance RFC6265

A CookieCompliance mode that enforces RFC 6265 compliance, but allows:

• CookieCompliance.Violation.INVALID_COOKIES
• CookieCompliance.Violation.OPTIONAL_WHITE_SPACE
• CookieCompliance.Violation.SPACE_IN_VALUES

RFC6265_STRICT

public static final CookieCompliance RFC6265_STRICT

A CookieCompliance mode that enforces RFC 6265 compliance.

RFC6265_LEGACY

public static final CookieCompliance RFC6265_LEGACY

A CookieCompliance mode that enforces RFC 6265 compliance, but allows:

• CookieCompliance.Violation.ATTRIBUTES
• CookieCompliance.Violation.BAD_QUOTES
• CookieCompliance.Violation.ESCAPE_IN_QUOTES
• CookieCompliance.Violation.INVALID_COOKIES
• CookieCompliance.Violation.OPTIONAL_WHITE_SPACE
• CookieCompliance.Violation.SPECIAL_CHARS_IN_QUOTES
• CookieCompliance.Violation.SPACE_IN_VALUES

RFC2965_LEGACY

public static final CookieCompliance RFC2965_LEGACY

A CookieCompliance mode that allows RFC 2965 compliance, but with exceptions that match the behavior of legacy Jetty releases.

RFC2965

public static final CookieCompliance RFC2965

A CookieCompliance mode that allows RFC 2965 compliance but does not allow:

• CookieCompliance.Violation.BAD_QUOTES
• CookieCompliance.Violation.RESERVED_NAMES_NOT_DOLLAR_PREFIXED

Constructor Details

CookieCompliance

public CookieCompliance(String name,
 Set<CookieCompliance.Violation> violations)

Method Details

valueOf

public static CookieCompliance valueOf(String name)

from

public static CookieCompliance from(String spec)

Create compliance set from string.

Format: <BASE>[,[-]<violation>]...

BASE is one of:

0

No CookieCompliance.Violations

*

All CookieCompliance.Violations

<name>

The name of a static instance of CookieCompliance (e.g. RFC6265).

The remainder of the list can contain then names of CookieCompliance.Violations to include them in the mode, or prefixed with a '-' to exclude them from the mode. Examples are:

0,ESCAPE_IN_QUOTES

Only allow CookieCompliance.Violation.ESCAPE_IN_QUOTES

*,-ESCAPE_IN_QUOTES

Allow all violations, except CookieCompliance.Violation.ESCAPE_IN_QUOTES

RFC2965,ESCAPE_IN_QUOTES

Same as RFC2965, but allows CookieCompliance.Violation.ESCAPE_IN_QUOTES

Parameters:

spec - A string describing the compliance

Returns:

the compliance from the string spec

allows

public boolean allows(ComplianceViolation violation)

Specified by:

allows in interface ComplianceViolation.Mode

Parameters:

violation - The ComplianceViolation to test

Returns:

true iff the violation is allowed by this mode.

getName

public String getName()

Specified by:

getName in interface ComplianceViolation.Mode

Returns:

The name of the compliance violation mode.

getKnown

public Set<CookieCompliance.Violation> getKnown()

Specified by:

getKnown in interface ComplianceViolation.Mode

Returns:

The immutable set of all known violations for this mode.

getAllowed

public Set<CookieCompliance.Violation> getAllowed()

Specified by:

getAllowed in interface ComplianceViolation.Mode

Returns:

The immutable set of violations allowed by this mode.

compliesWith

public boolean compliesWith(CookieCompliance mode)

toString

public String toString()

Overrides:

toString in class Object