| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Dispatcher (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.server, class: Dispatcher"> |
| <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/Dispatcher.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.server</a></div> |
| <h1 title="Class Dispatcher" class="title">Class Dispatcher</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.server.Dispatcher</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">Dispatcher</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">Dispatch on registered datasets. This is the entry point into Fuseki for dataset |
| operations. |
| <p> |
| Administration operations, and directly registered servlets and static content, |
| are called through the usual web server process. |
| <p> |
| HTTP Request URLs, after servlet context removed, take the form <code>/dataset</code> |
| or <code>/dataset/service</code>. The most general URL is |
| <code>/context/dataset/service</code>. The <a href="DataAccessPointRegistry.html" title="class in org.apache.jena.fuseki.server"><code>DataAccessPointRegistry</code></a> maps |
| <code>/dataset</code> to a <a href="DataAccessPoint.html" title="class in org.apache.jena.fuseki.server"><code>DataAccessPoint</code></a> which is a name and a |
| <a href="DataService.html" title="class in org.apache.jena.fuseki.server">DataService</a>. |
| <p> |
| The dispatch process is: |
| </p> |
| <p> |
| 1. <a href="#dispatch(jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)">dispatch(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)</a> calls |
| locateDataAccessPoint(jakarta.servlet.http.HttpServletRequest, org.apache.jena.fuseki.server.DataAccessPointRegistry) to get the |
| <a href="DataAccessPoint.html" title="class in org.apache.jena.fuseki.server">DataAccessPoint</a> and calls process(org.apache.jena.fuseki.server.DataAccessPoint, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse). |
| </p> |
| <p> |
| 2. process(org.apache.jena.fuseki.server.DataAccessPoint, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse) create the <a href="../servlets/HttpAction.html" title="class in org.apache.jena.fuseki.servlets">HttpAction</a> then calls |
| dispatchAction(org.apache.jena.fuseki.servlets.HttpAction) which calls through to |
| chooseProcessor(org.apache.jena.fuseki.servlets.HttpAction). |
| </p> |
| <p> |
| 3. chooseProcessor(org.apache.jena.fuseki.servlets.HttpAction) does some checking and calls |
| chooseEndpoint(org.apache.jena.fuseki.servlets.HttpAction, org.apache.jena.fuseki.server.DataService, java.lang.String). |
| </p> |
| <p> |
| 4. chooseEndpoint(org.apache.jena.fuseki.servlets.HttpAction, org.apache.jena.fuseki.server.DataService, java.lang.String) looks at request, and determines the |
| <a href="EndpointSet.html" title="class in org.apache.jena.fuseki.server">EndpointSet</a>. |
| </p> |
| <p> |
| 5. If there isn't an <a href="EndpointSet.html" title="class in org.apache.jena.fuseki.server">EndpointSet</a>, the dispatch process returns. |
| </p> |
| <p> |
| 6. If there is exactly one entry, this is the outcome. |
| </p> |
| <p> |
| 7. If there are multiple choices , chooseOperation(org.apache.jena.fuseki.servlets.HttpAction, org.apache.jena.fuseki.server.EndpointSet) looks |
| at request and decides which <a href="Operation.html" title="class in org.apache.jena.fuseki.server">Operation</a> is being requested based on |
| SPARQL operations signatures and Content-Type. |
| </p> |
| <p> |
| 8.There is a default for dispatches with multiple choices that can't be separated |
| by SPARQL signature. These have no registered Content-type and no query string. |
| </p> |
| <p> |
| A choice by dispatch does not necessarily mean an operation is valid and will be |
| executed. It may fail authentication or not have a registered handler. |
| </p></div> |
| </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">Dispatcher</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 boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#dispatch(jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)" class="member-name-link">dispatch</a><wbr>(jakarta.servlet.http.HttpServletRequest request, |
| jakarta.servlet.http.HttpServletResponse response)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Handle an HTTP request if it is sent to a registered dataset.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Operation.html" title="class in org.apache.jena.fuseki.server">Operation</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#selectPlainOperation(org.apache.jena.fuseki.servlets.HttpAction,org.apache.jena.fuseki.server.EndpointSet)" class="member-name-link">selectPlainOperation</a><wbr>(<a href="../servlets/HttpAction.html" title="class in org.apache.jena.fuseki.servlets">HttpAction</a> action, |
| <a href="EndpointSet.html" title="class in org.apache.jena.fuseki.server">EndpointSet</a> epSet)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">This is a system default <a href="DispatchFunction.html" title="interface in org.apache.jena.fuseki.server"><code>DispatchFunction</code></a>.</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>Dispatcher</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Dispatcher</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="dispatch(jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse)"> |
| <h3>dispatch</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">dispatch</span><wbr><span class="parameters">(jakarta.servlet.http.HttpServletRequest request, |
| jakarta.servlet.http.HttpServletResponse response)</span></div> |
| <div class="block">Handle an HTTP request if it is sent to a registered dataset. |
| <p> |
| Fuseki uses dynamic dispatch, the set of registered datasets can change while |
| the server is running, so dispatch is driven off Fuseki system registries. |
| <p> |
| If the request URL matches a registered dataset, process the request, and send |
| the response. |
| <p> |
| This function is called by <a href="../servlets/FusekiFilter.html#doFilter(jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse,jakarta.servlet.FilterChain)"><code>FusekiFilter.doFilter(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse, jakarta.servlet.FilterChain)</code></a>. |
| <p> |
| Returns <code>true</code> if the request has been handled, including an error response sent, |
| and returns false (no error or response sent) if the request has not been handled. |
| <p> |
| This function does not throw exceptions. |
| <p> |
| The dispatch process is: |
| <ul> |
| <li>Decide the data, based on the request URI (<code>locateDataAccessPoint(HttpServletRequest, DataAccessPointRegistry)</code> |
| <li>Allocate HttpAction (<code>process(org.apache.jena.fuseki.server.DataAccessPoint, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)</code>, <code>dispatchAction(org.apache.jena.fuseki.servlets.HttpAction)</code>). |
| <li>Decide service endpoint name (<code>chooseProcessor(org.apache.jena.fuseki.servlets.HttpAction)</code>) |
| <li>Decide operation <code>chooseEndpoint(org.apache.jena.fuseki.servlets.HttpAction, org.apache.jena.fuseki.server.DataService, java.lang.String)</code> |
| <ul> |
| <li>Request parameters - query string (fixed for SPARQL query and SPARQL update) (<code>chooseOperation(org.apache.jena.fuseki.servlets.HttpAction, org.apache.jena.fuseki.server.EndpointSet)</code>) |
| <li>Content type (<code>chooseOperation(org.apache.jena.fuseki.servlets.HttpAction, org.apache.jena.fuseki.server.EndpointSet)</code>) |
| <li>Default - quads operation |
| </ul> |
| <li>Allow authentication for the dispatch choice. |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="selectPlainOperation(org.apache.jena.fuseki.servlets.HttpAction,org.apache.jena.fuseki.server.EndpointSet)"> |
| <h3>selectPlainOperation</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Operation.html" title="class in org.apache.jena.fuseki.server">Operation</a></span> <span class="element-name">selectPlainOperation</span><wbr><span class="parameters">(<a href="../servlets/HttpAction.html" title="class in org.apache.jena.fuseki.servlets">HttpAction</a> action, |
| <a href="EndpointSet.html" title="class in org.apache.jena.fuseki.server">EndpointSet</a> epSet)</span></div> |
| <div class="block">This is a system default <a href="DispatchFunction.html" title="interface in org.apache.jena.fuseki.server"><code>DispatchFunction</code></a>.</div> |
| </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> |