Google Git
Sign in
apache / jena-site / refs/heads/javadoc / . / arq / org.apache.jena.arq / org / apache / jena / sparql / exec / http / QueryExecutionHTTP.html
blob: 3d0a12ee74341178f06ddf59c4f5f98a658a27fd [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>QueryExecutionHTTP (Apache Jena ARQ)</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.arq, package: org.apache.jena.sparql.exec.http, class: QueryExecutionHTTP">
<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/QueryExecutionHTTP.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="../../../../../../module-summary.html">org.apache.jena.arq</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jena.sparql.exec.http</a></div>
<h1 title="Class QueryExecutionHTTP" class="title">Class QueryExecutionHTTP</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"><a href="../QueryExecutionAdapter.html" title="class in org.apache.jena.sparql.exec">org.apache.jena.sparql.exec.QueryExecutionAdapter</a>
<div class="inheritance">org.apache.jena.sparql.exec.http.QueryExecutionHTTP</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../../../query/QueryExecution.html" title="interface in org.apache.jena.query">QueryExecution</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">QueryExecutionHTTP</span>
<span class="extends-implements">extends <a href="../QueryExecutionAdapter.html" title="class in org.apache.jena.sparql.exec">QueryExecutionAdapter</a></span></div>
<div class="block">A query execution implementation where queries are executed
against a remote service over HTTP.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.jena.sparql.exec.http.QueryExecHTTP)" class="member-name-link">QueryExecutionHTTP</a><wbr>(<a href="QueryExecHTTP.html" title="class in org.apache.jena.sparql.exec.http">QueryExecHTTP</a>&nbsp;qExecHTTP)</code></div>
<div class="col-last even-row-color">&nbsp;</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="QueryExecutionHTTPBuilder.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTPBuilder</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()" class="member-name-link">create</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Create a local execution 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/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="#getHttpResponseContentType()" class="member-name-link">getHttpResponseContentType</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 content-type of the response.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="QueryExecutionHTTPBuilder.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTPBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newBuilder()" class="member-name-link">newBuilder</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="QueryExecutionHTTPBuilder.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTPBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#service(java.lang.String)" class="member-name-link">service</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>&nbsp;endpointURL)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Create a new builder for the remote endpoint</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="QueryExecutionHTTP.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTP</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#service(java.lang.String,java.lang.String)" class="member-name-link">service</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>&nbsp;endpointURL,
<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>&nbsp;queryString)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Create a <a href="QueryExecutionHTTP.html" title="class in org.apache.jena.sparql.exec.http"><code>QueryExecutionHTTP</code></a></div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="QueryExecutionHTTP.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTP</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#service(java.lang.String,org.apache.jena.query.Query)" class="member-name-link">service</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>&nbsp;endpointURL,
<a href="../../../query/Query.html" title="class in org.apache.jena.query">Query</a>&nbsp;query)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Create a <a href="QueryExecutionHTTP.html" title="class in org.apache.jena.sparql.exec.http"><code>QueryExecutionHTTP</code></a></div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.sparql.exec.QueryExecutionAdapter">Methods inherited from class&nbsp;org.apache.jena.sparql.exec.<a href="../QueryExecutionAdapter.html" title="class in org.apache.jena.sparql.exec">QueryExecutionAdapter</a></h3>
<code><a href="../QueryExecutionAdapter.html#abort()">abort</a>, <a href="../QueryExecutionAdapter.html#adapt(org.apache.jena.sparql.exec.QueryExec)">adapt</a>, <a href="../QueryExecutionAdapter.html#close()">close</a>, <a href="../QueryExecutionAdapter.html#execAsk()">execAsk</a>, <a href="../QueryExecutionAdapter.html#execConstruct()">execConstruct</a>, <a href="../QueryExecutionAdapter.html#execConstruct(org.apache.jena.rdf.model.Model)">execConstruct</a>, <a href="../QueryExecutionAdapter.html#execConstructDataset()">execConstructDataset</a>, <a href="../QueryExecutionAdapter.html#execConstructDataset(org.apache.jena.query.Dataset)">execConstructDataset</a>, <a href="../QueryExecutionAdapter.html#execConstructQuads()">execConstructQuads</a>, <a href="../QueryExecutionAdapter.html#execConstructTriples()">execConstructTriples</a>, <a href="../QueryExecutionAdapter.html#execDescribe()">execDescribe</a>, <a href="../QueryExecutionAdapter.html#execDescribe(org.apache.jena.rdf.model.Model)">execDescribe</a>, <a href="../QueryExecutionAdapter.html#execDescribeTriples()">execDescribeTriples</a>, <a href="../QueryExecutionAdapter.html#execJson()">execJson</a>, <a href="../QueryExecutionAdapter.html#execJsonItems()">execJsonItems</a>, <a href="../QueryExecutionAdapter.html#execSelect()">execSelect</a>, <a href="../QueryExecutionAdapter.html#getContext()">getContext</a>, <a href="../QueryExecutionAdapter.html#getDataset()">getDataset</a>, <a href="../QueryExecutionAdapter.html#getQuery()">getQuery</a>, <a href="../QueryExecutionAdapter.html#getQueryString()">getQueryString</a>, <a href="../QueryExecutionAdapter.html#getTimeout1()">getTimeout1</a>, <a href="../QueryExecutionAdapter.html#getTimeout2()">getTimeout2</a>, <a href="../QueryExecutionAdapter.html#isClosed()">isClosed</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.jena.sparql.exec.http.QueryExecHTTP)">
<h3>QueryExecutionHTTP</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">QueryExecutionHTTP</span><wbr><span class="parameters">(<a href="QueryExecHTTP.html" title="class in org.apache.jena.sparql.exec.http">QueryExecHTTP</a>&nbsp;qExecHTTP)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="create()">
<h3>create</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="QueryExecutionHTTPBuilder.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTPBuilder</a></span>&nbsp;<span class="element-name">create</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../../query/QueryExecution.html#create()">QueryExecution</a></code></span></div>
<div class="block">Create a local execution builder</div>
</section>
</li>
<li>
<section class="detail" id="newBuilder()">
<h3>newBuilder</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="QueryExecutionHTTPBuilder.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTPBuilder</a></span>&nbsp;<span class="element-name">newBuilder</span>()</div>
</section>
</li>
<li>
<section class="detail" id="service(java.lang.String)">
<h3>service</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="QueryExecutionHTTPBuilder.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTPBuilder</a></span>&nbsp;<span class="element-name">service</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>&nbsp;endpointURL)</span></div>
<div class="block">Create a new builder for the remote endpoint</div>
</section>
</li>
<li>
<section class="detail" id="service(java.lang.String,org.apache.jena.query.Query)">
<h3>service</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="QueryExecutionHTTP.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTP</a></span>&nbsp;<span class="element-name">service</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>&nbsp;endpointURL,
<a href="../../../query/Query.html" title="class in org.apache.jena.query">Query</a>&nbsp;query)</span></div>
<div class="block">Create a <a href="QueryExecutionHTTP.html" title="class in org.apache.jena.sparql.exec.http"><code>QueryExecutionHTTP</code></a></div>
</section>
</li>
<li>
<section class="detail" id="service(java.lang.String,java.lang.String)">
<h3>service</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="QueryExecutionHTTP.html" title="class in org.apache.jena.sparql.exec.http">QueryExecutionHTTP</a></span>&nbsp;<span class="element-name">service</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>&nbsp;endpointURL,
<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>&nbsp;queryString)</span></div>
<div class="block">Create a <a href="QueryExecutionHTTP.html" title="class in org.apache.jena.sparql.exec.http"><code>QueryExecutionHTTP</code></a></div>
</section>
</li>
<li>
<section class="detail" id="getHttpResponseContentType()">
<h3>getHttpResponseContentType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getHttpResponseContentType</span>()</div>
<div class="block">Get the content-type of the response. Only valid after successful execution of the query.</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>