repair,
encoding, defaultLanguage) from
xdmp.documentLoad
and xdmp.documentGet.
The
xdmp.httpGet options include:
headers
- An object with each of its property representing one HTTP header. The name of the property is the header's name and the value of the property is the header's value. The names can be anything, but many HTTP servers understand HTTP names such as
content-type.authentication
- The credentials and the authentication method to use for this request. This object has properties for the
usernameandpassword. The username is the name of the user to be authenticated on the http server. The password is that user's password. You can optionally use amethodproperty on the "authentication" object. If it is specified it must be either 'basic' or 'digest'. If a method is specified and the HTTP server requests a different type of authentication, then an error is raised. If the attribute is not specified, or matches the server's requested method, the authentication proceeds.timeout
- The amount of time, in seconds, to wait until the HTTP connection times out. The default value is the
http timeoutfor the group.ciphers
- A standard cipher string. For details on legal ciper strings, see http://www.openssl.org/docs/apps/ciphers.html#CIPHER_STRINGS.
client-cert
- A PEM encoded client certificate for identifying the client to the remote server.
clientKey
- The private key that corresponds to
clientCert.passPhrase
- A pass phrase, if one is needed to decrypt client-key.
method
- The authentication method, which can be "basic", "digest", "aws", or "aws4".
username
- A user name, if required for authentication.
password
- A password, if required for authentication.
allowSslv3
- A boolean value to specify whether to communicate using the SSL v3 protocol. The default is
true, which indicates communication using the SSL v3 protocol.allowTls
- A boolean value to specify whether to communicate using the TLS protocol. The default is
true, which indicates communication using the TLS protocol.verifyCert
- A boolean value to specify whether the server's certificate should be verified. The default value is
true. A value offalseshould only be specfied after careful consideration of the security risks since it permits communication with servers whose certificates are expired, revoked, or signed by unknown or untrusted authorities. A value offalsealso removes protection against a man-in-the-middle attack.sslSessionCache
- A boolean value to specify whether ssl session should be cached and reused. The default value is
true. A value offalseshould only be specfied if ssl session cache causes problem with a url.
The http functions only operate on URIs that use the http or https
schemes; specifying a URI that does not begin with http://
or https:// throws an exception.
If an http function times out, it throws a socket received exception (SVC-SOCRECV).
An automatic encoding detector will be used if the value auto
is specified for the encoding option
. If no option is specified, the encoding defaults to
the encoding specified
in the http header. If there is no encoding in the http header, the encoding
defaults to UTF-8.
The first node in the output of this function is the response header from the http server.
The second node in the output of this function is the
response from the http server. The response is treated as
text, XML, JSON or binary, depending on the content-type header sent from
the http server. If the node is html, the header should indicate
text/html, which is returned as a text document by default.
The type of document is determined by the mimetypes mappings, and
you can change the mappings in the Admin Interface as needed.
To use this function with a proxy, you need to translate the URI to the proxy uri. For example:
function httpGetProxy(proxy, uri) {
var host = fn.subsequence(fn.tokenize(uri,'/'), 3, 3);
// you might need to modify the next line based on your proxy server config
var proxyuri = fn.concat(proxy, uri);
return xdmp.httpGet(proxyuri,
{headers:{host: host}});
};
httpGetProxy('http://some.proxy.com:8080','http://www.google.com');
http://marklogic.com/xdmp/privileges/xdmp-http-get
xdmp.httpGet("http://www.my.com/document.xhtml",
{
"authentication": {
"method" : "basic",
"username" : "myname",
"password" : "mypassword"
}
})
=> the response from the server as well as the specified document
fn.subsequence(
xdmp.httpGet("http://www.marklogic.com",
{
"encoding" : "iso-8859-1"
}), 2, 1)
=> The specified document, transcoded from ISO-8859-1
to UTF-8 encoding. This assumes the document is
encoded in ISO-8859-1.