| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FusekiServer (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"> |
| <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.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><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </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" class="title">Class FusekiServer</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</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FusekiServer</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">Fuseki server. |
| <p> |
| This is a Fuseki server running with a pre-configured set |
| of datasets and services. |
| <p> |
| To create a embedded sever, use <a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main"><code>FusekiServer</code></a> (<a href="#make(int,java.lang.String,org.apache.jena.sparql.core.DatasetGraph)"><code>make(int, java.lang.String, org.apache.jena.sparql.core.DatasetGraph)</code></a> is a packaging |
| of a call to <a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main"><code>FusekiServer</code></a> for the case of one dataset, responding to |
| localhost only). |
| <p> |
| The application calls <a href="#start()"><code>start()</code></a> to run the server (it will run in the background : see <a href="#join()"><code>join()</code></a>). |
| <p> |
| Example: |
| |
| <pre> |
| DatasetGraph dsg = ...; |
| FusekiServer server = FusekiServer.create() |
| .port(1234) |
| .add("/ds", dsg) |
| .build(); |
| server.start(); |
| </pre> |
| <p> |
| Supplying a port number of 0, causes the server to allocate a free port and use |
| that. The actual port can be found with <a href="#getPort()"><code>getPort()</code></a>. |
| <p> |
| The following <a href="#make(int,java.lang.String,org.apache.jena.sparql.core.DatasetGraph)"><code>compact form</code></a> builds a server that only responds to localhost traffic: |
| <pre> |
| FusekiServer.make(1234, "/ds", dsg).start(); |
| </pre> |
| which may be useful for a test server.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="FusekiServer.Builder.html" class="type-name-link" title="class in org.apache.jena.fuseki.main">FusekiServer.Builder</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">FusekiServer.Builder</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DefaultServerPort" class="member-name-link">DefaultServerPort</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Default port when running in Java via <code>FusekiServer....build()</code>.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-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-tab1 method-summary-table-tab4"><code>static <a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main">FusekiServer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#construct(java.lang.String...)" class="member-name-link">construct</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>... args)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Construct a Fuseki server from command line arguments.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#create()" class="member-name-link">create</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Return a builder, with the default choices of actions available.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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-tab1 method-summary-table-tab4"><code><a href="#create(org.apache.jena.fuseki.server.OperationRegistry)" class="member-name-link">create</a><wbr>(org.apache.jena.fuseki.server.OperationRegistry serviceDispatchRegistry)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Return a builder, with a custom set of operation-action mappings.</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/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#datasetURL(java.lang.String)" class="member-name-link">datasetURL</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> dsName)</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 URL for a local dataset.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.jena.fuseki.server.DataAccessPointRegistry</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataAccessPointRegistry()" class="member-name-link">getDataAccessPointRegistry</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 <code>DataAccessPointRegistry</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHttpPort()" class="member-name-link">getHttpPort</a>()</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 HTTP port.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHttpsPort()" class="member-name-link">getHttpsPort</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 HTTPS port.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.eclipse.jetty.server.Server</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJettyServer()" class="member-name-link">getJettyServer</a>()</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 underlying Jetty server which has also been set up.</div> |
| </div> |
| <div class="col-first even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getModules()" class="member-name-link">getModules</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the list of <a href="sys/FusekiModule.html" title="interface in org.apache.jena.fuseki.main.sys"><code>FusekiModule</code></a>s for this 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.OperationRegistry</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOperationRegistry()" class="member-name-link">getOperationRegistry</a>()</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 <code>OperationRegistry</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPort()" class="member-name-link">getPort</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the port being used.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>jakarta.servlet.ServletContext</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getServletContext()" class="member-name-link">getServletContext</a>()</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 <code>ServletContext</code> used for Fuseki processing.</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="#getStaticContentDir()" class="member-name-link">getStaticContentDir</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the filename to the static content area.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#join()" class="member-name-link">join</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Wait for the server to exit.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main">FusekiServer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#make(int,java.lang.String,org.apache.jena.sparql.core.DatasetGraph)" class="member-name-link">make</a><wbr>(int port, |
| <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 dsg)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Construct a Fuseki server for one dataset.</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/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serverURL()" class="member-name-link">serverURL</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Calculate the server URL for "localhost".</div> |
| </div> |
| <div class="col-first even-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 even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Start the server - the server continues to run after this call returns.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop()" class="member-name-link">stop</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Stop the server.</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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="DefaultServerPort"> |
| <h3>DefaultServerPort</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DefaultServerPort</span></div> |
| <div class="block">Default port when running in Java via <code>FusekiServer....build()</code>. |
| The server will be http://localhost:3330. |
| |
| This is not the command line port (3030) which the command line programme sets. |
| |
| See <a href="cmds/FusekiMain.html#defaultPort"><code>FusekiMain.defaultPort</code></a> and <a href="cmds/FusekiMain.html#defaultHttpsPort"><code>FusekiMain.defaultHttpsPort</code></a>.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.jena.fuseki.main.FusekiServer.DefaultServerPort">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="construct(java.lang.String...)"> |
| <h3>construct</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main">FusekiServer</a></span> <span class="element-name">construct</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>... args)</span></div> |
| <div class="block">Construct a Fuseki server from command line arguments. |
| The return server has not been started.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="make(int,java.lang.String,org.apache.jena.sparql.core.DatasetGraph)"> |
| <h3>make</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FusekiServer.html" title="class in org.apache.jena.fuseki.main">FusekiServer</a></span> <span class="element-name">make</span><wbr><span class="parameters">(int port, |
| <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 dsg)</span></div> |
| <div class="block">Construct a Fuseki server for one dataset. |
| It only responds to localhost. |
| The returned server has not been started.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create()"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</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">create</span>()</div> |
| <div class="block">Return a builder, with the default choices of actions available.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(org.apache.jena.fuseki.server.OperationRegistry)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</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">create</span><wbr><span class="parameters">(org.apache.jena.fuseki.server.OperationRegistry serviceDispatchRegistry)</span></div> |
| <div class="block">Return a builder, with a custom set of operation-action mappings. An endpoint must |
| still be created for the server to be able to provide the action. An endpoint |
| dispatches to an operation, and an operation maps to an implementation. This is a |
| specialised operation - normal use is the operation <a href="#create()"><code>create()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPort()"> |
| <h3>getPort</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getPort</span>()</div> |
| <div class="block">Return the port being used. |
| <p> |
| This will be the server port, which defaults to 3330 for embedded use, |
| and to 3030 for command line use, |
| or one actually allocated if the port was 0 ("choose a free port"). |
| <p> |
| If https is in-use, this is the HTTPS port. |
| <p> |
| If http and https are in-use, this is the HTTPS port. |
| <p> |
| If there multiple ports of the same schema, return any one port in use. |
| <p> |
| See also <a href="#getHttpPort()"><code>getHttpPort()</code></a> or Use <a href="#getHttpsPort()"><code>getHttpsPort()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHttpPort()"> |
| <h3>getHttpPort</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getHttpPort</span>()</div> |
| <div class="block">Get the HTTP port. |
| <p> |
| Returns -1 for no HTTP port. |
| <p> |
| If there are multiple HTTP ports configured, returns one of them.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHttpsPort()"> |
| <h3>getHttpsPort</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getHttpsPort</span>()</div> |
| <div class="block">Get the HTTPS port. |
| <p> |
| Returns -1 for no HTTPS port. |
| <p> |
| If there are multiple HTTPS ports configured, returns one of them.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="serverURL()"> |
| <h3>serverURL</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">serverURL</span>()</div> |
| <div class="block">Calculate the server URL for "localhost". |
| <p> |
| Example: <code>http://localhost:3330/</code>. |
| The URL ends in "/". |
| The host name is "localhost". |
| If both HTTP and HTTPS are available, then reply with an HTTPS URL. |
| <p> |
| This operation is useful when using Fuseki as an embedded test server.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="datasetURL(java.lang.String)"> |
| <h3>datasetURL</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">datasetURL</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> dsName)</span></div> |
| <div class="block">Return the URL for a local dataset. |
| <p> |
| Example: <code>http://localhost:3330/dataset</code>. |
| The host name is "localhost". |
| If both HTTP and HTTPS are available, then reply with an HTTPS URL. |
| <p> |
| This operation is useful when using Fuseki as an embedded test server.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJettyServer()"> |
| <h3>getJettyServer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.eclipse.jetty.server.Server</span> <span class="element-name">getJettyServer</span>()</div> |
| <div class="block">Get the underlying Jetty server which has also been set up.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServletContext()"> |
| <h3>getServletContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">jakarta.servlet.ServletContext</span> <span class="element-name">getServletContext</span>()</div> |
| <div class="block">Get the <code>ServletContext</code> used for Fuseki processing. |
| Adding new servlets is possible with care.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataAccessPointRegistry()"> |
| <h3>getDataAccessPointRegistry</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.jena.fuseki.server.DataAccessPointRegistry</span> <span class="element-name">getDataAccessPointRegistry</span>()</div> |
| <div class="block">Get the <code>DataAccessPointRegistry</code>. |
| This method is intended for inspecting the registry.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOperationRegistry()"> |
| <h3>getOperationRegistry</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.jena.fuseki.server.OperationRegistry</span> <span class="element-name">getOperationRegistry</span>()</div> |
| <div class="block">Get the <code>OperationRegistry</code>. |
| This method is intended for inspecting the registry.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStaticContentDir()"> |
| <h3>getStaticContentDir</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">getStaticContentDir</span>()</div> |
| <div class="block">Return the filename to the static content area. |
| Returns null if there is no such area.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getModules()"> |
| <h3>getModules</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">getModules</span>()</div> |
| <div class="block">Return the list of <a href="sys/FusekiModule.html" title="interface in org.apache.jena.fuseki.main.sys"><code>FusekiModule</code></a>s for this server.</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">Start the server - the server continues to run after this call returns. |
| To synchronise with the server stopping, call <a href="#join()"><code>join()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stop()"> |
| <h3>stop</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">stop</span>()</div> |
| <div class="block">Stop the server.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="join()"> |
| <h3>join</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">join</span>()</div> |
| <div class="block">Wait for the server to exit. This call is blocking.</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> |
