Request Module

From BaseX Documentation
Jump to navigation Jump to search

This XQuery Module contains functions for retrieving information on an HTTP request that has triggered the query. It is mainly useful in the context of Web Applications.

The module is related to Adam Retter’s upcoming EXQuery Request Module.

Conventions

  • The basex-api package must be included in the classpath. This is always the case if you use one of the complete distributions (zip, exe, war) of BaseX.
  • All functions are assigned to the http://exquery.org/ns/request namespace. The module must be imported in the query prolog:
import module namespace request = "http://exquery.org/ns/request";
...
  • In this documentation, the namespace is bound to the request prefix.
  • The following example demonstrates what components a URI may consist of (the example is derived from RFC 3986):
  foo://example.com:8042/over/there?name=ferret
  \_/   \_________/ \__/\_________/ \_________/
   |         |       |       |          |
 scheme   hostname  port    path      query

General Functions

request:method

Signatures request:method() as xs:string
Summary Returns the Method of the HTTP request.

request:attribute

Template:Mark

Signatures request:attribute() as xs:string
Summary Returns the value of an attribute of the HTTP request. If the attribute does not exist, an empty sequence is returned.
Example request:attribute("javax.servlet.error.request_uri") returns the original URI of a caught error.

URI Functions

request:scheme

Signatures request:scheme() as xs:string
Summary Returns the Scheme component of the URI of an HTTP request.
Example For the example given in the introduction, this function would return foo.

request:hostname

Signatures request:hostname() as xs:string
Summary Returns the Hostname component of the URI of an HTTP request.
Example For the example given in the introduction, this function would return example.com.

request:port

Signatures request:port() as xs:integer
Summary Returns the Port component of the URI of an HTTP request, or a default port if it has not been explicitly specified in the URI.
Example For the example given in the introduction, this function would return 8042.

request:path

Signatures request:path() as xs:string
Summary Returns the Path component of the URI of an HTTP request.
Example For the example given in the introduction, this function would return /over/there.

request:query

Signatures request:query() as xs:string?
Summary Returns the Query component of the URI of an HTTP request. If no query has been specified, an empty sequence is returned.
Example For the example given in the introduction, this function would return name=ferret.

request:uri

Signatures request:uri() as xs:anyURI
Summary Returns the complete URI of an HTTP request as it has been specified by the client.
Example For the example given in the introduction, this method would return foo://example.com:8042/over/there?name=ferret.

Connection Functions

request:address

Signatures request:address() as xs:string
Summary Returns the IP address of the server.

request:remote-hostname

Signatures request:remote-hostname() as xs:string
Summary Returns the fully qualified hostname of the client that sent the request.

request:remote-address

Signatures request:remote-address() as xs:string
Summary Returns the IP address of the client that sent the request.

request:remote-port

Signatures request:remote-port() as xs:string
Summary Returns the TCP port of the client socket that triggered the request.

Parameter Functions

request:parameter-names

Signatures request:parameter-names() as xs:string*
Summary Returns the names of all query parameters available from the HTTP request. If RESTXQ is used, this function may help to find query parameters that have not been bound by %restxq:query-param annotations.
Example For the example given in the introduction, this function would return name.

request:parameter

Signatures request:parameter($name as xs:string) as xs:string*
request:parameter($name as xs:string, $default as xs:string) as xs:string*
Summary Returns the value of the named query parameter in an HTTP request. If the parameter does not exist, an empty sequence or the optionally specified default value is returned instead.
Example For the example given in the introduction, the function call request:parameter('name') would return ferret.

Header Functions

request:header-names

Signatures request:header-names() as xs:string*
Summary Returns the names of all headers available from the HTTP request. If RESTXQ is used, this function may help to find headers that have not been bound by %restxq:header-param annotations.

request:header

Signatures request:header($name as xs:string) as xs:string?
request:header($name as xs:string, $default as xs:string) as xs:string
Summary Returns the value of the named header in an HTTP request. If the header does not exist, an empty sequence or the optionally specified default value is returned instead.

Cookie Functions

request:cookie-names

Signatures request:cookie-names() as xs:string*
Summary Returns the names of all cookies in the HTTP headers available from the HTTP request. If RESTXQ is used, this function may help to find cookies that have not been bound by %restxq:cookie-param annotations.

request:cookie

Signatures request:cookie($name as xs:string) as xs:string*
request:cookie($name as xs:string, $default as xs:string) as xs:string
Summary Returns the value of the named Cookie in an HTTP request. If there is no such cookie, an empty sequence or the optionally specified default value is returned instead.

Changelog

Version 7.7

This module was introduced with Version 7.5.