From BaseX Documentation
BaseX provides access to stored database resources and to the XQuery engine via REST, RESTXQ and WebDAV services. This article describes different ways of deploying and configuring these services. The services can be deployed in three different ways:
- as standalone application by running the BaseX HTTP Server,
- as web servlets in a J2EE Servlet Container, and
- for development purposes, 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.
All database options can be specified in the
web.xml file by prefixing the key with
The most important options for the web application context are as follows:
|USER|| User name. 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. Until Version 7.9, the |
|PASSWORD|| Login data. 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. Until Version 7.9, the |
|HTTPLOCAL||Operation mode. By default, the servlets will work in client/server mode, and a database server instance will be started along with the web server, which can also be addressed from other BaseX clients. If the flag is set to |
|RESTXQPATH||RESTXQ directory. By default, all RESTXQ modules are located in the standard web application directory.|
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>
How to set these options in the
web.xml of the BaseX web application is specific to the servlet container. For example, in Jetty it is 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 each HTTP service by specifying local init parameters. In the following example, the global credentials are overwritten and reset 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/> </init-param> <init-param> <param-name>org.basex.password</param-name> <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:
|Default web server|| |
|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
basex-core project folder and then
mvn install jetty:run in the
basex-api project folder. 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
If the HTTP server is started with no pre-defined credentials, users and passwords can be sent via HTTP basic authentication with each HTTP request. Login data can be stored server-side in the
web.xml file, or specified as command-line arguments.
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
- 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