Class HttpCompliance

java.lang.Object

org.eclipse.jetty.http.HttpCompliance

All Implemented Interfaces:

ComplianceViolation.Mode

public final class HttpCompliance
extends Object
implements ComplianceViolation.Mode

HTTP compliance modes for Jetty HTTP parsing and handling. A Compliance mode consists of a set of HttpCompliance.Violations which are applied when the mode is enabled.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HttpCompliance.Violation

Field Summary

Fields

Modifier and Type	Field	Description
static final HttpCompliance	LEGACY	A legacy HttpCompliance mode that allows all violations except case-insensitive methods.
static final HttpCompliance	RFC2616	The HttpCompliance mode that supports RFC 7230 with only the violations that differ from RFC7230.
static final HttpCompliance	RFC2616_LEGACY	A legacy HttpCompliance mode that supports RFC2616, but that also allows: case-insensitive methods; colons after field names; Transfer-Encoding with Content-Length fields; and multiple Content-Length values.
static final HttpCompliance	RFC7230	The HttpCompliance mode that supports RFC 7230 with no known violations.
static final HttpCompliance	RFC7230_LEGACY	A legacy HttpCompliance mode that supports RFC7230, but with case-insensitive methods allowed.
static final String	VIOLATIONS_ATTR	Deprecated, for removal: This API element is subject to removal in a future version. use ComplianceViolation.CapturingListener.VIOLATIONS_ATTR_KEY instead. (Note: new ATTR captures all Compliance violations, not just HTTP. Make sure you have HttpConnectionFactory.setRecordHttpComplianceViolations(true). Also make sure that a ComplianceViolation.CapturingListener has been added as a bean to either the Connector or Server for the Attribute to be created.)

Method Summary

Modifier and Type	Method	Description
boolean	allows(ComplianceViolation violation)
static void	checkHttpCompliance(MetaData.Request request, HttpCompliance mode, ComplianceViolation.Listener listener)
static HttpCompliance	from(String spec)	Create compliance mode from a String description.
Set<HttpCompliance.Violation>	getAllowed()
Set<HttpCompliance.Violation>	getKnown()
String	getName()
String	toString()
static HttpCompliance	valueOf(String name)	Get a known compliance mode by name.
HttpCompliance	with(String name, HttpCompliance.Violation... violations)	Create a new HttpCompliance mode that includes the passed HttpCompliance.Violations.
HttpCompliance	without(String name, HttpCompliance.Violation... violations)	Create a new HttpCompliance mode that excludes the passed HttpCompliance.Violations.

Methods inherited from class Object

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

Field Details

VIOLATIONS_ATTR

@Deprecated(since="12.0.6",
            forRemoval=true)
public static final String VIOLATIONS_ATTR

Deprecated, for removal: This API element is subject to removal in a future version.

use ComplianceViolation.CapturingListener.VIOLATIONS_ATTR_KEY instead.
(Note: new ATTR captures all Compliance violations, not just HTTP.
Make sure you have HttpConnectionFactory.setRecordHttpComplianceViolations(true).
Also make sure that a ComplianceViolation.CapturingListener has been added as a bean to either the Connector or Server for the Attribute to be created.)

The request attribute which may be set to record any allowed HTTP violations.

See Also:

• Constant Field Values

RFC7230

public static final HttpCompliance RFC7230

The HttpCompliance mode that supports RFC 7230 with no known violations.

RFC2616

public static final HttpCompliance RFC2616

The HttpCompliance mode that supports RFC 7230 with only the violations that differ from RFC7230.

LEGACY

public static final HttpCompliance LEGACY

A legacy HttpCompliance mode that allows all violations except case-insensitive methods.

RFC2616_LEGACY

public static final HttpCompliance RFC2616_LEGACY

A legacy HttpCompliance mode that supports RFC2616, but that also allows: case-insensitive methods; colons after field names; Transfer-Encoding with Content-Length fields; and multiple Content-Length values.

RFC7230_LEGACY

public static final HttpCompliance RFC7230_LEGACY

A legacy HttpCompliance mode that supports RFC7230, but with case-insensitive methods allowed.

Method Details

valueOf

public static HttpCompliance valueOf(String name)

Get a known compliance mode by name.

Parameters:

name - The name of a known HttpCompliance mode.

Returns:

The mode matching the name.

from

public static HttpCompliance from(String spec)

Create compliance mode from a String description.

Format:

0

No HttpCompliance.Violations

*

All HttpCompliance.Violations

RFC2616

The set of HttpCompliance.Violations application to RFC2616, but not RFC7230

RFC7230

The set of HttpCompliance.Violations application to RFC7230

name

Any of the known modes defined in KNOWN_MODES

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

Parameters:

spec - A string describing the compliance

Returns:

the HttpCompliance instance derived from the string description

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.

getAllowed

public Set<HttpCompliance.Violation> getAllowed()

Specified by:

getAllowed in interface ComplianceViolation.Mode

Returns:

The immutable set of violations allowed by this mode.

getKnown

public Set<HttpCompliance.Violation> getKnown()

Specified by:

getKnown in interface ComplianceViolation.Mode

Returns:

The immutable set of all known violations for this mode.

with

public HttpCompliance with(String name,
 HttpCompliance.Violation... violations)

Create a new HttpCompliance mode that includes the passed HttpCompliance.Violations.

Parameters:

name - The name of the new mode

violations - The violations to include

Returns:

A new HttpCompliance mode.

without

public HttpCompliance without(String name,
 HttpCompliance.Violation... violations)

Create a new HttpCompliance mode that excludes the passed HttpCompliance.Violations.

Parameters:

name - The name of the new mode

violations - The violations to exclude

Returns:

A new HttpCompliance mode.

toString

public String toString()

Overrides:

toString in class Object

checkHttpCompliance

public static void checkHttpCompliance(MetaData.Request request,
 HttpCompliance mode,
 ComplianceViolation.Listener listener)