Class MultiPartCompliance

java.lang.Object

org.eclipse.jetty.http.MultiPartCompliance

All Implemented Interfaces:

ComplianceViolation.Mode

public class MultiPartCompliance
extends Object
implements ComplianceViolation.Mode

The compliance mode for MultiPart handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MultiPartCompliance.Violation

Field Summary

Fields

Modifier and Type	Field	Description
static final MultiPartCompliance	LEGACY	Legacy multiPart/form-data parsing which is slow, buggy, but forgiving to a fault.
static final MultiPartCompliance	RFC7578	RFC7578 multiPart/form-data compliant parsing lenient to LF EOL and Content-Transfer-Encoding.
static final MultiPartCompliance	RFC7578_STRICT	Strict (RFC7578) multiPart/form-data compliant strict parsing.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	allows(ComplianceViolation violation)
static MultiPartCompliance	from(String spec)	Create compliance set from string.
static MultiPartCompliance	from(Set<MultiPartCompliance.Violation> violations)	Create compliance set from a set of allowed Violations.
Set<MultiPartCompliance.Violation>	getAllowed()
Set<MultiPartCompliance.Violation>	getKnown()
String	getName()
String	toString()
static MultiPartCompliance	valueOf(String name)

Methods inherited from class Object

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

Field Details

RFC7578_STRICT

public static final MultiPartCompliance RFC7578_STRICT

Strict (RFC7578) multiPart/form-data compliant strict parsing.

RFC7578

public static final MultiPartCompliance RFC7578

RFC7578 multiPart/form-data compliant parsing lenient to LF EOL and Content-Transfer-Encoding.

LEGACY

public static final MultiPartCompliance LEGACY

Legacy multiPart/form-data parsing which is slow, buggy, but forgiving to a fault. This mode is not recommended for websites on the public internet. It will accept non-compliant preambles and inconsistent line termination that are in violation of RFC7578.

Constructor Details

MultiPartCompliance

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

Method Details

valueOf

public static MultiPartCompliance valueOf(String name)

from

public static MultiPartCompliance from(Set<MultiPartCompliance.Violation> violations)

Create compliance set from a set of allowed Violations.

Parameters:

violations - A string of violations to allow:

Returns:

the compliance from the string spec

from

public static MultiPartCompliance from(String spec)

Create compliance set from string.

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

BASE is one of:

0

No MultiPartCompliance.Violations

*

All MultiPartCompliance.Violations

<name>

The name of a static instance of MultiPartCompliance (e.g. LEGACY).

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

0,CONTENT_TRANSFER_ENCODING

Only allow MultiPartCompliance.Violation.CONTENT_TRANSFER_ENCODING

*,-BASE64_TRANSFER_ENCODING

Only all except MultiPartCompliance.Violation.BASE64_TRANSFER_ENCODING

LEGACY,BASE64_TRANSFER_ENCODING

Same as LEGACY plus MultiPartCompliance.Violation.BASE64_TRANSFER_ENCODING

Parameters:

spec - A string describing the compliance

Returns:

the MultiPartCompliance instance derived from the string description

getName

public String getName()

Specified by:

getName in interface ComplianceViolation.Mode

Returns:

The name of the compliance violation mode.

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.

getKnown

public Set<MultiPartCompliance.Violation> getKnown()

Specified by:

getKnown in interface ComplianceViolation.Mode

Returns:

The immutable set of all known violations for this mode.

getAllowed

public Set<MultiPartCompliance.Violation> getAllowed()

Specified by:

getAllowed in interface ComplianceViolation.Mode

Returns:

The immutable set of violations allowed by this mode.

toString

public String toString()

Overrides:

toString in class Object