| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Oct 11 11:08:51 CDT 2021 --> |
| <title>UriCompliance (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 (Eclipse Jetty API Doc - v10.0.7)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10}; |
| 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.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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.eclipse.jetty.http</a></div> |
| <h2 title="Class UriCompliance" class="title">Class UriCompliance</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.http.UriCompliance</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="ComplianceViolation.Mode.html" title="interface in org.eclipse.jetty.http">ComplianceViolation.Mode</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">UriCompliance</span> |
| extends java.lang.Object |
| implements <a href="ComplianceViolation.Mode.html" title="interface in org.eclipse.jetty.http">ComplianceViolation.Mode</a></pre> |
| <div class="block">URI compliance modes for Jetty request handling. |
| A Compliance mode consists of a set of <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s which are allowed |
| when the mode is enabled.</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> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">These are URI compliance "violations", which may be allowed by the compliance mode.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT">DEFAULT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The default compliance mode that extends <a href="https://tools.ietf.org/html/rfc3986">RFC3986</a> compliance with |
| additional violations to avoid most ambiguous URIs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LEGACY">LEGACY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">LEGACY compliance mode that models Jetty-9.4 behavior by allowing <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_SEGMENT"><code>UriCompliance.Violation.AMBIGUOUS_PATH_SEGMENT</code></a>, |
| <a href="UriCompliance.Violation.html#AMBIGUOUS_EMPTY_SEGMENT"><code>UriCompliance.Violation.AMBIGUOUS_EMPTY_SEGMENT</code></a>, <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_SEPARATOR"><code>UriCompliance.Violation.AMBIGUOUS_PATH_SEPARATOR</code></a>, <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_ENCODING"><code>UriCompliance.Violation.AMBIGUOUS_PATH_ENCODING</code></a> |
| and <a href="UriCompliance.Violation.html#UTF16_ENCODINGS"><code>UriCompliance.Violation.UTF16_ENCODINGS</code></a></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static org.slf4j.Logger</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOG">LOG</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RFC3986">RFC3986</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Compliance mode that exactly follows <a href="https://tools.ietf.org/html/rfc3986">RFC3986</a>, |
| including allowing all additional ambiguous URI Violations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RFC3986_UNAMBIGUOUS">RFC3986_UNAMBIGUOUS</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Compliance mode that follows <a href="https://tools.ietf.org/html/rfc3986">RFC3986</a> |
| plus it does not allow any ambiguous URI <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAFE">SAFE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">equivalent to DEFAULT</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#STRICT">STRICT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">equivalent to RFC3986</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UNSAFE">UNSAFE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Compliance mode that allows all URI Violations, including allowing ambiguous paths in non canonicalized form.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.util.Set)">UriCompliance</a></span>​(java.lang.String name, |
| java.util.Set<<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>> violations)</code></th> |
| <td class="colLast"> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allows(org.eclipse.jetty.http.ComplianceViolation)">allows</a></span>​(<a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http">ComplianceViolation</a> violation)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkUriCompliance(org.eclipse.jetty.http.UriCompliance,org.eclipse.jetty.http.HttpURI)">checkUriCompliance</a></span>​(<a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> compliance, |
| <a href="HttpURI.html" title="interface in org.eclipse.jetty.http">HttpURI</a> uri)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#from(java.lang.String)">from</a></span>​(java.lang.String spec)</code></th> |
| <td class="colLast"> |
| <div class="block">Create compliance set from string.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#from(java.util.Set)">from</a></span>​(java.util.Set<<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>> violations)</code></th> |
| <td class="colLast"> |
| <div class="block">Create compliance set from a set of allowed Violations.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.Set<<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="#getAllowed()">getAllowed</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the set of <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s allowed by this compliance mode.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<<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="#getKnown()">getKnown</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#with(java.lang.String,org.eclipse.jetty.http.UriCompliance.Violation...)">with</a></span>​(java.lang.String name, |
| <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>... violations)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new UriCompliance mode that includes the passed <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#without(java.lang.String,org.eclipse.jetty.http.UriCompliance.Violation...)">without</a></span>​(java.lang.String name, |
| <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>... violations)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new UriCompliance mode that excludes the passed <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="LOG"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>protected static final org.slf4j.Logger LOG</pre> |
| </li> |
| </ul> |
| <a id="DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT</h4> |
| <pre>public static final <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> DEFAULT</pre> |
| <div class="block">The default compliance mode that extends <a href="https://tools.ietf.org/html/rfc3986">RFC3986</a> compliance with |
| additional violations to avoid most ambiguous URIs. |
| This mode does allow <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_SEPARATOR"><code>UriCompliance.Violation.AMBIGUOUS_PATH_SEPARATOR</code></a>, but disallows all out <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s.</div> |
| </li> |
| </ul> |
| <a id="LEGACY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LEGACY</h4> |
| <pre>public static final <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> LEGACY</pre> |
| <div class="block">LEGACY compliance mode that models Jetty-9.4 behavior by allowing <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_SEGMENT"><code>UriCompliance.Violation.AMBIGUOUS_PATH_SEGMENT</code></a>, |
| <a href="UriCompliance.Violation.html#AMBIGUOUS_EMPTY_SEGMENT"><code>UriCompliance.Violation.AMBIGUOUS_EMPTY_SEGMENT</code></a>, <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_SEPARATOR"><code>UriCompliance.Violation.AMBIGUOUS_PATH_SEPARATOR</code></a>, <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_ENCODING"><code>UriCompliance.Violation.AMBIGUOUS_PATH_ENCODING</code></a> |
| and <a href="UriCompliance.Violation.html#UTF16_ENCODINGS"><code>UriCompliance.Violation.UTF16_ENCODINGS</code></a></div> |
| </li> |
| </ul> |
| <a id="RFC3986"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RFC3986</h4> |
| <pre>public static final <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> RFC3986</pre> |
| <div class="block">Compliance mode that exactly follows <a href="https://tools.ietf.org/html/rfc3986">RFC3986</a>, |
| including allowing all additional ambiguous URI Violations.</div> |
| </li> |
| </ul> |
| <a id="RFC3986_UNAMBIGUOUS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RFC3986_UNAMBIGUOUS</h4> |
| <pre>public static final <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> RFC3986_UNAMBIGUOUS</pre> |
| <div class="block">Compliance mode that follows <a href="https://tools.ietf.org/html/rfc3986">RFC3986</a> |
| plus it does not allow any ambiguous URI <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s.</div> |
| </li> |
| </ul> |
| <a id="UNSAFE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNSAFE</h4> |
| <pre>public static final <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> UNSAFE</pre> |
| <div class="block">Compliance mode that allows all URI Violations, including allowing ambiguous paths in non canonicalized form.</div> |
| </li> |
| </ul> |
| <a id="SAFE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SAFE</h4> |
| <pre>@Deprecated |
| public static final <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> SAFE</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">equivalent to DEFAULT</div> |
| </div> |
| </li> |
| </ul> |
| <a id="STRICT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>STRICT</h4> |
| <pre>@Deprecated |
| public static final <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> STRICT</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">equivalent to RFC3986</div> |
| </div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(java.lang.String,java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>UriCompliance</h4> |
| <pre>public UriCompliance​(java.lang.String name, |
| java.util.Set<<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>> violations)</pre> |
| </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="valueOf(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre class="methodSignature">public static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> valueOf​(java.lang.String name)</pre> |
| </li> |
| </ul> |
| <a id="from(java.util.Set)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre class="methodSignature">public static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> from​(java.util.Set<<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>> violations)</pre> |
| <div class="block">Create compliance set from a set of allowed Violations.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>violations</code> - A string of violations to allow:</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the compliance from the string spec</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="from(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>from</h4> |
| <pre class="methodSignature">public static <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> from​(java.lang.String spec)</pre> |
| <div class="block">Create compliance set from string. |
| <p> |
| Format: <BASE>[,[-]<violation>]... |
| </p> |
| <p>BASE is one of:</p> |
| <dl> |
| <dt>0</dt><dd>No <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s</dd> |
| <dt>*</dt><dd>All <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s</dd> |
| <dt><name></dt><dd>The name of a static instance of UriCompliance (e.g. <a href="#RFC3986"><code>RFC3986</code></a>). |
| </dl> |
| <p> |
| The remainder of the list can contain then names of <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s to include them in the mode, or prefixed |
| with a '-' to exclude them from the mode. Examples are: |
| </p> |
| <dl> |
| <dt><code>0,AMBIGUOUS_PATH_PARAMETER</code></dt><dd>Only allow <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_PARAMETER"><code>UriCompliance.Violation.AMBIGUOUS_PATH_PARAMETER</code></a></dd> |
| <dt><code>*,-AMBIGUOUS_PATH_PARAMETER</code></dt><dd>Only all except <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_PARAMETER"><code>UriCompliance.Violation.AMBIGUOUS_PATH_PARAMETER</code></a></dd> |
| <dt><code>RFC3986,AMBIGUOUS_PATH_PARAMETER</code></dt><dd>Same as RFC3986 plus <a href="UriCompliance.Violation.html#AMBIGUOUS_PATH_PARAMETER"><code>UriCompliance.Violation.AMBIGUOUS_PATH_PARAMETER</code></a></dd> |
| </dl></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>spec</code> - A string describing the compliance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the UriCompliance instance derived from the string description</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="allows(org.eclipse.jetty.http.ComplianceViolation)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allows</h4> |
| <pre class="methodSignature">public boolean allows​(<a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http">ComplianceViolation</a> violation)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ComplianceViolation.Mode.html#allows(org.eclipse.jetty.http.ComplianceViolation)">allows</a></code> in interface <code><a href="ComplianceViolation.Mode.html" title="interface in org.eclipse.jetty.http">ComplianceViolation.Mode</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>violation</code> - The <a href="ComplianceViolation.html" title="interface in org.eclipse.jetty.http"><code>ComplianceViolation</code></a> to test</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true iff the violation is allowed by this mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre class="methodSignature">public java.lang.String getName()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ComplianceViolation.Mode.html#getName()">getName</a></code> in interface <code><a href="ComplianceViolation.Mode.html" title="interface in org.eclipse.jetty.http">ComplianceViolation.Mode</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The name of the compliance violation mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAllowed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllowed</h4> |
| <pre class="methodSignature">public java.util.Set<<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>> getAllowed()</pre> |
| <div class="block">Get the set of <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s allowed by this compliance mode.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ComplianceViolation.Mode.html#getAllowed()">getAllowed</a></code> in interface <code><a href="ComplianceViolation.Mode.html" title="interface in org.eclipse.jetty.http">ComplianceViolation.Mode</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The immutable set of <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s allowed by this compliance mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getKnown()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKnown</h4> |
| <pre class="methodSignature">public java.util.Set<<a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>> getKnown()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ComplianceViolation.Mode.html#getKnown()">getKnown</a></code> in interface <code><a href="ComplianceViolation.Mode.html" title="interface in org.eclipse.jetty.http">ComplianceViolation.Mode</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The immutable set of all known violations for this mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="with(java.lang.String,org.eclipse.jetty.http.UriCompliance.Violation...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>with</h4> |
| <pre class="methodSignature">public <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> with​(java.lang.String name, |
| <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>... violations)</pre> |
| <div class="block">Create a new UriCompliance mode that includes the passed <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the new mode</dd> |
| <dd><code>violations</code> - The violations to include</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new <a href="UriCompliance.html" title="class in org.eclipse.jetty.http"><code>UriCompliance</code></a> mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="without(java.lang.String,org.eclipse.jetty.http.UriCompliance.Violation...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>without</h4> |
| <pre class="methodSignature">public <a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> without​(java.lang.String name, |
| <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http">UriCompliance.Violation</a>... violations)</pre> |
| <div class="block">Create a new UriCompliance mode that excludes the passed <a href="UriCompliance.Violation.html" title="enum in org.eclipse.jetty.http"><code>UriCompliance.Violation</code></a>s.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the new mode</dd> |
| <dd><code>violations</code> - The violations to exclude</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new <a href="UriCompliance.html" title="class in org.eclipse.jetty.http"><code>UriCompliance</code></a> mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="checkUriCompliance(org.eclipse.jetty.http.UriCompliance,org.eclipse.jetty.http.HttpURI)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>checkUriCompliance</h4> |
| <pre class="methodSignature">public static java.lang.String checkUriCompliance​(<a href="UriCompliance.html" title="class in org.eclipse.jetty.http">UriCompliance</a> compliance, |
| <a href="HttpURI.html" title="interface in org.eclipse.jetty.http">HttpURI</a> uri)</pre> |
| </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.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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
