descriptor.xml.tmpl

<?xml version="1.0" encoding="UTF-8"?>

<!--
    This is the Web-application Descriptor file.
    If the database is running in a servlet-context, the descriptor file will
    be read from the WEB-INF directory of the web application. Otherwise, the descriptor
    is read from the directory specified by the exist.home system property.

    $Id$
-->


<xquery-app request-replay-log="false" filtered="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="schema/descriptor.xsd">
    <!--
        request-replay-log: Controls whether the Server logs incoming requests
        to the file request-replay-log.txt. This is useful for reproducing eXist behaviour and
        can be used in combination with the eXist Request Replayer (see tools/requestlog).
        Should be set to either true or false, most people will have no need for this.
        
        Note - HTTP, REST, XML-RPC are supported, but within those HTTP PUT, HTTP POST form file 
               uploads, HTTP POST XUpdate are not yet supported!
    -->

    <allow-source>
        <!--
            In this section, the path to an XQuery, folder or collection of XQueries may be set as allowing viewable source,
            this means that if you call an XQuery with the request parameter _source=yes, the query will not be executed
            and instead the source code of the query will be shown.
            
            BEWARE the security consequences of enabling this for your queries!
            
            REST XQuery paths (EXistServlet/RESTServer) start from the db location e.g. /db/mycollection/myquery.xql
            FileSystem XQuery paths (XQueryServlet) start from the root filesystem location e.g. $EXIST_HOME/webapp/myapp/myquery.xql
            and end with a .xql suffix. However ${WEBAPP_HOME} may be used for convenience to represent eXist's webapp folder without
            the need to know the specific path.
            Cocoon XQuery Paths (XQueryGenerator) are not yet supported!
        -->

        <!-- Allow viewing of Source for eXist XQuery examples (XQueryGenerator) -->
        <!-- NB - Not Yet Supported -->

        <!-- Allow viewing of Source for eXist XQuery examples (XQueryServlet) -->
		<xquery path="${WEBAPP_HOME}/sandbox/sandbox.xql"/>
        <xquery path="${WEBAPP_HOME}/xquery/guess.xql"/>
        <xquery path="${WEBAPP_HOME}/xquery/transform.xql"/>
        <xquery path="${WEBAPP_HOME}/xquery/login.xql"/>
        <xquery path="${WEBAPP_HOME}/xquery/session.xql"/>
        <xquery path="${WEBAPP_HOME}/xquery/call.xql"/>
    </allow-source>

    <maps>
        <!--
            In this section, the path to a resource or collection may be mapped to a different
            resource or collection. This can be useful for several reasons, including default xquery execution for
            a folder accessed through REST (much like the default document functionality of a webserver)
            or perhaps mapping an old collection path that you had publicised to a newer collection path.
            
            Path Syntax follows the same conventions of <allow-source>
        -->

        <!-- Maps the virtual fibo.xql to fibo.xq. Here the XQueryServlet executes what would normally be executed by XQueryGenerator -->
        <!--map path="${WEBAPP_HOME}/xquery/fibo.xql" view="${WEBAPP_HOME}/xquery/fibo.xq"/-->

        <!-- Default Document like example for REST
            <map path="/db/myCollection" view="/db/myCollection/index.xql"/>
        -->

    </maps>

</xquery-app>