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/06/24 14:01:04 UTC

[jena-site] branch service-doc updated (40681288b -> afe96830a)

This is an automated email from the ASF dual-hosted git repository.

andy pushed a change to branch service-doc
in repository https://gitbox.apache.org/repos/asf/jena-site.git


 discard 40681288b Documentation for arq:httpServiceSendMode
     new afe96830a Documentation for arq:httpServiceSendMode

This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version.  This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:

 * -- * -- B -- O -- O -- O   (40681288b)
            \
             N -- N -- N   refs/heads/service-doc (afe96830a)

You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.

Any revisions marked "omit" are not gone; other references still
refer to them.  Any revisions marked "discard" are gone forever.

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 source/documentation/query/service.md | 1 +
 1 file changed, 1 insertion(+)


[jena-site] 01/01: Documentation for arq:httpServiceSendMode

Posted by an...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

andy pushed a commit to branch service-doc
in repository https://gitbox.apache.org/repos/asf/jena-site.git

commit afe96830ae80c0bc1d08cefa62e9e053de4a3150
Author: Andy Seaborne <an...@apache.org>
AuthorDate: Fri Jun 24 14:57:51 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..335696326 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#>`.