Package org.basex.http.web

Class WebModules

java.lang.Object

org.basex.http.web.WebModules

public final class WebModules
extends Object

This class caches RESTXQ modules found in the HTTP root directory.

Author:

BaseX Team 2005-23, BSD License, Christian Gruen

Method Summary

Modifier and Type	Method	Description
List<RestXqFunction>	checks(HTTPConnection conn)	Returns permission functions that match the current request.
ArrayList<WsFunction>	findWs(WebSocket ws, Annotation ann)	Returns all implementations for the given WebSocket.
static WebModules	get(Context ctx)	Returns the singleton instance.
void	init(boolean update)	Initializes the module cache.
RestXqFunction	restxq(HTTPConnection conn, QNm error)	Returns a RESTXQ function that matches the current request or the specified error code best.
FNode	wadl(javax.servlet.http.HttpServletRequest request, Context ctx)	Returns a WADL description for all available URIs.
WsFunction	websocket(WebSocket ws, Annotation ann)	Returns the WebSocket function that matches the current request.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static WebModules get(Context ctx)

Returns the singleton instance.

Parameters:

ctx - database context

Returns:

instance

init

public void init(boolean update)

Initializes the module cache.

Parameters:

update - only update new modules

wadl

public FNode wadl(javax.servlet.http.HttpServletRequest request,
                  Context ctx)
           throws QueryException

Returns a WADL description for all available URIs.

Parameters:

request - HTTP request

ctx - database context

Returns:

WADL description

Throws:

QueryException - query exception

restxq

public RestXqFunction restxq(HTTPConnection conn,
                             QNm error)
                      throws QueryException,
                             IOException

Returns a RESTXQ function that matches the current request or the specified error code best.

Parameters:

conn - HTTP connection

error - error code (assigned if error function is to be called)

Returns:

function, or null if no function matches

Throws:

QueryException - query exception

IOException - I/O exception

checks

public List<RestXqFunction> checks(HTTPConnection conn)
                            throws QueryException,
                                   IOException

Returns permission functions that match the current request.

Parameters:

conn - HTTP connection

Returns:

list of function, ordered by relevance

Throws:

QueryException - query exception

IOException - I/O exception

findWs

public ArrayList<WsFunction> findWs(WebSocket ws,
                                    Annotation ann)
                             throws QueryException,
                                    IOException

Returns all implementations for the given WebSocket.

Parameters:

ws - WebSocket

ann - annotation (can be null)

Returns:

result of check

Throws:

QueryException - query exception

IOException - I/O exception

websocket

public WsFunction websocket(WebSocket ws,
                            Annotation ann)
                     throws QueryException,
                            IOException

Returns the WebSocket function that matches the current request.

Parameters:

ws - WebSocket

ann - annotation

Returns:

function, or null if no function matches

Throws:

QueryException - query exception

IOException - I/O exception