MarkLogic 10 Product Documentationxdmp functions (AppServer)
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.
48 functions
| Function name | Description |
|---|---|
| xdmp:add-response-header | Adds an HTTP response header field. |
| xdmp:add-response-trailer | Adds a HTTP Trailer when HTTP chunked transfer is enabled. |
| xdmp:get-invoked-path | Returns the path of the module that is being invoked. |
| xdmp:get-original-url | Returns the portion of the URL following the host_name:port_number. |
| xdmp:get-request-body | For PUT or DELETE requests, returns the body of the request. |
| xdmp:get-request-client-address | Returns as a string the internet address of the client from which the HTTP server request is issued. |
| xdmp:get-request-client-certificate | Returns the PEM encoded client certificate if one was presented. |
| xdmp:get-request-error-format | Returns the current error format for the request. |
| xdmp:get-request-field | Returns the value of a named request field. |
| xdmp:get-request-field-content-type | This function is used to extract the content type from the request field. |
| xdmp:get-request-field-filename | Returns a list of filenames from a multipart request for the field name specified. |
| xdmp:get-request-field-names | Returns a sequence of the request field names. |
| xdmp:get-request-header | Returns the value of a named request header. |
| xdmp:get-request-header-names | Returns a sequence of request header names. |
| xdmp:get-request-method | Returns the HTTP request method. |
| xdmp:get-request-path | Returns the HTTP request path. |
| xdmp:get-request-port | Returns the port of the request. |
| xdmp:get-request-protocol | 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:get-request-url | Returns the portion of the URL following the host_name:port_number. |
| xdmp:get-request-username | If this App Server is using application-level authentication, returns the username in the last successful call to xdmp:login . |
| xdmp:get-response-code | Returns two nodes, the first containing the HTTP response code and the second containing the HTTP response message. |
| xdmp:get-response-encoding | Returns the encoding that the response from this server is in. |
| xdmp:get-server-field | Returns the value of a named server field. |
| xdmp:get-server-field-names | Returns a sequence of the server field names. |
| xdmp:get-session-field | Returns the value of a named session field from the session created by the xdmp:login function. |
| xdmp:get-session-field-names | Returns a sequence of the HTTP session field names from the session created by the xdmp:login function. |
| xdmp:get-url-rewriter-path | Returns the URL of the URL rewriter handler for this application server. |
| xdmp:gss-server-negotiate | 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:redirect-response | Redirects the App Server response to a given location. |
| xdmp:request-log-delete | Deletes the value stored under the specified $key for the current request. |
| xdmp:request-log-get | Retrieves the value stored under the specified $key for the current request. |
| xdmp:request-log-put | Stores or updates a (key, value) pair for the current request. |
| xdmp:rsa-generate | Generate a new RSA public/private key pair. |
| xdmp:set-request-limit | Changes the meter limit ( elapsed-time/lock-count/read-size ) for an actively running request to the specified value. |
| xdmp:set-request-time-limit | Changes the time limit for an actively running request to the specified value. |
| xdmp:set-response-chunked-encoding | Enabble/disables chunked encoding |
| xdmp:set-response-code | Sets the response code and message. |
| xdmp:set-response-compression | Enabble/disables HTTP GZIP Response compression |
| xdmp:set-response-content-type | Sets the response content-type. |
| xdmp:set-response-encoding | Sets the response encoding. |
| xdmp:set-server-field | Sets the value of a named server field. |
| xdmp:set-server-field-privilege | Sets the privilege of a named server field. |
| xdmp:set-session-field | Sets the value of a named session field for the session created by the xdmp:login function. |
| xdmp:uri-is-file | Returns true if a given URI refers to a file which exists on the current application server. |
| xdmp:url-decode | Converts URL-encoded string to plaintext. |
| xdmp:url-encode | Converts plaintext into URL-encoded string. |