HTTP Client Module - Revision history

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:38:42Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:32:48Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG: Text replacement - "" to "

2023-12-01T16:29:42Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG at 10:29, 26 October 2023

2023-10-26T10:29:16Z

CG at 10:28, 26 October 2023

2023-10-26T10:28:39Z

CG: Text replacement - "HTML_Parser" to "HTMLParser"

2023-07-18T14:51:03Z

Text replacement - "HTML_Parser" to "HTMLParser"

CG: /* Response Conversion */

2023-07-18T13:51:25Z

Response Conversion

CG at 13:47, 18 July 2023

2023-07-18T13:47:04Z

CG: /* Response Conversion */

2023-07-18T13:43:29Z

Response Conversion

CG at 13:42, 18 July 2023

2023-07-18T13:42:57Z

@@ Line 54: / Line 54: @@
 <pre lang='xquery'>http:send-request(<http:request method='get' status-only='true'/>, 'http://basex.org')</pre>
 '''Result:'''
-<syntaxhighlight lang="xml"><http:response status="200" message="OK">
+<pre lang="xml"><http:response status="200" message="OK">
    <http:header name="Date" value="Mon, 14 Mar 2011 20:55:53 GMT"/>
    <http:header name="Content-Length" value="12671"/>
@@ Line 74: / Line 74: @@
 <pre lang='xquery'>http:send-request(<http:request method='get' href='http://www.google.com' timeout='10'/>)</pre>
 '''Result:'''
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <http:response status="200" message="OK">
    <http:header name="Date" value="Mon, 14 Mar 2011 22:03:25 GMT"/>
@@ Line 121: / Line 121: @@
 '''Result:'''
-<syntaxhighlight lang="xml"><http:response status="200" message="OK">
+<pre lang="xml"><http:response status="200" message="OK">
    <http:header name="ETag" value="W/&quot;11b6d-4ba15ed4&quot;"/>
    <http:header name="Age" value="9260"/>
@@ Line 166: / Line 166: @@
 '''Result:'''
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <http:response xmlns:http="http://expath.org/ns/http-client" status="200" message="OK">
    <http:header name="Content-Length" value="135"/>
@@ Line 228: / Line 228: @@
 '''Result:'''
-<syntaxhighlight lang="javascript">
+<pre lang="javascript">
 map { "abcde": 12345 }
 </pre>
@@ Line 234: / Line 234: @@
 Without the {{Code|json}} attribute, the response body is converted to the default XML representation:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <json type="object">
    <abcde>12345</abcde>

@@ Line 52: / Line 52: @@
 '''Query:'''
-<pre lang='xquery'>http:send-request(<http:request method='get' status-only='true'/>, 'http://basex.org')</syntaxhighlight>
+<pre lang='xquery'>http:send-request(<http:request method='get' status-only='true'/>, 'http://basex.org')</pre>
 '''Result:'''
 <syntaxhighlight lang="xml"><http:response status="200" message="OK">
@@ Line 65: / Line 65: @@
    <http:header name="Cache-Control" value="max-age=90"/>
    <http:body media-type="text/html; charset=utf-8"/>
-</http:response></syntaxhighlight>
+</http:response></pre>
 ==Google Homepage==
@@ Line 72: / Line 72: @@
 '''Query:'''
-<pre lang='xquery'>http:send-request(<http:request method='get' href='http://www.google.com' timeout='10'/>)</syntaxhighlight>
+<pre lang='xquery'>http:send-request(<http:request method='get' href='http://www.google.com' timeout='10'/>)</pre>
 '''Result:'''
 <syntaxhighlight lang="xml">
@@ Line 93: / Line 93: @@
    </body>
 </html>
-</syntaxhighlight>
+</pre>
 The response content type can also be overwritten in order to retrieve HTML pages and other textual data as plain string (using {{Code|text/plain}}) or in its binary representation (using {{Code|application/octet-stream}}). With the {{Code|http:header}} element, a custom user agent can be set. See the following example:
@@ Line 111: / Line 111: @@
    'Conversion to XML failed: ' || $err:description
