blob: 6e3ce636d298984f6c2a518ab9a461ff009322c6 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Mon Oct 11 11:08:51 CDT 2021 -->
<title>UriCompliance.Violation (Eclipse Jetty API Doc - v10.0.7)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-10-11">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UriCompliance.Violation (Eclipse Jetty API Doc - v10.0.7)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UriCompliance.Violation.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.http</a></div>
<h2 title="Enum UriCompliance.Violation" class="title">Enum UriCompliance.Violation</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.http.UriCompliance.Violation</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code>java.lang.Comparable&lt;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>&gt;</code>, <code><a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http">ComplianceViolation</a></code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></dd>
</dl>
<hr>
<pre>public static enum <span class="typeNameLabel">UriCompliance.Violation</span>
extends java.lang.Enum&lt;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>&gt;
implements <a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http">ComplianceViolation</a></pre>
<div class="block">These are URI compliance "violations", which may be allowed by the compliance mode. These are actual
violations of the RFC, as they represent additional requirements in excess of the strict compliance of
<a href="https://datatracker.ietf.org/doc/html/rfc3986">RFC 3986</a>.
A compliance mode that contains one or more of these Violations, allows request to violate the corresponding
additional requirement.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.http.ComplianceViolation">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.http.<a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http">ComplianceViolation</a></h3>
<code><a href="ComplianceViolation.Listener.html" title="interface in org.eclipse.jetty.http">ComplianceViolation.Listener</a>, <a href="ComplianceViolation.Mode.html" title="interface in org.eclipse.jetty.http">ComplianceViolation.Mode</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum Constant</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#AMBIGUOUS_EMPTY_SEGMENT">AMBIGUOUS_EMPTY_SEGMENT</a></span></code></th>
<td class="colLast">
<div class="block">Allow ambiguous empty segments e.g.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#AMBIGUOUS_PATH_ENCODING">AMBIGUOUS_PATH_ENCODING</a></span></code></th>
<td class="colLast">
<div class="block">Allow ambiguous path encoding within a URI segment e.g.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#AMBIGUOUS_PATH_PARAMETER">AMBIGUOUS_PATH_PARAMETER</a></span></code></th>
<td class="colLast">
<div class="block">Allow ambiguous path parameters within a URI segment e.g.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#AMBIGUOUS_PATH_SEGMENT">AMBIGUOUS_PATH_SEGMENT</a></span></code></th>
<td class="colLast">
<div class="block">Allow ambiguous path segments e.g.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#AMBIGUOUS_PATH_SEPARATOR">AMBIGUOUS_PATH_SEPARATOR</a></span></code></th>
<td class="colLast">
<div class="block">Allow ambiguous path separator within a URI segment e.g.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#UTF16_ENCODINGS">UTF16_ENCODINGS</a></span></code></th>
<td class="colLast">
<div class="block">Allow UTF-16 encoding eg <code>/foo%u2192bar</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescription()">getDescription</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getURL()">getURL</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.http.ComplianceViolation">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.http.<a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http">ComplianceViolation</a></h3>
<code><a href="ComplianceViolation.html#isAllowedBy(org.eclipse.jetty.http.ComplianceViolation.Mode)">isAllowedBy</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a id="AMBIGUOUS_PATH_SEGMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AMBIGUOUS_PATH_SEGMENT</h4>
<pre>public static final&nbsp;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a> AMBIGUOUS_PATH_SEGMENT</pre>
<div class="block">Allow ambiguous path segments e.g. <code>/foo/%2e%2e/bar</code></div>
</li>
</ul>
<a id="AMBIGUOUS_EMPTY_SEGMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AMBIGUOUS_EMPTY_SEGMENT</h4>
<pre>public static final&nbsp;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a> AMBIGUOUS_EMPTY_SEGMENT</pre>
<div class="block">Allow ambiguous empty segments e.g. <code>//</code></div>
</li>
</ul>
<a id="AMBIGUOUS_PATH_SEPARATOR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AMBIGUOUS_PATH_SEPARATOR</h4>
<pre>public static final&nbsp;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a> AMBIGUOUS_PATH_SEPARATOR</pre>
<div class="block">Allow ambiguous path separator within a URI segment e.g. <code>/foo/b%2fr</code></div>
</li>
</ul>
<a id="AMBIGUOUS_PATH_PARAMETER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AMBIGUOUS_PATH_PARAMETER</h4>
<pre>public static final&nbsp;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a> AMBIGUOUS_PATH_PARAMETER</pre>
<div class="block">Allow ambiguous path parameters within a URI segment e.g. <code>/foo/..;/bar</code></div>
</li>
</ul>
<a id="AMBIGUOUS_PATH_ENCODING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AMBIGUOUS_PATH_ENCODING</h4>
<pre>public static final&nbsp;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a> AMBIGUOUS_PATH_ENCODING</pre>
<div class="block">Allow ambiguous path encoding within a URI segment e.g. <code>/%2557EB-INF</code></div>
</li>
</ul>
<a id="UTF16_ENCODINGS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UTF16_ENCODINGS</h4>
<pre>public static final&nbsp;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a> UTF16_ENCODINGS</pre>
<div class="block">Allow UTF-16 encoding eg <code>/foo%u2192bar</code>.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public static&nbsp;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (UriCompliance.Violation c : UriCompliance.Violation.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a id="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre class="methodSignature">public static&nbsp;<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>&nbsp;valueOf&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
<a id="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getName()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ComplianceViolation.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http">ComplianceViolation</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the violation.</dd>
</dl>
</li>
</ul>
<a id="getURL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURL</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getURL()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ComplianceViolation.html#getURL()">getURL</a></code>&nbsp;in interface&nbsp;<code><a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http">ComplianceViolation</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A URL to the specification that provides more information regarding the requirement that may be violated.</dd>
</dl>
</li>
</ul>
<a id="getDescription()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDescription</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getDescription()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ComplianceViolation.html#getDescription()">getDescription</a></code>&nbsp;in interface&nbsp;<code><a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http">ComplianceViolation</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A short description of the violation.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UriCompliance.Violation.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>