| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FusekiServer.Builder (Apache Jena - Fuseki Server Main 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.main, package: org.apache.jena.fuseki.main, class: FusekiServer, class: Builder"> |
| <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/FusekiServer.Builder.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>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.main</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jena.fuseki.main</a></div> |
| <h1 title="Class FusekiServer.Builder" class="title">Class FusekiServer.Builder</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.main.FusekiServer.Builder</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main">FusekiServer</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">FusekiServer.Builder</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">FusekiServer.Builder</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance 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-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,org.apache.jena.fuseki.server.DataService)" class="member-name-link">add</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> name, |
| org.apache.jena.fuseki.server.DataService dataService)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a data service that includes dataset and service names.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,org.apache.jena.fuseki.server.DataService.Builder)" class="member-name-link">add</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> name, |
| org.apache.jena.fuseki.server.DataService.Builder dataServiceBuilder)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,org.apache.jena.query.Dataset)" class="member-name-link">add</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> name, |
| org.apache.jena.query.Dataset dataset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the dataset with given name and a default set of services including update.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,org.apache.jena.query.Dataset,boolean)" class="member-name-link">add</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> name, |
| org.apache.jena.query.Dataset dataset, |
| boolean allowUpdate)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the dataset with given name and a default set of services and enabling |
| update if allowUpdate=true.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,org.apache.jena.sparql.core.DatasetGraph)" class="member-name-link">add</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> name, |
| org.apache.jena.sparql.core.DatasetGraph dataset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the dataset with given name and a default set of services including update</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,org.apache.jena.sparql.core.DatasetGraph,boolean)" class="member-name-link">add</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> name, |
| org.apache.jena.sparql.core.DatasetGraph dataset, |
| boolean allowUpdate)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the dataset with given name and a default set of services and enabling |
| update if allowUpdate=true.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addDataset(java.lang.String,org.apache.jena.sparql.core.DatasetGraph)" class="member-name-link">addDataset</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> name, |
| org.apache.jena.sparql.core.DatasetGraph dataset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a dataset, do not configure it in this call.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addEndpoint(java.lang.String,java.lang.String,org.apache.jena.fuseki.server.Operation)" class="member-name-link">addEndpoint</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> datasetName, |
| <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> endpointName, |
| org.apache.jena.fuseki.server.Operation operation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create an endpoint on the dataset.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addEndpoint(java.lang.String,java.lang.String,org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.auth.AuthPolicy)" class="member-name-link">addEndpoint</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> datasetName, |
| <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> endpointName, |
| org.apache.jena.fuseki.server.Operation operation, |
| org.apache.jena.fuseki.auth.AuthPolicy authPolicy)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create an endpoint as a service of the dataset (i.e.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addFilter(java.lang.String,jakarta.servlet.Filter)" class="member-name-link">addFilter</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> pathSpec, |
| jakarta.servlet.Filter filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a filter with the pathSpec.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addOperation(java.lang.String,org.apache.jena.fuseki.server.Operation)" class="member-name-link">addOperation</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> datasetName, |
| org.apache.jena.fuseki.server.Operation operation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create an endpoint on the dataset i.e.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addOperation(java.lang.String,org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.auth.AuthPolicy)" class="member-name-link">addOperation</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> datasetName, |
| org.apache.jena.fuseki.server.Operation operation, |
| org.apache.jena.fuseki.auth.AuthPolicy authPolicy)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create an endpoint on the dataset i.e.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addProcessor(java.lang.String,org.apache.jena.fuseki.servlets.ActionProcessor)" class="member-name-link">addProcessor</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> pathSpec, |
| org.apache.jena.fuseki.servlets.ActionProcessor processor)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add an <code>ActionProcessor</code> as a servlet.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addProcessor(java.lang.String,org.apache.jena.fuseki.servlets.ActionProcessor,org.slf4j.Logger)" class="member-name-link">addProcessor</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> pathSpec, |
| org.apache.jena.fuseki.servlets.ActionProcessor processor, |
| org.slf4j.Logger log)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add an <code>ActionProcessor</code> as a servlet.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addServlet(java.lang.String,jakarta.servlet.http.HttpServlet)" class="member-name-link">addServlet</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> pathSpec, |
| jakarta.servlet.http.HttpServlet servlet)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the given servlet with the <code>pathSpec</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addServletAttribute(java.lang.String,java.lang.Object)" class="member-name-link">addServletAttribute</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> attrName, |
| <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> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a servlet attribute.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#auth(org.apache.jena.atlas.web.AuthScheme)" class="member-name-link">auth</a><wbr>(org.apache.jena.atlas.web.AuthScheme authScheme)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Choose the HTTP authentication scheme.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main">FusekiServer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Build a server according to the current description.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contextPath(java.lang.String)" class="member-name-link">contextPath</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> path)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Context path to Fuseki.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enableCompact(boolean)" class="member-name-link">enableCompact</a><wbr>(boolean withCompact)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the "/$/compact/*" servlet that triggers compaction for specified dataset.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enableCors(boolean,java.lang.String)" class="member-name-link">enableCors</a><wbr>(boolean withCORS, |
| <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> corsConfigFile)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the Cross Origin (CORS) filter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enableMetrics(boolean)" class="member-name-link">enableMetrics</a><wbr>(boolean withMetrics)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the "/$/metrics" servlet that responds with Prometheus metrics about the server.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enablePing(boolean)" class="member-name-link">enablePing</a><wbr>(boolean withPing)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the "/$/ping" servlet that responds to HTTP very efficiently.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enableStats(boolean)" class="member-name-link">enableStats</a><wbr>(boolean withStats)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the "/$/stats" servlet that responds with stats about the server, |
| including counts of all calls made.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enableTasks(boolean)" class="member-name-link">enableTasks</a><wbr>(boolean withTasks)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add the "/$/tasks" servlet that responds with info about tasks run on the server</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="sys/FusekiModules.html" title="class in org.apache.jena.fuseki.main.sys">FusekiModules</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fusekiModules()" class="member-name-link">fusekiModules</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the current list of Fuseki modules in the builder.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fusekiModules(org.apache.jena.fuseki.main.sys.FusekiModules)" class="member-name-link">fusekiModules</a><wbr>(<a href="sys/FusekiModules.html" title="class in org.apache.jena.fuseki.main.sys">FusekiModules</a> modules)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the <a href="sys/FusekiModule.html" title="interface in org.apache.jena.fuseki.main.sys"><code>Fuseki Module</code></a> for a server.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.jena.fuseki.server.DataService.Builder</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataServiceBuilder(java.lang.String)" class="member-name-link">getDataServiceBuilder</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> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the DataService.Builder, if any, in this builder for the given service name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.jena.sparql.core.DatasetGraph</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataset(java.lang.String)" class="member-name-link">getDataset</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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the DatasetGraph, if any, being built for a service in this builder.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getServletAttribute(java.lang.String)" class="member-name-link">getServletAttribute</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> attrName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Read a servlet attribute that has been set during building this server.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#https(int,java.lang.String)" class="member-name-link">https</a><wbr>(int httpsPort, |
| <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> certificate)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the HTTPs port and read the certificate store location and password from a file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#https(int,java.lang.String,java.lang.String)" class="member-name-link">https</a><wbr>(int httpsPort, |
| <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> certStore, |
| <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> certStorePasswd)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the HTTPs port and provide the certificate store and password.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#jettyServerConfig(java.lang.String)" class="member-name-link">jettyServerConfig</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> filename)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Build the server using a Jetty configuration file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#loopback(boolean)" class="member-name-link">loopback</a><wbr>(boolean loopback)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Restrict the server to only responding to the localhost interface.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#maxServerThreads(int)" class="member-name-link">maxServerThreads</a><wbr>(int maxThreads)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the maximum number threads used by Jetty.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#numServerThreads(int,int)" class="member-name-link">numServerThreads</a><wbr>(int minThreads, |
| int maxThreads)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the number threads used by Jetty.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseConfig(org.apache.jena.graph.Graph)" class="member-name-link">parseConfig</a><wbr>(org.apache.jena.graph.Graph graph)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure using a Fuseki services/datasets assembler in a <code>Graph</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseConfig(org.apache.jena.rdf.model.Model)" class="member-name-link">parseConfig</a><wbr>(org.apache.jena.rdf.model.Model model)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure using a Fuseki services/datasets assembler model.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseConfigFile(java.lang.String)" class="member-name-link">parseConfigFile</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> filename)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configure using a Fuseki services/datasets assembler file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#passwordFile(java.lang.String)" class="member-name-link">passwordFile</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> passwordFile)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the password file.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#port(int)" class="member-name-link">port</a><wbr>(int port)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the HTTP port to run on.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#realm(java.lang.String)" class="member-name-link">realm</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> realm)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the realm used for HTTP digest authentication.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerOperation(org.apache.jena.fuseki.server.Operation,java.lang.String,org.apache.jena.fuseki.servlets.ActionService)" class="member-name-link">registerOperation</a><wbr>(org.apache.jena.fuseki.server.Operation operation, |
| <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, |
| org.apache.jena.fuseki.servlets.ActionService handler)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add an operation to the server, together with its triggering Content-Type (which may be null) and servlet handler.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerOperation(org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.servlets.ActionService)" class="member-name-link">registerOperation</a><wbr>(org.apache.jena.fuseki.server.Operation operation, |
| org.apache.jena.fuseki.servlets.ActionService handler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add an operation and handler to the server.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.jena.sparql.core.DatasetGraph</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#remove(java.lang.String)" class="member-name-link">remove</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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Remove the dataset from being built.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#securityHandler(org.eclipse.jetty.security.SecurityHandler)" class="member-name-link">securityHandler</a><wbr>(org.eclipse.jetty.security.SecurityHandler securityHandler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set a Jetty SecurityHandler.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serverAuthPolicy(org.apache.jena.fuseki.auth.AuthPolicy)" class="member-name-link">serverAuthPolicy</a><wbr>(org.apache.jena.fuseki.auth.AuthPolicy authPolicy)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the server-wide server authorization <code>AuthPolicy</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main">FusekiServer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start()" class="member-name-link">start</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Shortcut: build, then start the server.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#staticFileBase()" class="member-name-link">staticFileBase</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the location (if any has been set) to serve static files from.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#staticFileBase(java.lang.String)" class="member-name-link">staticFileBase</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> directory)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the location (filing system directory) to serve static files from.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#verbose(boolean)" class="member-name-link">verbose</a><wbr>(boolean verbose)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set verbose logging</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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="port(int)"> |
| <h3>port</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">port</span><wbr><span class="parameters">(int port)</span></div> |
| <div class="block">Set the HTTP port to run on. |
| <p> |
| If set to 0, a random free port will be used.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="contextPath(java.lang.String)"> |
| <h3>contextPath</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">contextPath</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> path)</span></div> |
| <div class="block">Context path to Fuseki. If it's "/" then Fuseki URL look like |
| "http://host:port/dataset/query" else "http://host:port/path/dataset/query" |
| The default is "/".</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="loopback(boolean)"> |
| <h3>loopback</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">loopback</span><wbr><span class="parameters">(boolean loopback)</span></div> |
| <div class="block">Restrict the server to only responding to the localhost interface.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="staticFileBase(java.lang.String)"> |
| <h3>staticFileBase</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">staticFileBase</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> directory)</span></div> |
| <div class="block">Set the location (filing system directory) to serve static files from.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="staticFileBase()"> |
| <h3>staticFileBase</h3> |
| <div class="member-signature"><span class="modifiers">public</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">staticFileBase</span>()</div> |
| <div class="block">Get the location (if any has been set) to serve static files from. |
| Return null if unset.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="securityHandler(org.eclipse.jetty.security.SecurityHandler)"> |
| <h3>securityHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">securityHandler</span><wbr><span class="parameters">(org.eclipse.jetty.security.SecurityHandler securityHandler)</span></div> |
| <div class="block">Set a Jetty SecurityHandler. |
| <p> |
| This is an alternative to using the Fuseki Main built-in security |
| configuration.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="verbose(boolean)"> |
| <h3>verbose</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">verbose</span><wbr><span class="parameters">(boolean verbose)</span></div> |
| <div class="block">Set verbose logging</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enableCors(boolean,java.lang.String)"> |
| <h3>enableCors</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">enableCors</span><wbr><span class="parameters">(boolean withCORS, |
| <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> corsConfigFile)</span></div> |
| <div class="block">Add the Cross Origin (CORS) filter. |
| <code>CrossOriginFilter</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enablePing(boolean)"> |
| <h3>enablePing</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">enablePing</span><wbr><span class="parameters">(boolean withPing)</span></div> |
| <div class="block">Add the "/$/ping" servlet that responds to HTTP very efficiently. |
| This is useful for testing whether a server is alive, for example, from a load balancer.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enableStats(boolean)"> |
| <h3>enableStats</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">enableStats</span><wbr><span class="parameters">(boolean withStats)</span></div> |
| <div class="block">Add the "/$/stats" servlet that responds with stats about the server, |
| including counts of all calls made.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enableMetrics(boolean)"> |
| <h3>enableMetrics</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">enableMetrics</span><wbr><span class="parameters">(boolean withMetrics)</span></div> |
| <div class="block">Add the "/$/metrics" servlet that responds with Prometheus metrics about the server.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enableCompact(boolean)"> |
| <h3>enableCompact</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">enableCompact</span><wbr><span class="parameters">(boolean withCompact)</span></div> |
| <div class="block">Add the "/$/compact/*" servlet that triggers compaction for specified dataset. |
| Also adds the "/$/tasks/*" servlet if compact is enabled (but if compact is disabled, |
| then tasks is not automatically disabled).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enableTasks(boolean)"> |
| <h3>enableTasks</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">enableTasks</span><wbr><span class="parameters">(boolean withTasks)</span></div> |
| <div class="block">Add the "/$/tasks" servlet that responds with info about tasks run on the server</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataServiceBuilder(java.lang.String)"> |
| <h3>getDataServiceBuilder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.jena.fuseki.server.DataService.Builder</span> <span class="element-name">getDataServiceBuilder</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> name)</span></div> |
| <div class="block">Get the DataService.Builder, if any, in this builder for the given service name. |
| <p> |
| Returns the <code>DataService.Builder</code> or null. |
| <p> |
| This operation does not return the FusekiServer builder.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataset(java.lang.String)"> |
| <h3>getDataset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.jena.sparql.core.DatasetGraph</span> <span class="element-name">getDataset</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> name)</span></div> |
| <div class="block">Get the DatasetGraph, if any, being built for a service in this builder. |
| <p> |
| Returns the DatasetGraph or null. |
| <p> |
| This operation does not return the FusekiServer builder.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remove(java.lang.String)"> |
| <h3>remove</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.jena.sparql.core.DatasetGraph</span> <span class="element-name">remove</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> name)</span></div> |
| <div class="block">Remove the dataset from being built. |
| <p> |
| Returns the DatasetGraph or null. |
| <p> |
| This operation does not return the builder.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,org.apache.jena.query.Dataset)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">add</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> name, |
| org.apache.jena.query.Dataset dataset)</span></div> |
| <div class="block">Add the dataset with given name and a default set of services including update. |
| This is equivalent to <code>add(name, dataset, true)</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,org.apache.jena.sparql.core.DatasetGraph)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">add</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> name, |
| org.apache.jena.sparql.core.DatasetGraph dataset)</span></div> |
| <div class="block">Add the dataset with given name and a default set of services including update</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,org.apache.jena.query.Dataset,boolean)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">add</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> name, |
| org.apache.jena.query.Dataset dataset, |
| boolean allowUpdate)</span></div> |
| <div class="block">Add the dataset with given name and a default set of services and enabling |
| update if allowUpdate=true.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,org.apache.jena.sparql.core.DatasetGraph,boolean)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">add</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> name, |
| org.apache.jena.sparql.core.DatasetGraph dataset, |
| boolean allowUpdate)</span></div> |
| <div class="block">Add the dataset with given name and a default set of services and enabling |
| update if allowUpdate=true.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addDataset(java.lang.String,org.apache.jena.sparql.core.DatasetGraph)"> |
| <h3>addDataset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addDataset</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> name, |
| org.apache.jena.sparql.core.DatasetGraph dataset)</span></div> |
| <div class="block">Add a dataset, do not configure it in this call. Subsequent calls of |
| <code>addEndpoint</code> and <code>addOperation</code> will be needed to give this |
| dataset some functionality. |
| <p> |
| This operation replaces any previous dataset and configuration with the same canonical name. |
| <p> |
| <code>DataService.Builder</code>. |
| for building the DataService separately.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,org.apache.jena.fuseki.server.DataService.Builder)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">add</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> name, |
| org.apache.jena.fuseki.server.DataService.Builder dataServiceBuilder)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,org.apache.jena.fuseki.server.DataService)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">add</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> name, |
| org.apache.jena.fuseki.server.DataService dataService)</span></div> |
| <div class="block">Add a data service that includes dataset and service names. |
| A <code>DataService</code> allows for choices of the various endpoint names. |
| A DataService added with this operation cannot be modified further |
| with other builder calls.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseConfigFile(java.lang.String)"> |
| <h3>parseConfigFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">parseConfigFile</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> filename)</span></div> |
| <div class="block">Configure using a Fuseki services/datasets assembler file. |
| <p> |
| The application is responsible for ensuring a correct classpath. For example, |
| including a dependency on <code>jena-text</code> if the configuration file includes |
| a text index.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseConfig(org.apache.jena.rdf.model.Model)"> |
| <h3>parseConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">parseConfig</span><wbr><span class="parameters">(org.apache.jena.rdf.model.Model model)</span></div> |
| <div class="block">Configure using a Fuseki services/datasets assembler model. |
| <p> |
| The application is responsible for ensuring a correct classpath. For example, |
| including a dependency on <code>jena-text</code> if the configuration file includes |
| a text index.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseConfig(org.apache.jena.graph.Graph)"> |
| <h3>parseConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">parseConfig</span><wbr><span class="parameters">(org.apache.jena.graph.Graph graph)</span></div> |
| <div class="block">Configure using a Fuseki services/datasets assembler in a <code>Graph</code>. |
| <p> |
| The application is responsible for ensuring a correct classpath. For example, |
| including a dependency on <code>jena-text</code> if the configuration file includes |
| a text index.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="jettyServerConfig(java.lang.String)"> |
| <h3>jettyServerConfig</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">jettyServerConfig</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> filename)</span></div> |
| <div class="block">Build the server using a Jetty configuration file. |
| See <a href="https://wiki.eclipse.org/Jetty/Reference/jetty.xml_syntax">Jetty/Reference/jetty.xml_syntax</a> |
| This is instead of any other HTTP server settings such as port and HTTPs.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="auth(org.apache.jena.atlas.web.AuthScheme)"> |
| <h3>auth</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">auth</span><wbr><span class="parameters">(org.apache.jena.atlas.web.AuthScheme authScheme)</span></div> |
| <div class="block">Choose the HTTP authentication scheme.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="serverAuthPolicy(org.apache.jena.fuseki.auth.AuthPolicy)"> |
| <h3>serverAuthPolicy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">serverAuthPolicy</span><wbr><span class="parameters">(org.apache.jena.fuseki.auth.AuthPolicy authPolicy)</span></div> |
| <div class="block">Set the server-wide server authorization <code>AuthPolicy</code>. |
| Defaults to "logged in users" if a password file provided but no other policy. |
| To allow any one to access the server, use <code>Auth.ANY_ANON</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="realm(java.lang.String)"> |
| <h3>realm</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">realm</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> realm)</span></div> |
| <div class="block">Set the realm used for HTTP digest authentication.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="passwordFile(java.lang.String)"> |
| <h3>passwordFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">passwordFile</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> passwordFile)</span></div> |
| <div class="block">Set the password file. This will be used to build a <code>security handler</code> if one is not supplied. Setting null clears any previous entry. |
| The file should be in the format of |
| <a href="https://www.eclipse.org/jetty/documentation/current/configuring-security.html#hash-login-service">Eclipse jetty password file</a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="https(int,java.lang.String,java.lang.String)"> |
| <h3>https</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">https</span><wbr><span class="parameters">(int httpsPort, |
| <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> certStore, |
| <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> certStorePasswd)</span></div> |
| <div class="block">Set the HTTPs port and provide the certificate store and password. |
| <br/> |
| Pass -1 for the httpsPort to clear the settings. |
| <br/> |
| Pass port 0 to get an allocated free port on startup.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="https(int,java.lang.String)"> |
| <h3>https</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">https</span><wbr><span class="parameters">(int httpsPort, |
| <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> certificate)</span></div> |
| <div class="block">Set the HTTPs port and read the certificate store location and password from a file. |
| The file can be secured by the host OS. |
| This means the password for the certificate is not in the application code. |
| <p> |
| The file format is a JSON object: |
| <pre> |
| { |
| "keystore" : "mykey.jks" , |
| "passwd" : "certificate password" |
| } |
| </pre> |
| Pass -1 for the httpsPort to clear the settings. |
| <br/> |
| Pass port 0 to get an allocated free port on startup.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addProcessor(java.lang.String,org.apache.jena.fuseki.servlets.ActionProcessor)"> |
| <h3>addProcessor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addProcessor</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> pathSpec, |
| org.apache.jena.fuseki.servlets.ActionProcessor processor)</span></div> |
| <div class="block">Add an <code>ActionProcessor</code> as a servlet. <code>ActionProcessor</code> are |
| the implementation of servlet handling that operate within the Fuseki |
| logging and execution framework.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addProcessor(java.lang.String,org.apache.jena.fuseki.servlets.ActionProcessor,org.slf4j.Logger)"> |
| <h3>addProcessor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addProcessor</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> pathSpec, |
| org.apache.jena.fuseki.servlets.ActionProcessor processor, |
| org.slf4j.Logger log)</span></div> |
| <div class="block">Add an <code>ActionProcessor</code> as a servlet. <code>ActionProcessor</code> are |
| the implementation of servlet handling that operate within the Fuseki |
| logging and execution framework.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addServlet(java.lang.String,jakarta.servlet.http.HttpServlet)"> |
| <h3>addServlet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addServlet</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> pathSpec, |
| jakarta.servlet.http.HttpServlet servlet)</span></div> |
| <div class="block">Add the given servlet with the <code>pathSpec</code>. These servlets are added so |
| that they are checked after the Fuseki filter for datasets and before the |
| static content handler (which is the last servlet) used for |
| <a href="#staticFileBase(java.lang.String)"><code>staticFileBase(String)</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addServletAttribute(java.lang.String,java.lang.Object)"> |
| <h3>addServletAttribute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addServletAttribute</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> attrName, |
| <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> value)</span></div> |
| <div class="block">Add a servlet attribute. Pass a value of null to remove any existing binding.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServletAttribute(java.lang.String)"> |
| <h3>getServletAttribute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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> <span class="element-name">getServletAttribute</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> attrName)</span></div> |
| <div class="block">Read a servlet attribute that has been set during building this server.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addFilter(java.lang.String,jakarta.servlet.Filter)"> |
| <h3>addFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addFilter</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> pathSpec, |
| jakarta.servlet.Filter filter)</span></div> |
| <div class="block">Add a filter with the pathSpec. Note that Fuseki dispatch uses a servlet filter |
| which is the last in the filter chain.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fusekiModules(org.apache.jena.fuseki.main.sys.FusekiModules)"> |
| <h3>fusekiModules</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">fusekiModules</span><wbr><span class="parameters">(<a href="sys/FusekiModules.html" title="class in org.apache.jena.fuseki.main.sys">FusekiModules</a> modules)</span></div> |
| <div class="block">Set the <a href="sys/FusekiModule.html" title="interface in org.apache.jena.fuseki.main.sys"><code>Fuseki Module</code></a> for a server. |
| If no modules are added to a builder, then the system-wide default set (found by loading FusekiModule |
| via Java's <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ServiceLoader.html" title="class or interface in java.util" class="external-link"><code>ServiceLoader</code></a> mechanism) is used. |
| <p>Pass <code>null</code> to switch back the system-wide default set.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="sys/FusekiModules.html" title="class in org.apache.jena.fuseki.main.sys"><code>FusekiModules</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fusekiModules()"> |
| <h3>fusekiModules</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="sys/FusekiModules.html" title="class in org.apache.jena.fuseki.main.sys">FusekiModules</a></span> <span class="element-name">fusekiModules</span>()</div> |
| <div class="block">Return the current list of Fuseki modules in the builder.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerOperation(org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.servlets.ActionService)"> |
| <h3>registerOperation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">registerOperation</span><wbr><span class="parameters">(org.apache.jena.fuseki.server.Operation operation, |
| org.apache.jena.fuseki.servlets.ActionService handler)</span></div> |
| <div class="block">Add an operation and handler to the server. This does not enable it for any dataset. |
| <p> |
| To associate an operation with a dataset, call <a href="#addEndpoint(java.lang.String,java.lang.String,org.apache.jena.fuseki.server.Operation)"><code>addEndpoint(java.lang.String, java.lang.String, org.apache.jena.fuseki.server.Operation)</code></a> after adding the dataset.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#addEndpoint(java.lang.String,java.lang.String,org.apache.jena.fuseki.server.Operation)"><code>addEndpoint(java.lang.String, java.lang.String, org.apache.jena.fuseki.server.Operation)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="registerOperation(org.apache.jena.fuseki.server.Operation,java.lang.String,org.apache.jena.fuseki.servlets.ActionService)"> |
| <h3>registerOperation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">registerOperation</span><wbr><span class="parameters">(org.apache.jena.fuseki.server.Operation operation, |
| <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, |
| org.apache.jena.fuseki.servlets.ActionService handler)</span></div> |
| <div class="block">Add an operation to the server, together with its triggering Content-Type (which may be null) and servlet handler. |
| <p> |
| To associate an operation with a dataset, call <a href="#addEndpoint(java.lang.String,java.lang.String,org.apache.jena.fuseki.server.Operation)"><code>addEndpoint(java.lang.String, java.lang.String, org.apache.jena.fuseki.server.Operation)</code></a> after adding the dataset.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#addEndpoint(java.lang.String,java.lang.String,org.apache.jena.fuseki.server.Operation)"><code>addEndpoint(java.lang.String, java.lang.String, org.apache.jena.fuseki.server.Operation)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addEndpoint(java.lang.String,java.lang.String,org.apache.jena.fuseki.server.Operation)"> |
| <h3>addEndpoint</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addEndpoint</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> datasetName, |
| <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> endpointName, |
| org.apache.jena.fuseki.server.Operation operation)</span></div> |
| <div class="block">Create an endpoint on the dataset. |
| The operation must already be registered with the builder.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#registerOperation(org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.servlets.ActionService)"><code>registerOperation(Operation, ActionService)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addEndpoint(java.lang.String,java.lang.String,org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.auth.AuthPolicy)"> |
| <h3>addEndpoint</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addEndpoint</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> datasetName, |
| <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> endpointName, |
| org.apache.jena.fuseki.server.Operation operation, |
| org.apache.jena.fuseki.auth.AuthPolicy authPolicy)</span></div> |
| <div class="block">Create an endpoint as a service of the dataset (i.e. <code>/dataset/endpointName</code>). |
| The operation must already be registered with the builder.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#registerOperation(org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.servlets.ActionService)"><code>registerOperation(Operation, ActionService)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addOperation(java.lang.String,org.apache.jena.fuseki.server.Operation)"> |
| <h3>addOperation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addOperation</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> datasetName, |
| org.apache.jena.fuseki.server.Operation operation)</span></div> |
| <div class="block">Create an endpoint on the dataset i.e. <code>/dataset/</code> for an operation that has other query parameters |
| or a Content-Type that distinguishes it. |
| The operation must already be registered with the builder.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#registerOperation(org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.servlets.ActionService)"><code>registerOperation(Operation, ActionService)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addOperation(java.lang.String,org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.auth.AuthPolicy)"> |
| <h3>addOperation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">addOperation</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> datasetName, |
| org.apache.jena.fuseki.server.Operation operation, |
| org.apache.jena.fuseki.auth.AuthPolicy authPolicy)</span></div> |
| <div class="block">Create an endpoint on the dataset i.e. <code>/dataset/</code> for an operation that has other query parameters |
| or a Content-Type that distinguishes it. Use <a href="#addEndpoint(java.lang.String,java.lang.String,org.apache.jena.fuseki.server.Operation)"><code>addEndpoint(String, String, Operation)</code></a> when |
| the functionality is invoked by presence of a name in the URL after the dataset name. |
| |
| The operation must already be registered with the builder.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#registerOperation(org.apache.jena.fuseki.server.Operation,org.apache.jena.fuseki.servlets.ActionService)"><code>registerOperation(Operation, ActionService)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="numServerThreads(int,int)"> |
| <h3>numServerThreads</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">numServerThreads</span><wbr><span class="parameters">(int minThreads, |
| int maxThreads)</span></div> |
| <div class="block">Set the number threads used by Jetty. |
| This uses a <code>QueuedThreadPool</code> |
| provided by Jetty. |
| <p> |
| Argument order is (minThreads, maxThreads). |
| <ul> |
| <li>Use (-1,-1) for Jetty "default". The Jetty 9.4 defaults are (min=8,max=200). |
| <li>If (min != -1, max is -1) then the default max is 20. |
| <li>If (min is -1, max != -1) then the default min is 2. |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxServerThreads(int)"> |
| <h3>maxServerThreads</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.Builder.html" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></span> <span class="element-name">maxServerThreads</span><wbr><span class="parameters">(int maxThreads)</span></div> |
| <div class="block">Set the maximum number threads used by Jetty. |
| This is equivalent to <code>numServerThreads(-1, maxThreads)</code> |
| and overrides any previous setting of the maximum number of threads. |
| In development or in embedded use, limiting the maximum threads can be useful.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="start()"> |
| <h3>start</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main">FusekiServer</a></span> <span class="element-name">start</span>()</div> |
| <div class="block">Shortcut: build, then start the server.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="build()"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main">FusekiServer</a></span> <span class="element-name">build</span>()</div> |
| <div class="block">Build a server according to the current description.</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> |