com.fireflysource.net.http.common.model.HttpCompliance Maven / Gradle / Ivy
package com.fireflysource.net.http.common.model;
import com.fireflysource.common.slf4j.LazyLogger;
import com.fireflysource.common.sys.SystemLogger;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.Map;
/**
* HTTP compliance modes for HTTP parsing and handling.
* A Compliance mode consists of a set of {@link HttpComplianceSection}s which are applied
* when the mode is enabled.
*
* Currently the set of modes is an enum and cannot be dynamically extended, but future major releases may convert this
* to a class. To modify modes there are four custom modes that can be modified by setting the property
* HttpCompliance.CUSTOMn (where 'n' is '0', '1', '2' or '3'), to a comma separated
* list of sections. The list should start with one of the following strings:
* - 0
- No {@link HttpComplianceSection}s
* - *
- All {@link HttpComplianceSection}s
* - RFC2616
- The set of {@link HttpComplianceSection}s application to https://tools.ietf.org/html/rfc2616,
* but not https://tools.ietf.org/html/rfc7230
* - RFC7230
- The set of {@link HttpComplianceSection}s application to https://tools.ietf.org/html/rfc7230
*
* The remainder of the list can contain then names of {@link HttpComplianceSection}s to include them in the mode, or prefixed
* with a '-' to exclude thm from the mode. Note that modes may have some historic minor differences from the strict
* RFC compliance, for example the RFC2616_LEGACY HttpCompliance is defined as
* RFC2616,-FIELD_COLON,-METHOD_CASE_SENSITIVE.
*
* Note also that the {@link EnumSet} return by {@link HttpCompliance#sections()} is mutable, so that modes may
* be altered in code and will affect all usages of the mode.
*/
public enum HttpCompliance {
LEGACY(sectionsBySpec("0,METHOD_CASE_SENSITIVE")),
/**
* The legacy RFC2616 support, which incorrectly excludes
* {@link HttpComplianceSection#METHOD_CASE_SENSITIVE},
* {@link HttpComplianceSection#FIELD_COLON},
* {@link HttpComplianceSection#TRANSFER_ENCODING_WITH_CONTENT_LENGTH},
* {@link HttpComplianceSection#MULTIPLE_CONTENT_LENGTHS},
*/
RFC2616_LEGACY(sectionsBySpec("RFC2616,-FIELD_COLON,-METHOD_CASE_SENSITIVE,-TRANSFER_ENCODING_WITH_CONTENT_LENGTH,-MULTIPLE_CONTENT_LENGTHS")),
/**
* The strict RFC2616 support mode
*/
RFC2616(sectionsBySpec("RFC2616")),
/**
* RFC7230 support, which incorrectly excludes {@link HttpComplianceSection#METHOD_CASE_SENSITIVE}
*/
RFC7230_LEGACY(sectionsBySpec("RFC7230,-METHOD_CASE_SENSITIVE")),
/**
* The RFC7230 support mode
*/
RFC7230(sectionsBySpec("RFC7230")),
@Deprecated
CUSTOM0(sectionsByProperty("CUSTOM0")),
@Deprecated
CUSTOM1(sectionsByProperty("CUSTOM1")),
@Deprecated
CUSTOM2(sectionsByProperty("CUSTOM2")),
@Deprecated
CUSTOM3(sectionsByProperty("CUSTOM3"));
private static final LazyLogger LOG = SystemLogger.create(HttpCompliance.class);
private final static Map REQUIRED = new HashMap<>();
static {
for (HttpComplianceSection section : HttpComplianceSection.values()) {
for (HttpCompliance compliance : HttpCompliance.values()) {
if (compliance.sections().contains(section)) {
REQUIRED.put(section, compliance);
break;
}
}
}
}
private final EnumSet SECTIONS;
HttpCompliance(EnumSet sections) {
SECTIONS = sections;
}
private static EnumSet sectionsByProperty(String property) {
String s = System.getProperty(HttpCompliance.class.getName() + property);
return sectionsBySpec(s == null ? "*" : s);
}
static EnumSet sectionsBySpec(String spec) {
EnumSet sections;
String[] elements = spec.split("\\s*,\\s*");
int i = 0;
switch (elements[i]) {
case "0":
sections = EnumSet.noneOf(HttpComplianceSection.class);
i++;
break;
case "*":
i++;
sections = EnumSet.allOf(HttpComplianceSection.class);
break;
case "RFC2616":
sections = EnumSet.complementOf(EnumSet.of(
HttpComplianceSection.NO_FIELD_FOLDING,
HttpComplianceSection.NO_HTTP_0_9));
i++;
break;
case "RFC7230":
i++;
sections = EnumSet.allOf(HttpComplianceSection.class);
break;
default:
sections = EnumSet.noneOf(HttpComplianceSection.class);
break;
}
while (i < elements.length) {
String element = elements[i++];
boolean exclude = element.startsWith("-");
if (exclude)
element = element.substring(1);
HttpComplianceSection section = HttpComplianceSection.valueOf(element);
if (section == null) {
LOG.warn("Unknown section '" + element + "' in HttpCompliance spec: " + spec);
continue;
}
if (exclude)
sections.remove(section);
else
sections.add(section);
}
return sections;
}
/**
* @param section The section to query
* @return The minimum compliance required to enable the section.
*/
public static HttpCompliance requiredCompliance(HttpComplianceSection section) {
return REQUIRED.get(section);
}
/**
* Get the set of {@link HttpComplianceSection}s supported by this compliance mode. This set
* is mutable, so it can be modified. Any modification will affect all usages of the mode
* within the same {@link ClassLoader}.
*
* @return The set of {@link HttpComplianceSection}s supported by this compliance mode.
*/
public EnumSet sections() {
return SECTIONS;
}
}