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.

41 functions
Function nameDescription
xdmp:add-response-headerAdds an HTTP response header field.
xdmp:get-invoked-pathReturns the path of the module that is being invoked.
xdmp:get-original-urlReturns the portion of the URL following the host_name:port_number.
xdmp:get-request-bodyFor PUT requests, returns the body of the request.
xdmp:get-request-client-addressReturns as a string the internet address of the client from which the HTTP server request is issued.
xdmp:get-request-client-certificateReturns the PEM encoded client certificate if one was presented.
xdmp:get-request-error-formatReturns the current error format for the request.
xdmp:get-request-fieldReturns the value of a named request field.
xdmp:get-request-field-content-typeThis function is used to extract the content type from the request field.
xdmp:get-request-field-filenameReturns a list of filenames from a multipart request for the field name specified.
xdmp:get-request-field-namesReturns a sequence of the request field names.
xdmp:get-request-headerReturns the value of a named request header.
xdmp:get-request-header-namesReturns a sequence of request header names.
xdmp:get-request-methodReturns the HTTP request method.
xdmp:get-request-pathReturns the HTTP request path.
xdmp:get-request-portReturns the port of the request.
xdmp:get-request-protocolReturns as a string the request protocol (either "http" or "https") Returns the empty sequence if it is not called from an HTTP server.
xdmp:get-request-urlReturns the portion of the URL following the host_name:port_number.
xdmp:get-request-usernameIf this App Server is using application-level authentication, returns the username in the last successful call to xdmp:login.
xdmp:get-response-codeReturns two nodes, the first containing the HTTP response code and the second containing the HTTP response message.
xdmp:get-response-encodingReturns the encoding that the response from this server is in.
xdmp:get-server-fieldReturns the value of a named server field.
xdmp:get-server-field-namesReturns a sequence of the server field names.
xdmp:get-session-fieldReturns the value of a named session field from the session created by the xdmp:login function.
xdmp:get-session-field-namesReturns a sequence of the HTTP session field names from the session created by the xdmp:login function.
xdmp:get-url-rewriter-pathReturns the URL of the URL rewriter handler for this application server.
xdmp:gss-server-negotiateThis function is used for kerberos GSS authentication in application level authentication.
xdmp:loginLogs 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:logoutLogs the current user out of the session on the server.
xdmp:redirect-responseRedirects the App Server response to a given location.
xdmp:rsa-generateGenerate a new RSA public/private key pair.
xdmp:set-request-time-limitChanges the time limit for an actively running request to the specified value.
xdmp:set-response-codeSets the response code and message.
xdmp:set-response-content-typeSets the response content-type.
xdmp:set-response-encodingSets the response encoding.
xdmp:set-server-fieldSets the value of a named server field.
xdmp:set-server-field-privilegeSets the privilege of a named server field.
xdmp:set-session-fieldSets the value of a named session field for the session created by the xdmp:login function.
xdmp:uri-is-fileReturns true if a given URI refers to a file which exists on the current application server.
xdmp:url-decodeConverts URL-encoded string to plaintext.
xdmp:url-encodeConverts plaintext into URL-encoded string.
Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy