From BaseX Documentation
This page is part of the Getting Started Section. It describes how BaseX can be used for web applications. The following three HTTP services are available:
- RESTXQ allows you to write web applications with XQuery,
- REST offers a RESTful API for accessing database resources via URLs, and
- WebDAV provides access to databases via the file system.
This article describes different ways of deploying and configuring these services. The services can be deployed as follows:
- as standalone application by running the BaseX HTTP Server,
- as web servlet in a Servlet Container, and
- as web servlet, using Maven.
 Servlet Container
In order to deploy BaseX HTTP Services in a servlet container, you may download the WAR distribution of BaseX from the download site or compile it via
mvn compile war:war in the
basex-api package. The WAR file can then be deployed following the instructions of the corresponding servlet container (jetty, tomcat).
Configuring port, context path, etc. can be done by following the corresponding instructions of the used servlet container. This is needed if you want to replace the default URL path (e.g. http://localhost:8080/rest) with a custom one (e.g. http://localhost:8080/BaseX711/rest).
If run on a Jetty server you may use a
jetty.xml file for detailed server configuration. You can e.g. enable SSL connections or Jetty logging. Place the
jetty.xml right next to the
web.xml. For detailed configuration refer to the Jetty Documentation. A sample jetty.xml is placed in the basex-api package.
To run on Apache Tomcat, start the tomcat server and add any
*.war distribution to deploy using the Tomcat web interface. By default, the interface is accessible via http://localhost:8080/manager/html/.
All database options can be specified in the
They need to be represented as context parameters and prefixed with
The most important options for the web application context are as follows:
|Applies to REST and WebDAV service: If no user is specified, the credentials must be passed on by the client. Please check by yourself if it is safe to store your credentials in plain text.|
|Applies to REST and WebDAV service: If no password is specified, it must be passed on by the client. Please check by yourself if it is safe to store your credentials in plain text.|
|Operation mode. By default, a database server instance will be started, as soon as the first HTTP service is called. The database server can be disabled by setting this flag to |
|Relative or absolute directory referencing the RESTXQ modules. By default, the option points to the standard web application directory.|
|Relative or absolute directory referencing queries and command-scripts that can be invoked via the run operation of REST. By default, the option points to the standard web application directory.|
|The default authentication method proposed by the server. The available methods are |
Path options may contain an absolute or relative path. If a relative path is specified, its root will be the servlet (
<context-param> <param-name>org.basex.dbpath</param-name> <!-- will be rewritten to ..../webapp/WEB-INF/data --> <param-value>WEB-INF/data</param-value> </context-param> <context-param> <param-name>org.basex.repopath</param-name> <!-- will be kept as is --> <param-value>f:/basex/repository</param-value> </context-param>
Context parameters can be requested from XQuery via proc:property-names and proc:property. How to set these options is specific to the servlet container. For example, in Jetty it can be done by overriding the web.xml file. Another option is to directly edit the
WEB-INF/web.xml file in the WAR archive (WAR files are simple ZIP files). Refer to the sample web.xml of the basex-api package.
Different credentials can be assigned to the REST and WebDAV service by specifying local init parameters. In the following example, specific credentials are set for the REST service:
<servlet> <servlet-name>REST</servlet-name> <servlet-class>org.basex.http.rest.RESTServlet</servlet-class> <init-param> <param-name>org.basex.user</param-name> <param-value>rest-user</param-value> </init-param> <init-param> <param-name>org.basex.password</param-name> <param-value>(:87!7X3$o3p</param-value> </init-param> </servlet>
 Available Services
To enable or disable one of the provided services, the corresponding servlet entry in the
web.xml file needs to be removed/commented. The default URL paths are listed in the following table:
|RESTXQ|| ||Create XQuery web services and applications.|
|REST|| ||Access XML database and its resources.|
|WebDAV|| ||Access databases via the filesystem.|
Checkout the BaseX sources via Eclipse or Git. Execute
mvn install in the main project directory and then
mvn install jetty:run in the
basex-api sub-directory. This will start a Jetty instance in which the servlets will be deployed.
The same options as in the case of deployment in a servlet container apply. In this case, however, there is no WAR archive. Instead, Jetty looks up all files in the directory
basex-api/src/main/webapp. Jetty and servlet options can be configured in the
web.xml files as described above in the Servlet Container Configuration. The Jetty stop port can be changed in the Maven Jetty Plugin sesion in the
 User Management
By default, the REST and WebDAV services require client-side authentication.
Default credentials can be stored server-side in the
web.xml file or specified via
If the HTTP server is started with no pre-defined credentials, users and passwords can be sent via
HTTP Basic Authentication or
Users are specified in a
users.xml file, which is stored in the database directory (see User Management for more information).
With cURL, and most browsers, you can specify the user name and password with each HTTP request within the request string as plain text, using the format
USER:PASSWORD@URL. An example:
- Version 8.0
- Added: digest authentication
- Updated: user management
- Updated: default user/password disabled in web.xml
- Version 7.7
- Added: service-specific permissions
- Version 7.5
jetty.xml: configuration for Jetty Server
- Version 7.3
clientmode replaced with
- Version 7.2
- Web Application concept revised