Adds an HTTP response header field.

  xdmp:add-response-header("meta", "description")

Returns the POST body of this request, if it is not application/x-www-form-urlencoded.

Returns the empty sequence if it is not called from an application server.

If the content-type of the POST body is application/x-www-form-urlencoded, it is not available here, but instead is available in its decoded form through xdmp:get-request-field-names() and xdmp:get-request-field().

If there is no content-type header in the request, then the request body defaults to application/x-www-form-urlencoded, and therefore xdmp:get-request-body will return the empty sequence. If you want to read the request body, then the POST must include a content-type header.

You can use this function to process certain types of web service SOAP requests with MarkLogic Server.

  xdmp:get-request-body()
  => "Contents of POST body."

Returns as a string the internet address of the client from which the HTTP server request is issued.

Returns the empty sequence if it is not called from an HTTP server.

Use this function if you need to get the internet protocol (IP) address of the requesting client. For example, you can create an application that contains conditional code based on IP addresses (see the example below).

The following example shows logic which checks if the request was submitted from the "localhost" IP address (127.0.0.1).

  if (xdmp:get-request-client-address() eq "127.0.0.1")
  then "Submitted from localhost."
  else "Only localhost access is allowed for this application."

  xdmp:get-request-client-address()
  => "127.0.0.1"

Returns the value of a named request field.

  xdmp:get-request-field("index")
  => "10"

Returns a sequence of the request field names.

  xdmp:get-request-field-names()
  => ("section", "name", ...)

Returns the value of a named request header.

  xdmp:get-request-header("A")
  => "foo"

Returns a sequence of request header names.

  xdmp:get-request-header-names()
  => ("A", "B", ...)

Returns the HTTP request method.

  xdmp:get-request-method()
  => "GET"

Returns the HTTP request path.

  xdmp:get-request-path()
  => "/example.xqy"

Returns the logged-in username for the request.

  xdmp:get-request-username()
  => "fred"

Returns the value of a named HTTP session field.

  xdmp:get-session-field("user")
  => "marklogic"

Returns a sequence of the HTTP session field names.

  xdmp:get-session-field-names()
  => ("user", "role", "action", "index")

Logs in a user on an application server that is using application-level authentication and deposits a session cookie. Returns true on success, false on failure.

If the user calling this function has the xdmp:login privilege, this function can be called without a password or with the empty sequence as the password. In this case, login will succeed if the specified user exists.

  xdmp:login("mark","secret")
  => true() -- if user "mark" has password "secret"

  xdmp:login("username") or xdmp:login("username", ()) 
  => true() -- if user calling the function has the 
               xdmp:login privilege

  xdmp:login("username") or xdmp:login("username", ()) 
  => SEC-PRIV exception if the user calling the function does 
              not have the xdmp:login privilege

  xdmp:login("username")
  => true() -- if current user has the xdmp:login privilege

  xdmp:login("username")
  => SEC-PRIV exception if current user does not have the 
              xdmp:login privilege

Sets the current user to the default user defined in application-level authentication.

  xdmp:logout()
  => ()

Redirects the App Server response to a given location.

  xdmp:redirect-response("http://marklogic.com/howtobuy.xqy")

Sets the response code and message.

  xdmp:set-response-code(204,"No Content")

Sets the response content-type.

  xdmp:set-response-content-type("text/html")

Sets the value of a named HTTP session field.

  xdmp:set-session-field("user", "marklogic")
  => "marklogic"

Returns true if a given URI refers to a file which exists on the current application server. Returns false if the file does not exist. Returns the empty sequence if the URI is the empty sequence.

  xdmp:uri-is-file("apppages/test.xml")
  => true if test.xml exists in "apppages" sub-directory 
  relative to the directory of the file containing the request.

  xdmp:uri-is-file("/sub-directory/test.xml")
  => true if test.xml exists in "sub-directory" relative 
  to the root directory of the application server.

Converts URL-encoded string to plaintext.

  xdmp:url-decode("Why+not%3f")
  => "Why not?"

Converts plaintext into URL-encoded string.

  xdmp:url-encode("Why not?")
  => "Why+not%3f"