+}
-</syntaxhighlight>
+</pre>
 ===SVG Data===
@@ Line 118: / Line 118: @@
 '''Query:'''
-<pre lang='xquery'>http:send-request(<http:request method='get'/>, 'http://upload.wikimedia.org/wikipedia/commons/6/6b/Bitmap_VS_SVG.svg')</syntaxhighlight>
+<pre lang='xquery'>http:send-request(<http:request method='get'/>, 'http://upload.wikimedia.org/wikipedia/commons/6/6b/Bitmap_VS_SVG.svg')</pre>
 '''Result:'''
@@ Line 141: / Line 141: @@
      </linearGradient>
      ...
-</svg></syntaxhighlight>
+</svg></pre>
 ==POST Request==
@@ Line 163: / Line 163: @@
    </query>
+)
-</syntaxhighlight>
+</pre>
 '''Result:'''
@@ Line 178: / Line 178: @@
    <div>Section 3</div>
 </html>
-</syntaxhighlight>
+</pre>
 ==File Upload==
@@ Line 199: / Line 199: @@
    file:read-binary($path)
+)
-</syntaxhighlight>
+</pre>
 '''RESTXQ service:'''
@@ Line 215: / Line 215: @@
    });
 };
-</syntaxhighlight>
+</pre>
 ==Response Conversion==
@@ Line 225: / Line 225: @@
 <pre lang='xquery'>
 http:send-request(<http:request method='GET' href='http://localhost:8080/json' json='format=xquery,lax=true'/>)
-</syntaxhighlight>
+</pre>
 '''Result:'''
 <syntaxhighlight lang="javascript">
 map { "abcde": 12345 }
-</syntaxhighlight>
+</pre>
 Without the {{Code|json}} attribute, the response body is converted to the default XML representation:
@@ Line 238: / Line 238: @@
    <abcde>12345</abcde>
 </json>
-</syntaxhighlight>
+</pre>
 '''RESTXQ service:'''
@@ Line 249: / Line 249: @@
    map { 'abcde': 12345 }
 };
-</syntaxhighlight>
+</pre>
 See the [[CSV Module]], [[JSON Module]] and [[HTML Module]] for a list of the available options.

@@ Line 52: / Line 52: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">http:send-request(<http:request method='get' status-only='true'/>, 'http://basex.org')</syntaxhighlight>
+<pre lang='xquery'>http:send-request(<http:request method='get' status-only='true'/>, 'http://basex.org')</syntaxhighlight>
 '''Result:'''
 <syntaxhighlight lang="xml"><http:response status="200" message="OK">
@@ Line 72: / Line 72: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">http:send-request(<http:request method='get' href='http://www.google.com' timeout='10'/>)</syntaxhighlight>
+<pre lang='xquery'>http:send-request(<http:request method='get' href='http://www.google.com' timeout='10'/>)</syntaxhighlight>
 '''Result:'''
 <syntaxhighlight lang="xml">
