Package org.basex.http.restxq

Class RestXqServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.basex.http.BaseXServlet

org.basex.http.restxq.RestXqServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public final class RestXqServlet
extends BaseXServlet

This servlet receives and processes REST requests. The evaluated code is defined in XQuery modules, which are located in the web server's root directory (specified by the HTTPPATH option), and decorated with RESTXQ annotations.

The implementation is based on Adam Retter's paper presented at XMLPrague 2012, titled "RESTful XQuery - Standardised XQuery 3.0 Annotations for REST".

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RestXqServlet()

Method Summary

Modifier and Type	Method	Description
protected void	run(HTTPConnection conn)	Runs the code.

Methods inherited from class org.basex.http.BaseXServlet

init, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RestXqServlet

public RestXqServlet()

Method Details

run

protected void run(HTTPConnection conn)
            throws Exception

Description copied from class: BaseXServlet

Runs the code.

Specified by:

run in class BaseXServlet

Parameters:

conn - HTTP connection

Throws:

Exception - any exception