Class ComplianceUtils

java.lang.Object

org.eclipse.jetty.http.ComplianceUtils

public final class ComplianceUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
ComplianceUtils()

Method Summary

Modifier and Type	Method	Description
static boolean	allows(ComplianceViolation.Mode compliance, ComplianceViolation violation, String detail, ComplianceViolation.Listener complianceListener)	Check that the ComplianceViolation is allowed per the provided ComplianceViolation.Mode.
static boolean	allows(ComplianceViolation.Mode compliance, ComplianceViolation violation, ComplianceViolation.Listener complianceListener)	Check that the ComplianceViolation is allowed per the provided ComplianceViolation.Mode.
static void	notify(ComplianceViolation.Listener complianceListener, ComplianceViolation.Event event)
static void	verify(HttpCompliance httpCompliance, MetaData.Request request, ComplianceViolation.Listener listener)	Deprecated, for removal: This API element is subject to removal in a future version. use verify(HttpURI, HttpFields, HttpCompliance, ComplianceViolation.Listener) instead, as this method works on MetaData.Request values that may be changed by request customizers.
static void	verify(HttpURI httpURI, HttpFields requestHeaders, HttpCompliance httpCompliance, ComplianceViolation.Listener listener)	Check the provided HttpURI and request headers against configured HttpCompliance.
static <T extends Throwable> void	verify(UriCompliance uriCompliance, HttpURI uri, ComplianceViolation.Listener listener, Function<String,T> error)	Verify that the HttpURI has no UriCompliance violations..

Methods inherited from class Object

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

Constructor Details

ComplianceUtils

public ComplianceUtils()

Method Details

allows

public static boolean allows(ComplianceViolation.Mode compliance,
 ComplianceViolation violation,
 ComplianceViolation.Listener complianceListener)

Check that the ComplianceViolation is allowed per the provided ComplianceViolation.Mode.

If a ComplianceViolation.Listener is provided, notify it of the check.

It is assumed that if you are calling this method, a violation has been detected. The purpose of this method is to check if it is allowed, and also notify that the violation was detected (along with the details and allowed state).

Parameters:

compliance - the compliance mode

violation - the violation

complianceListener - the listener to notify (can be null)

Returns:

true if violation is allowed per the configured compliance.

allows

public static boolean allows(ComplianceViolation.Mode compliance,
 ComplianceViolation violation,
 String detail,
 ComplianceViolation.Listener complianceListener)

Check that the ComplianceViolation is allowed per the provided ComplianceViolation.Mode.

If a ComplianceViolation.Listener is provided, notify it of the check.

It is assumed that if you are calling this method, a violation has been detected. The purpose of this method is to check if it is allowed, and also notify that the violation was detected (along with the details and allowed state).

Parameters:

compliance - the compliance mode

violation - the violation

detail - the detail of the violation

complianceListener - the listener to notify (can be null)

Returns:

true if violation is allowed per the configured compliance.

notify

public static void notify(ComplianceViolation.Listener complianceListener,
 ComplianceViolation.Event event)

verify

public static <T extends Throwable> void verify(UriCompliance uriCompliance,
 HttpURI uri,
 ComplianceViolation.Listener listener,
 Function<String,T> error)
                                         throws T

Verify that the HttpURI has no UriCompliance violations..

Type Parameters:

T - the type of Throwable

Parameters:

uriCompliance - the configured UriCompliance to apply

uri - the HttpURI to check for violations

listener - the listener to report to

error - the function to produce a Throwable if not allowed

Throws:

T - Throwable if not allowed

verify

@Deprecated(since="12.1.9",
            forRemoval=true)
public static void verify(HttpCompliance httpCompliance,
 MetaData.Request request,
 ComplianceViolation.Listener listener)

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

use verify(HttpURI, HttpFields, HttpCompliance, ComplianceViolation.Listener) instead, as this method works on MetaData.Request values that may be changed by request customizers.

Check the provided Request against configured HttpCompliance.

Parameters:

httpCompliance - the HttpCompliance to use.

request - the request to check

listener - the notification method for violations. (Tip: use the Request specific Listener from the HttpChannelState)

Throws:

HttpException.RuntimeException - if there is a violation that wasn't allowed

verify

public static void verify(HttpURI httpURI,
 HttpFields requestHeaders,
 HttpCompliance httpCompliance,
 ComplianceViolation.Listener listener)

Check the provided HttpURI and request headers against configured HttpCompliance.

Parameters:

httpURI - the request HttpURI

requestHeaders - the request headers

httpCompliance - the HttpCompliance to use

listener - the violation listener to notify