@@ Line 98: / Line 98: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $binary :=  http:send-request(
    <http:request method='get'
@@ Line 118: / Line 118: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">http:send-request(<http:request method='get'/>, 'http://upload.wikimedia.org/wikipedia/commons/6/6b/Bitmap_VS_SVG.svg')</syntaxhighlight>
+<pre lang='xquery'>http:send-request(<http:request method='get'/>, 'http://upload.wikimedia.org/wikipedia/commons/6/6b/Bitmap_VS_SVG.svg')</syntaxhighlight>
 '''Result:'''
@@ Line 148: / Line 148: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 http:send-request(
    <http:request method='post' username='admin' password='admin'>
@@ Line 186: / Line 186: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $path := 'file-to-be.uploaded'
 return http:send-request(
@@ Line 203: / Line 203: @@
 '''RESTXQ service:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 declare
    %rest:POST
@@ Line 223: / Line 223: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 http:send-request(<http:request method='GET' href='http://localhost:8080/json' json='format=xquery,lax=true'/>)
 </syntaxhighlight>
@@ Line 242: / Line 242: @@
 '''RESTXQ service:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 declare
    %rest:path('json')

@@ Line 5: / Line 5: @@
 Please note that BaseX provides extensions to the specification:
-* Since {{Announce|BaseX 11}}, {{Code|csv}}, {{Code|json}} and {{Code|html}} parser options can be supplied to influence the conversion of the response.
+* Since {{Announce|Version 11}}, {{Code|csv}}, {{Code|json}} and {{Code|html}} parser options can be supplied to influence the conversion of the response.
 Since BaseX 10, the module is based on the [https://openjdk.org/groups/net/httpclient/intro.html Java HTTP Client], which provides a better overall performance, uses internal connection pools and follows redirects across different protocols (http, https).

@@ Line 7: / Line 7: @@
 * Since {{Announce|BaseX 11}}, {{Code|csv}}, {{Code|json}} and {{Code|html}} parser options can be supplied to influence the conversion of the response.
-{{Announce|Updated with Version 10:}} The Implementation of the module is now based on the new [https://openjdk.org/groups/net/httpclient/intro.html Java HTTP Client], which provides a better overall performance, uses internal connection pools and follows redirects across different protocols (http, https).
+Since BaseX 10, the module is based on the [https://openjdk.org/groups/net/httpclient/intro.html Java HTTP Client], which provides a better overall performance, uses internal connection pools and follows redirects across different protocols (http, https).
 =Conventions=

@@ Line 69: / Line 69: @@
 ==Google Homepage==
-Retrieve the Google search home page with a timeout of 10 seconds. In order to [[Parsers#HTML_Parser|parse HTML]], TagSoup must be contained in the class path.
+Retrieve the Google search home page with a timeout of 10 seconds. In order to [[Parsers#HTMLParser|parse HTML]], TagSoup must be contained in the class path.
 '''Query:'''

← Older revision		Revision as of 13:47, 18 July 2023
Line 2:		Line 2:

	If <code><http:header name="Accept-Encoding" value="gzip"/></code> is specified and if the addressed web server provides support for the {{Code\|gzip}} compression algorithm, the response will automatically be decompressed.		If <code><http:header name="Accept-Encoding" value="gzip"/></code> is specified and if the addressed web server provides support for the {{Code\|gzip}} compression algorithm, the response will automatically be decompressed.
		+
		+	Please note that BaseX provides extensions to the specification:
		+
		+	* Since {{Announce\|BaseX 11}}, {{Code\|csv}}, {{Code\|json}} and {{Code\|html}} parser options can be supplied to influence the conversion of the response.

	{{Announce\|Updated with Version 10:}} The Implementation of the module is now based on the new [https://openjdk.org/groups/net/httpclient/intro.html Java HTTP Client], which provides a better overall performance, uses internal connection pools and follows redirects across different protocols (http, https).		{{Announce\|Updated with Version 10:}} The Implementation of the module is now based on the new [https://openjdk.org/groups/net/httpclient/intro.html Java HTTP Client], which provides a better overall performance, uses internal connection pools and follows redirects across different protocols (http, https).

@@ Line 29: / Line 29: @@
 * {{Code|$request}} contains an {{Code|<http:request/>}} element with a {{Code|method}} attribute, an {{Code|href}} attribute with the target URI, and optional header and body elements.
 * The request is either sent to the URI of the {{Code|$href}} argument or (if empty) to the URI supplied via the {{Code|href}} attribute.
-* In addition to the attributes of the official specification, {{Code|csv}}, {{Code|json}}, {{Code|html}} and {{Code|text}} attributes can be supplied to define how to convert the response body.
+* In addition to the attributes of the official specification, {{Code|csv}}, {{Code|json}}, {{Code|html}} and {{Code|text}} attributes can be supplied to define how to convert the response body (see [[#Response Conversion|Response Conversion]] for an example).
 Notes:
@@ Line 44: / Line 44: @@
 ==Status Only==
 Simple GET request. As the attribute {{Code|status-only}} is set to true, only the response element is returned.
@@ Line 211: / Line 212: @@
 };
 </syntaxhighlight>
 =Errors=
@@ Line 238: / Line 275: @@
 =Changelog=
 ;Version 10.0