| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ConNeg (Apache Jena - Fuseki Core Engine 5.0.0)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: org.apache.jena.fuseki.core, package: org.apache.jena.fuseki.system, class: ConNeg"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ConNeg.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../module-summary.html">org.apache.jena.fuseki.core</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jena.fuseki.system</a></div> |
| <h1 title="Class ConNeg" class="title">Class ConNeg</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.jena.fuseki.system.ConNeg</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ConNeg</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block"><p> |
| Content negotiation is a mechanism defined in the HTTP specification that makes it |
| possible to serve different versions of a document (or more generally, a resource |
| representation) at the same URI, so that user agents can specify which version fit |
| their capabilities the best. |
| </p> |
| <p> |
| ConNeg is used in Fuseki to help matching the content media type requested by the |
| user, against the list of offered media types. |
| </p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="http://en.wikipedia.org/wiki/Content_negotiation">http://en.wikipedia.org/wiki/Content_negotiation</a></li> |
| <li><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ConNeg</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.jena.atlas.web.MediaType</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#chooseCharset(jakarta.servlet.http.HttpServletRequest,org.apache.jena.atlas.web.AcceptList,org.apache.jena.atlas.web.MediaType)" class="member-name-link">chooseCharset</a><wbr>(jakarta.servlet.http.HttpServletRequest httpRequest, |
| org.apache.jena.atlas.web.AcceptList myPrefs, |
| org.apache.jena.atlas.web.MediaType defaultMediaType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block"> |
| Chooses the charset by using the Accept-Charset HTTP header.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.jena.atlas.web.MediaType</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#chooseContentType(jakarta.servlet.http.HttpServletRequest,org.apache.jena.atlas.web.AcceptList,org.apache.jena.atlas.web.MediaType)" class="member-name-link">chooseContentType</a><wbr>(jakarta.servlet.http.HttpServletRequest httpRequest, |
| org.apache.jena.atlas.web.AcceptList myPrefs, |
| org.apache.jena.atlas.web.MediaType defaultMediaType)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block"> |
| Choose the content media type by extracting the Accept HTTP header from the |
| HTTP request and choosing (see |
| <code>choose(String, AcceptList, MediaType)</code>) a content media type |
| that matches the header.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#match(java.lang.String,java.lang.String)" class="member-name-link">match</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerString, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> mediaRangeStr)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Match a single media type against a header string.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.jena.atlas.web.MediaType</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#match(java.lang.String,org.apache.jena.atlas.web.AcceptList)" class="member-name-link">match</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerString, |
| org.apache.jena.atlas.web.AcceptList offerList)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block"> |
| Creates a <code>AcceptList</code> with the given HTTP header string and uses the |
| <code>AcceptList.match(MediaType)</code> method to decide which media type matches |
| the HTTP header string.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.jena.atlas.web.MediaType</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#parse(java.lang.String)" class="member-name-link">parse</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> contentType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Parses the content type.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>ConNeg</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ConNeg</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="parse(java.lang.String)"> |
| <h3>parse</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.jena.atlas.web.MediaType</span> <span class="element-name">parse</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> contentType)</span></div> |
| <div class="block">Parses the content type. It splits the string by semi-colon and finds the |
| other features such as the "q" quality factor. For a complete documentation on |
| how the parsing happens, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1</a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>contentType</code> - content type string</dd> |
| <dt>Returns:</dt> |
| <dd>parsed media type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="match(java.lang.String,org.apache.jena.atlas.web.AcceptList)"> |
| <h3>match</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.jena.atlas.web.MediaType</span> <span class="element-name">match</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerString, |
| org.apache.jena.atlas.web.AcceptList offerList)</span></div> |
| <div class="block"><p> |
| Creates a <code>AcceptList</code> with the given HTTP header string and uses the |
| <code>AcceptList.match(MediaType)</code> method to decide which media type matches |
| the HTTP header string. |
| </p> |
| <p> |
| The <em>q</em> quality factor is used to decide which choice is the best |
| match. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>headerString</code> - HTTP header string</dd> |
| <dd><code>offerList</code> - accept list</dd> |
| <dt>Returns:</dt> |
| <dd>matched media type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="match(java.lang.String,java.lang.String)"> |
| <h3>match</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">match</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerString, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> mediaRangeStr)</span></div> |
| <div class="block">Match a single media type against a header string.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>headerString</code> - HTTP header string</dd> |
| <dd><code>mediaRangeStr</code> - Semi-colon separated list of media types</dd> |
| <dt>Returns:</dt> |
| <dd>the matched media type or <code>null</code> if there was no match</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="chooseCharset(jakarta.servlet.http.HttpServletRequest,org.apache.jena.atlas.web.AcceptList,org.apache.jena.atlas.web.MediaType)"> |
| <h3>chooseCharset</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.jena.atlas.web.MediaType</span> <span class="element-name">chooseCharset</span><wbr><span class="parameters">(jakarta.servlet.http.HttpServletRequest httpRequest, |
| org.apache.jena.atlas.web.AcceptList myPrefs, |
| org.apache.jena.atlas.web.MediaType defaultMediaType)</span></div> |
| <div class="block"><p> |
| Chooses the charset by using the Accept-Charset HTTP header. |
| </p> |
| <p> |
| See <code>choose(String, AcceptList, MediaType)</code>. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>httpRequest</code> - HTTP request</dd> |
| <dd><code>myPrefs</code> - accept list</dd> |
| <dd><code>defaultMediaType</code> - default media type</dd> |
| <dt>Returns:</dt> |
| <dd>media type chosen</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="chooseContentType(jakarta.servlet.http.HttpServletRequest,org.apache.jena.atlas.web.AcceptList,org.apache.jena.atlas.web.MediaType)"> |
| <h3>chooseContentType</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.jena.atlas.web.MediaType</span> <span class="element-name">chooseContentType</span><wbr><span class="parameters">(jakarta.servlet.http.HttpServletRequest httpRequest, |
| org.apache.jena.atlas.web.AcceptList myPrefs, |
| org.apache.jena.atlas.web.MediaType defaultMediaType)</span></div> |
| <div class="block"><p> |
| Choose the content media type by extracting the Accept HTTP header from the |
| HTTP request and choosing (see |
| <code>choose(String, AcceptList, MediaType)</code>) a content media type |
| that matches the header. |
| </p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>httpRequest</code> - HTTP request</dd> |
| <dd><code>myPrefs</code> - accept list</dd> |
| <dd><code>defaultMediaType</code> - default media type</dd> |
| <dt>Returns:</dt> |
| <dd>media type chosen</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Licensed under the Apache License, Version 2.0</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
