Package org.eclipse.jetty.http

Interface ComplianceViolation

All Known Implementing Classes:

CookieCompliance.Violation, HttpCompliance.Violation, MultiPartCompliance.Violation, UriCompliance.Violation

public interface ComplianceViolation

A Compliance Violation represents a requirement of an RFC, specification or Jetty implementation that may be allowed to be violated if it is included in a ComplianceViolation.Mode. For example, supporting HTTP/0.9 is no longer a requirement of the current HTTP RFC, so by including the HttpCompliance.Violation.HTTP_0_9 in the HttpCompliance ComplianceViolation.Mode is interpreted as allowing HTTP/0.9 to be supported.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ComplianceViolation.CapturingListener
static final record	ComplianceViolation.Event
static interface	ComplianceViolation.Listener	A listener that can be notified of violations.
static class	ComplianceViolation.LoggingListener
static interface	ComplianceViolation.Mode	A Mode is a set of ComplianceViolations that are allowed.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getName()
String	getURL()
default boolean	isAllowedBy(ComplianceViolation.Mode mode)

Method Details

getName

String getName()

Returns:

The name of the violation.

getURL

String getURL()

Returns:

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

getDescription

String getDescription()

Returns:

A short description of the violation.

isAllowedBy

default boolean isAllowedBy(ComplianceViolation.Mode mode)

Parameters:

mode - A ComplianceViolation.Mode to test against

Returns:

True iff this violations is allowed by the mode.