You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by an...@apache.org on 2022/08/20 11:25:04 UTC
[jena-site] 02/04: Documentation for arq:httpServiceSendMode
This is an automated email from the ASF dual-hosted git repository.
andy pushed a commit to branch main-next
in repository https://gitbox.apache.org/repos/asf/jena-site.git
commit fac7eb7925f61d22735a58a3d33ea741b8a05b36
Author: Andy Seaborne <an...@apache.org>
AuthorDate: Sat Aug 20 12:05:43 2022 +0100
Documentation for arq:httpServiceSendMode
---
source/documentation/query/service.md | 42 ++++++++++++++++++++++++++++-
source/documentation/sparql-apis/__index.md | 6 ++---
2 files changed, 43 insertions(+), 5 deletions(-)
diff --git a/source/documentation/query/service.md b/source/documentation/query/service.md
index 49eed5fca..72b69f943 100644
--- a/source/documentation/query/service.md
+++ b/source/documentation/query/service.md
@@ -56,11 +56,51 @@ the title already bound from earlier in the query.
## Controlling `SERVICE` requests.
-The `SERVICE` operation in a SPARQL query may be configured via the Context. The values for configuration can be set in the global context (accessed via
+The `SERVICE` operation in a SPARQL query may be configured via the Context.
+The values for configuration can be set in the global context (accessed via
`ARQ.getContext()`) or in the per-query execution context.
+The prefix `arq:` is `<http://jena.apache.org/ARQ#>`.
+
+Symbol | Java Constant | Default
+------ | ------------- | -------
+`arq:httpServiceAllowed` | `ARQ.httpServiceAllowed` | true
+`arq:httpQueryClient` | `ARQ.httpQueryClient` | System default.
+`arq:httpServiceSendMode` | `ARQ.httpServiceSendMode | unset
+
+#### `arq:httpServiceAllowed`
+
+This setting can be used to disable execution of any SERVICE request in query.
+Set to "false" to prohibit SERVICE requests.
+
+#### `arq:httpQueryClient`
+
+The java.net.http HttpClient object to use for SERVICE execution.
+
+#### `arq:httpServiceSendMode`
+
+The HTTP operation to use. The value is a string or a `QuerySendMode` object.
+
+String settings are:
+
+Setting | Effect
+------- | ------
+"POST" | Use HTTP POST. Same as "asPost".
+"GET" | Use HTTP GET unconditionally. Same as "asGetAlways".
+"asGetAlways" | Use HTTP GET.
+"asGetWithLimitBody" | Use HTTP GET upto a size limit (usually 2kbytes).
+"asGetWithLimitForm" | Use HTTP GET upto a size limit (usually 2kbytes), and use a HTML form for the query.
+"asPostForm" | Use HTTP POST and use an HTML form for the query.
+"asPost" | Use HTTP POST.
+
+
+## Old Context setting
+
+Old settings are honored where possible but should not be used:
+
The prefix `srv:` is the IRI `<http://jena.hpl.hp.com/Service#>`.
+
Symbol | Usage | Default
------ | ----- | -------
`srv:queryTimeout` | Set timeouts | none
diff --git a/source/documentation/sparql-apis/__index.md b/source/documentation/sparql-apis/__index.md
index f0192c148..47f0ed657 100644
--- a/source/documentation/sparql-apis/__index.md
+++ b/source/documentation/sparql-apis/__index.md
@@ -262,15 +262,13 @@ authentication, has changed.
See below for more on HTTP authentication with `SERVICE`.
The configuration of `SERVICE` operations has changed in Jena 4.3.0 and the
-paramter names have changed.
+parameter names have changed.
| Symbol | Java Constant | Usage |
| ------ | ------------- | --- |
| `arq:httpServiceAllowed` | `ARQ.httpServiceAllowed` | False to disable |
-| `arq:serviceParams` | `ARQ.serviceParams` | Map |
-| `arq:httpQueryTimeout` | `ARQ.httpQueryTimeout` | Request timeout (time to completion) |
| `arq:httpQueryClient` | `ARQ.httpQueryCient` | An `java.net.http.HttpClient` object |
-| `arq:httpQueryCompression` | | no-op |
+| `arq:httpServiceSendMode` | `ARQ.httpServiceSendMode` | See [Service documentation](../query/service.html) |
where `arq:` is prefix for `<http://jena.apache.org/ARQ#>`.