Loading TOC...

xdmp functions (AppServer)

The application server built-in functions are XQuery functions for many HTTP application server functions. Many of the application server functions (for example, xdmp:get-request-field, xdmp:login, etc.) are executable only on HTTP servers; those functions all have no effect and return the empty sequence when run from an XDBC server.

44 functions
Function name Description
xdmp.addResponseHeader Adds an HTTP response header field.
xdmp.getInvokedPath Returns the path of the module that is being invoked.
xdmp.getOriginalUrl Returns the portion of the URL following the host_name:port_number.
xdmp.getRequestBody For PUT requests, returns the body of the request.
xdmp.getRequestClientAddress Returns as a string the internet address of the client from which the HTTP server request is issued.
xdmp.getRequestClientCertificate Returns the PEM encoded client certificate if one was presented.
xdmp.getRequestErrorFormat Returns the current error format for the request.
xdmp.getRequestField Returns the value of a named request field.
xdmp.getRequestFieldContentType This function is used to extract the content type from the request field.
xdmp.getRequestFieldFilename Returns a list of filenames from a multipart request for the field name specified.
xdmp.getRequestFieldNames Returns a sequence of the request field names.
xdmp.getRequestHeader Returns the value of a named request header.
xdmp.getRequestHeaderNames Returns a sequence of request header names.
xdmp.getRequestMethod Returns the HTTP request method.
xdmp.getRequestPath Returns the HTTP request path.
xdmp.getRequestPort Returns the port of the request.
xdmp.getRequestProtocol Returns as a string the request protocol (either "http" or "https") Returns the empty sequence if it is not called from an HTTP server.
xdmp.getRequestUrl Returns the portion of the URL following the host_name:port_number.
xdmp.getRequestUsername If this App Server is using application-level authentication, returns the username in the last successful call to xdmp:login.
xdmp.getResponseCode Returns two nodes, the first containing the HTTP response code and the second containing the HTTP response message.
xdmp.getResponseEncoding Returns the encoding that the response from this server is in.
xdmp.getServerField Returns the value of a named server field.
xdmp.getServerFieldNames Returns a sequence of the server field names.
xdmp.getSessionField Returns the value of a named session field from the session created by the xdmp:login function.
xdmp.getSessionFieldNames Returns a sequence of the HTTP session field names from the session created by the xdmp:login function.
xdmp.getUrlRewriterPath Returns the URL of the URL rewriter handler for this application server.
xdmp.gssServerNegotiate This function is used for kerberos GSS authentication in application level authentication.
xdmp.login Logs in a user on an application server that is using application-level authentication and sends a session cookie containing the session ID to the user's browser.
xdmp.logout Logs the current user out of the session on the server.
xdmp.redirectResponse Redirects the App Server response to a given location.
xdmp.requestLogDelete Deletes the value stored under the specified $key for the current request.
xdmp.requestLogGet Retrieves the value stored under the specified $key for the current request.
xdmp.requestLogPut Stores or updates a (key, value) pair for the current request.
xdmp.rsaGenerate Generate a new RSA public/private key pair.
xdmp.setRequestTimeLimit Changes the time limit for an actively running request to the specified value.
xdmp.setResponseCode Sets the response code and message.
xdmp.setResponseContentType Sets the response content-type.
xdmp.setResponseEncoding Sets the response encoding.
xdmp.setServerField Sets the value of a named server field.
xdmp.setServerFieldPrivilege Sets the privilege of a named server field.
xdmp.setSessionField Sets the value of a named session field for the session created by the xdmp:login function.
xdmp.uriIsFile Returns true if a given URI refers to a file which exists on the current application server.
xdmp.urlDecode Converts URL-encoded string to plaintext.
xdmp.urlEncode Converts plaintext into URL-encoded string.