From 517bbe863721545b14cec8a227f1313241799bd0 Mon Sep 17 00:00:00 2001 From: Adam Retter Date: Fri, 17 May 2019 17:48:56 +0400 Subject: [PATCH 1/7] Updated the documentation for the Mavenized eXist-db --- .../listings/listing-2.txt | 12 +- .../data/ant-tasks/ant-tasks.xml | 22 +- .../data/ant-tasks/listings/listing-1.xml | 4 +- .../data/ant-tasks/listings/listing-2.xml | 7 - src/main/xar-resources/data/backup/backup.xml | 8 +- .../data/configuration/listings/listing-1.xml | 4 +- .../contentextraction/contentextraction.xml | 14 - .../devguide_indexes/devguide_indexes.xml | 52 +- .../data/devguide_log4j/devguide_log4j.xml | 19 +- .../data/exist-building/exist-building.xml | 489 ++++-------------- .../data/extensions/extensions.xml | 117 +++-- .../java-admin-client/java-admin-client.xml | 13 +- .../data/newrangeindex/newrangeindex.xml | 2 +- .../production_good_practice.xml | 10 +- .../data/troubleshooting/troubleshooting.xml | 91 +--- .../data/tuning/listings/listing-3.txt | 2 +- src/main/xar-resources/data/tuning/tuning.xml | 25 +- .../data/upgrading/listings/sign.txt | 1 - .../data/upgrading/upgrading.xml | 75 +-- .../data/urlrewrite/urlrewrite.xml | 2 +- .../data/validation/validation.xml | 4 +- .../data/webdav/listings/listing-1.txt | 2 +- src/main/xar-resources/data/webdav/webdav.xml | 6 +- src/main/xar-resources/data/xforms/xforms.xml | 4 +- src/main/xar-resources/data/xquery/xquery.xml | 3 +- 25 files changed, 287 insertions(+), 701 deletions(-) delete mode 100644 src/main/xar-resources/data/ant-tasks/listings/listing-2.xml delete mode 100644 src/main/xar-resources/data/upgrading/listings/sign.txt diff --git a/src/main/xar-resources/data/advanced-installation/listings/listing-2.txt b/src/main/xar-resources/data/advanced-installation/listings/listing-2.txt index 232a395f..96a0c2bf 100644 --- a/src/main/xar-resources/data/advanced-installation/listings/listing-2.txt +++ b/src/main/xar-resources/data/advanced-installation/listings/listing-2.txt @@ -1,4 +1,4 @@ -Wolfgangs-MacBook-Air:eXist wolf$ java -jar installer/eXist-db-setup-2.0RC2-rev17974.jar -console +Wolfgangs-MacBook-Air:eXist wolf$ java -jar exist-installer/target/exist-installer-5.0.0-RC8-SNAPSHOT.jar Select target path [/Users/wolf/Source/trunk/eXist] /Applications/eXist/ press 1 to continue, 2 to quit, 3 to redisplay @@ -40,12 +40,12 @@ press 1 to continue, 2 to quit, 3 to redisplay [ Starting processing ] Starting process Setting admin password ... (1/1) --- Starting embedded database instance --- -File lock last access timestamp: 30.12.2012 /Applications/eXist/webapp/WEB-INF/data/dbx_dir.lck -Found a stale lockfile. Trying to remove it: /Applications/eXist/webapp/WEB-INF/data/dbx_dir.lck -File lock last access timestamp: 30.12.2012 /Applications/eXist/webapp/WEB-INF/data/journal.lck -Found a stale lockfile. Trying to remove it: /Applications/eXist/webapp/WEB-INF/data/journal.lck +File lock last access timestamp: 30.12.2012 /Applications/eXist/data/dbx_dir.lck +Found a stale lockfile. Trying to remove it: /Applications/eXist/data/dbx_dir.lck +File lock last access timestamp: 30.12.2012 /Applications/eXist/data/journal.lck +Found a stale lockfile. Trying to remove it: /Applications/eXist/data/journal.lck Dez 30, 2012 10:13:26 PM org.expath.pkg.repo.util.Logger info -INFO: Create a new repository with storage: File system storage in /Applications/eXist/webapp/WEB-INF/expathrepo +INFO: Create a new repository with storage: File system storage in /Applications/eXist/data/expathrepo Setting admin user password... --- Initialization complete. Shutdown embedded database instance --- [ Console installation done ] \ No newline at end of file diff --git a/src/main/xar-resources/data/ant-tasks/ant-tasks.xml b/src/main/xar-resources/data/ant-tasks/ant-tasks.xml index b69ff37f..214e90c7 100644 --- a/src/main/xar-resources/data/ant-tasks/ant-tasks.xml +++ b/src/main/xar-resources/data/ant-tasks/ant-tasks.xml @@ -17,9 +17,9 @@ eXist-db provides a library for the Ant build tool to automate common system administration and operation - tasks, like backup/restore or importing files. Ant is included in the eXist-db - distribution (only if you've installed the eXist-db source code). + >Ant build tool to automate common system administration and + operation tasks, like backup/restore or importing files. The latest version of eXist-db's + Ant Tasks can be found on Maven Central as the artifact exist-ant. @@ -35,22 +35,11 @@ <project xmlns:xdb="http://exist-db.org/ant" … > - Import the eXist-db tasks by adding the following code: + Import the eXist-db tasks with Ivy and then add the following code: - - Setup the classpath (the property ${server.dir} must - point to the eXist-db installation directory): - - - - For a working example have a look into the file - webapp/xqts/build.xml, which is used to prepare the database for - running the xquery test suite. - - @@ -848,7 +837,8 @@ eXist-db (remote or local). Supply your own values for the source and target user, pass, and url properties. You can find this Ant script under the - samples/ant directory. + $EXIST_HOME/exist-samples/src/main/resources/org/exist/samples/ant + directory. diff --git a/src/main/xar-resources/data/ant-tasks/listings/listing-1.xml b/src/main/xar-resources/data/ant-tasks/listings/listing-1.xml index a4780572..9f9e9197 100644 --- a/src/main/xar-resources/data/ant-tasks/listings/listing-1.xml +++ b/src/main/xar-resources/data/ant-tasks/listings/listing-1.xml @@ -1,3 +1 @@ - - - \ No newline at end of file + \ No newline at end of file diff --git a/src/main/xar-resources/data/ant-tasks/listings/listing-2.xml b/src/main/xar-resources/data/ant-tasks/listings/listing-2.xml deleted file mode 100644 index aadcf9b5..00000000 --- a/src/main/xar-resources/data/ant-tasks/listings/listing-2.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/src/main/xar-resources/data/backup/backup.xml b/src/main/xar-resources/data/backup/backup.xml index 9cfc6913..84cbe38f 100644 --- a/src/main/xar-resources/data/backup/backup.xml +++ b/src/main/xar-resources/data/backup/backup.xml @@ -160,7 +160,7 @@ eXist-db can also create incremental backups, meaning only resources which were modified since the last backup are backed up. All backups will be stored in ZIP format. The default storage directory is - webapp/WEB-INF/data/export/. You can configure a different + $EXIST_HOME/data/export/. You can configure a different directory in the configuration file conf.xml. @@ -170,7 +170,7 @@ You can use eXist-db's scheduler to schedule server-side backup and consistency check tasks. To do this, add the following definition to the scheduler section in the configuration file - conf.xml + $EXIST_HOME/etc/conf.xml @@ -423,9 +423,9 @@ Stop the running eXist database instance - Change into directory EXIST_HOME/webapp/WEB-INF/data or + Change into directory $EXIST_HOME/data or another directory you specified as data directory in the configuration - (conf.xml). + ($EXIST_HOME/etc/conf.xml). Remove all .dbx, .lck and diff --git a/src/main/xar-resources/data/configuration/listings/listing-1.xml b/src/main/xar-resources/data/configuration/listings/listing-1.xml index 6ce14408..b231cfeb 100644 --- a/src/main/xar-resources/data/configuration/listings/listing-1.xml +++ b/src/main/xar-resources/data/configuration/listings/listing-1.xml @@ -1,7 +1,7 @@ - + - + \ No newline at end of file diff --git a/src/main/xar-resources/data/contentextraction/contentextraction.xml b/src/main/xar-resources/data/contentextraction/contentextraction.xml index 3e25f21e..d7575869 100644 --- a/src/main/xar-resources/data/contentextraction/contentextraction.xml +++ b/src/main/xar-resources/data/contentextraction/contentextraction.xml @@ -23,20 +23,6 @@ - - Enabling the Content Extraction Module - - To enable the content extraction module, edit - $EXIST_HOME/extensions/build.properties and set the - include.feature.contentextraction property to true: - - Next, run bin/build.sh or bin/build.bat to build the module. - You should see in the output the various libraries from the Tika project downloaded and - installed. - - - - Usage diff --git a/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml b/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml index 5c463069..b691d33f 100644 --- a/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml +++ b/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml @@ -310,8 +310,8 @@ index. void configure(BrokerPool pool, String dataDir, Element config) Notifies the Index a data directory (normally - ${EXIST_HOME}/webapp/WEB-INF/data) and the configuration element - in which it is declared. + ${EXIST_HOME}/data) and the configuration element in which it + is declared. void open() Method that is executed when the Index is opened, whatever it means. Consider this method as an initialization and allocate the necessary @@ -1327,36 +1327,7 @@ few of its features will be demonstrated, but we will explain again what happens under the hood. The first step is to make sure to have a recent enough release version of eXist: - 4.7.0 or later. - Then, you have to prepare eXist to build the spatial index library. To do that, go - into the ${EXIST_HOME}/extensions/indexes directory and, if - necessary, copy build.properties to a new file, - local.properties. - Open this file and check that include.index.spatial is set to - true. - Invoke build.bat clean or build.sh clean, - depending on your platform, from a command line. This will generate - ${EXIST_HOME}/extensions/indexes/build.xml, which is needed by - the modularized indexes infrastructure. - Invoke build.bat extension-indexes or build.sh - extension-indexes, depending on your platform, from a command line. - If necessary, the required external (large) libraries will be downloaded into the - ${EXIST_HOME}/extensions/indexes/spatial/lib directory. Most - of them have a gt2-*.jar name. Make sure to make them available - in your application's classpath ! - - If you are behind a proxy, do not forget to change the settings in - ${EXIST_HOME}/build.properties. - - A file named exist-spatial-module.jar should be generated into - the ${EXIST_HOME}/lib/extensions directory. - Enable the spatial index and the spatial module in - ${EXIST_HOME}/conf.xml if it is not already done. - The spatial index: - - The spatial module: - - This concludes the prerequisites for running the test. + 4.7.0 or later, and Java 8. Our demonstration file is taken from the Ordnance Survey of Great-Britain's WWW site which offers port-talbot.gml) this will allow eXist to recognise it as an XML file. - If you have previously executed build test, the file should + If you have previously executed mvn test, the file should have been downloaded and gunzipped for you in - ${EXIST_HOME}/extensions/indexes/spatial/src/test/resources. + $EXIST_HOME/extensions/indexes/spatial/target/test-classes. Since this file refers to an OSGB-hosted schema, we will need to bypass validation - in ${EXIST_HOME}/conf.xml. + in ${EXIST_HOME}/etc/conf.xml. Make sure the mode value is set like this: <validation mode="no"> We are now ready to start the demonstration and we will use the interactive client @@ -1424,12 +1395,11 @@ If you want to have a look at the spatial index HSQLDB, which, if you are using - the default data-dir, is in - ${EXIST_HOME}/webapp/WEB-INF/data/spatial_index.* there is a - dedicated script file in - ${EXIST_HOME}/extensions/indexes/spatial/. to launch HSQL's GUI - client: Use either hsql.bat or hsql.sh - [data-dir] (you only need to supply data-dir if it is not the default + the default data-dir, is in ${EXIST_HOME}/data/spatial_index.* + there is a dedicated script file in + ${EXIST_HOME}/extensions/indexes/spatial/. to launch HSQL's + GUI client: Use either hsql.bat or hsql.sh + [data-dir] (you only need to supply data-dir if it is not the default one). If the SQL command SELECT * FROM SPATIAL_INDEX_V1; is executed, the result window shows that 21961 geometries have been indexed. diff --git a/src/main/xar-resources/data/devguide_log4j/devguide_log4j.xml b/src/main/xar-resources/data/devguide_log4j/devguide_log4j.xml index 0bdfe8e9..a98b3f36 100644 --- a/src/main/xar-resources/data/devguide_log4j/devguide_log4j.xml +++ b/src/main/xar-resources/data/devguide_log4j/devguide_log4j.xml @@ -154,8 +154,9 @@ Acquire a logger: - import org.apache.Log4j.Logger; -… private Logger logger = Logger.getLogger("xx.method.server.httpgw"); + import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +… private Logger logger = LogManager.getLogger("xx.method.server.httpgw"); Remarks: @@ -277,7 +278,8 @@ Configuring Log4j - The Log4j.xml configuration file controls Log4j’s behavior. + The $EXIST_HOME/etc/log4j2.xml configuration file controls Log4j’s + behavior. It is used mainly to set a given level of log output for loggers. Without such configuration only ERROR and FATAL log events will show up. Therefore you have to change @@ -514,17 +516,6 @@ - - Don’t be afraid to use Log4j in any tier or JVM - - Log4j currently is not included in the client jar set. The only reason - for this is that currently no clients use Log4j. However, if the - log4j.jar is needed in the client simply include it in the - client's jar set. Java’s Pack200 technology reduces jars to 25% their - original size on average. - - - diff --git a/src/main/xar-resources/data/exist-building/exist-building.xml b/src/main/xar-resources/data/exist-building/exist-building.xml index 6731c77d..d6187f97 100644 --- a/src/main/xar-resources/data/exist-building/exist-building.xml +++ b/src/main/xar-resources/data/exist-building/exist-building.xml @@ -4,7 +4,7 @@ Building eXist-db - 2Q18 + 2Q19 operations java-development @@ -12,7 +12,9 @@ - This article will tell you how to build a Java .jar file for eXist-db. If you are building exist-db from source, please also check the build instructions in the source-code repo. + This article will tell you how to build eXist-db from source, please also check the build instructions + in the source-code repo. @@ -21,36 +23,68 @@ Building eXist-db is quite easy and requires 3 simple steps: + + + Make sure you have the required build tools installed + + + Java JDK - Building eXist-db requires JDK 8 or newer. If you are looking for an OpenJDK, then the Azul Zulu JDK may suite you. + + + Apache Maven - Building eXist-db requires Maven 3.6.0 or newer. + + + Docker (optional) - If you wish to build the Docker image, then Docker is required. + + + HFS Support (optional) - If you are on Linux and wish to build a DMG for Mac platforms. + + + CentOS etc. - sudo yum install hfsutils hfsplus-tools + + + Debian etc. - sudo apt-get install hfsprogs hfsplus + + + + + Apple Developer Code signing certificate (optional) - If you are on a Mac and wish to build and sign a DMG. + + + + Clone from Github - The GitHub URL for the develop branche is: - git@github.com:eXist-db/exist.git + The GitHub URL for the develop branch is: + https://github.com/eXist-db/exist.git Please follow the instructions on our GitHub page page ( README.md section) + You can clone it by running: + git clone --single-branch --branch=develop https://github.com/eXist-db/exist.git + The above will only clone the develop branch, if you require all branches, you should omit the --single-branch --branch=develop arguments. Set JAVA_HOME - Before starting the build, your JAVA_HOME environment variable should be set to point to the root directory of the JAVA JDK - (note: JDK, not JRE!). Open a console or a DOS box on windows and type: + Before starting the build, your JAVA_HOME environment variable should be + set to point to the root directory of the JAVA JDK (note: JDK, not JRE!). Open a console on Unix/Linux, or a DOS cmd prompt on + Windows and type: set JAVA_HOME=c:\path\to\jdk on Windows or export JAVA_HOME=/path/to/jdk - on Unix. + on Unix/Linux. Build eXist Change into the eXist-db directory you just checked out and call - build.bat - on Windows or on Unix: - build.sh + mvn -DskipTests clean compile @@ -60,508 +94,171 @@ Using the Build System - You can rebuild all eXist-db packages from the standard distribution or the GitHub repository. You can even create a new distribution from - the one you installed. For example, assume you installed eXist using the installer GUI, but you need to have a .tar.bz2 package for deployment - to a server. Just call the main build script (build.sh or build.bat) and pass it the - target dist-bz2: - build.sh dist-bz2 - This will create a fresh .tar.bz2 archive in the dist directory. + You can rebuild all eXist-db packages and distributions from the cloned source code: + mvn -DskipTests clean package + This will create a fresh distributions in the exist-distribution/target directory, and a fresh installer in the exist-installer/target directory. - To be able to use the build system, you need to include the "source" module when selecting installable packages in the installer - GUI. + If you wish to also build a Docker image, you should add the property -Ddocker=true. + If you wish to also build a signed DMG on Mac, you should add the properties -Dmac-signing=true -Dmac.codesign.identity="The ID of your Apple Developer Certificate". - eXist-db relies on Ant for all compile and build tasks. Ant is included in the distribution (directory tools/ant). As - already mentioned above, there are two shell scripts to start Ant: build.sh or build.bat. The shell - scripts will take care to create a proper command line to launch Java with the Ant version included in the distribution. - Calling Ant without further argument will compile the sources and create the main .jar files (exist.jar, - exist-optional.jar, start.jar). - - build.sh -plists the available build targets. Passing one of these as argument to ant will call execute the corresponding - target. The main targets are: - Useful Build Targets - + Useful Maven targets - all - - - Compile the sources and create the main .jar files (exist.jar, - exist-optional.jar, start.jar). - - - - - benchmark - - - Performs the benchmark tests for eXist-db. - - - - - clean - - - Cleans the files and directories generated by a previous build. Data is preserved. - - - - - clean-all - - - Cleanup deeper. - - - - - clean-conf - - - Cleanup config file. - - - - - clean-default-data-dir - - - Remove contents in default data directory. - - - - - compile - - - Compiles the source code. - - - - - compile-aspectj - - - Compiles the aspects. - - - - - dist-dir - - - Packages eXist-db into a directory. - - - - - dist-bz2 - - - Packages eXist-db into a .tar.bz2 file. - - - - - dist-tar + mvn clean - Packages eXist-db into a .tar file. + Cleans the files and directories generated by a previous build. Data is not preserved unless you have overriden the path to the data directory. - dist-tgz + mvn compile - Packages eXist-db into a .tgz file. + Recompiles any changed source code. - dist-zip + mvn dependency:analyze - Packages eXist-db into a .zip file. + Checks for any problems with the dependencies that eXist-db depends on. - download-additional-jars + mvn test - Download optional third-party .jar files. These are currently: saxon. These are downloaded into - lib/user/. + Runs all tests across all modules. Surefire HTML reports can be found in the modules target/surefire-reports/html folder. - download-icu4j + mvn install - Download the optional icu4j library. + Installs all Maven artifacts to your local Maven repository (i.e. Unix/Linux: ~/.m2/repository, or Windows: %USERPROFILE%\.m2\repository. - download-xars + mvn package - Download xars to include in installer. + Performs the full lifecycle build, after which eXist-db distributions can be found in exist-distribution/target, and an eXist-db IzPack installer can be found in exist-installer/target. + + +
+ + Useful Maven properties and arguments + + - download-xqts - - - Download XQTS file. - - - - - download-xslts - - - Download XSLTS file. - - - - - extension-modules - - - Build the extensions directory. Edit the file extensions/build.properties enable extensions and modules. - - - - - installer - - - Creates a new installer package based on IzPack. - - - - - installer-exe - - - Create .exe from installer - - - - - jar - - - The default: compiles the source and creates eXist's main .jar files. - - - - - javadocs - - - Creates the API docs into webapp/api. - - - - - jdepend - - - JDepend traverses Java class file directories and generates design quality metrics for each Java package. - - - - - jetty-keygen - - - Generate keystore for jetty. - - - - - jnlp-clean - - - - - - jnlp-keygen + -V - Generate keystore for signing .jar files. + Show the version of Maven and Java used for the build. - jnlp-pack200 + -o - Pack all .jar files. + Execute Maven in offline (i.e. no Internet access!) mode. - jnlp-sign-all + -U - This signs all of the .jar files, so that the webstart of the eXist-db - client Java application will launch without any signing errors. + Force Maven to check online for any updates to dependency versions. - jnlp-sign-core + -T - Sign all CORE .jar files. + Force Maven to execute the lifecycle for the reactor modules in parallel. For example -T 2C instructs Maven to use 2x the core count of threads to parallelise the build. This can have a large positive imapact on build times. - jnlp-sign-exist + -Ddocker=true - Sign all EXIST .jar files. + Enable buiding eXist-db Docker images. - jnlp-unsign-all + -Dmac.signing=true - This unsigns all of the .jar files. + Enable signing of Mac .app and .DMG files (only on Mac platforms). - rebuild + -Dmac.codesign.identity="The ID of your Apple Developer Certificate" - Performs a clean and the all. + Specify the certificate for signing of Mac .app and .DMG files (only on Mac platforms). - samples + -DskipTests - Builds the examples and packs them into examples.jar. + Do not execute any tests. - snapshot-installer + -Ddependency-check.skip=true - Creates a snapshot installer. + Skip the OWASP dependency security analysis. - test + -Dtest=MyTestClassName - Runs all tests in the test suite and outputs the HTML result into test/junit/html. This may take several - minutes. + The name of a single test to run. If running Maven from the root of the project as opposed to inside the specific module which houses the test, you sould also add -DfailIfNoTests=false. - xquery + -DtrimStackTrace=false - Regenerate the XQuery parser code with ANTLR (only required if you change - src/org/exist/xquery/parser/XQuery.g). + When running tests, if a stacktrace is produced as part of an error, show the full output instead of trimming it. - xars + MAVEN_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005" - Scan apps directory and include all .xar files into installer. + When this precedes the mvn command, Maven will be run through the Java debugger, which allows you to connect from IntelliJ or another IDE which support JDWP.
- - You might want to set some custom settings (in particular your HTTP proxy when external libraries are required) before running - build.sh or build.bat. See build.properties. - - - - - Signing <code>.jar</code> files for webstart - - The database can be easily accessed with the Java client, when the client is launched by clicking the Java Webstart "Launch" button on the right side of this page. Java webstart - explicilty requires that all application code, the .jar files, are signed using a security certificate. Out of the box, - when eXist-db is installed using the installer, all relevant .jar files have already been signed, so webstart can be used directly. - It is necessary however to (re-)sign the .jar files yourself if you want to (re-)build the eXist-db java code. This chapter - explains how to do this. - - - - - Quickstart - - To get started quickly, just execute the following command: - ./build.sh -f build/scripts/jarsigner.xml - This command sequentially creates the key.store file and signs a selection of .jar files: - - Note that this command needs to be executed just once. In subsequent builds newly generated .jar files are signed - automatically. - - - - - - Ant targets - - An overview of all available ant targets can be retrieved by executing the following command: - ./build.sh -projecthelp -f build/scripts/jarsigner.xml - The following ant targets are available for signing .jar files: - - - jnlp-all - - Create keystore file and sign all EXIST and CORE .jar files. (Default task) - - - - - jnlp-keygen - - Generate a new keystore file if not present. - - - - jnlp-clean - - Delete the keystore file. - - - - jnlp-sign-core - - Sign all CORE .jar files in lib/core. - - - - jnlp-sign-exist - - Sign all EXIST .jar files, e.g. exist.jar - exist-XX.jar and start.jar - - - - - jnlp-unsign-all - - Unsign all .jar files. - - - - The target jnlp-keygen generates a new certificate file key.store. If this file is - present the EXIST .jar files are signed during each following build. The process of signing - .jar files can be stopped by removing this keystore file. - The ant script contains two additional targets: jetty-keygen which generates a keystore file for the - jetty server and jnlp-pack200 which processes the signed .jar files with pack200 technology. More about the latter in the next section. - - - - - - Reducing <code>.jar</code> sizes with pack200 compression - - Pack200 is a compression technology designed for compressing .jar files. It works most efficiently on Java class files. - Pack200 can reduce the size of a .jar file up to 60% resulting into a significant reduction of the amount of downloaded webstart - data. - The webstart .jar files can be compressed with pack200 with the following command: - ./build.sh -f build/scripts/jarsigner.xml jnlp-pack200 - This command consecutively performs the following steps for all .jar files: - - - unsign - - - repack (normalization) - - - sign - - - compress with pack200 - - - compress with gzip - - - - - - - - - References - - - - - Java Web Start (Wikipedia) - - - Java Web Start: Pack200 - compression (Wikipedia) - - - - Pack200 (Wikipedia) - - - - Pack200 (Eclipse.org) - - - - Pack200 and - Compression for network deployment (Sun, bit out dated) - - - Introducing Java SE 6 update 10: Deployment Usability (Sun). - - - Ant tasks: ASOCAT. - - - - - - - - Notes - - - - Sometimes when the .jar files are signed, eXist-db does not start anymore. In this situation unsign the .jar - files first. Calling target 'jnlp-pack200' does always unsign all .jar files as first step. - - - The pack200 target is not executed automatically. If eXist-db code is changed and recompiled, you might want to execute the - jnlp-pack200 target again. - - - - - diff --git a/src/main/xar-resources/data/extensions/extensions.xml b/src/main/xar-resources/data/extensions/extensions.xml index 357ae2e7..60e61624 100644 --- a/src/main/xar-resources/data/extensions/extensions.xml +++ b/src/main/xar-resources/data/extensions/extensions.xml @@ -27,12 +27,12 @@ eXist-db database, its internal API, the context of the executing XQuery and the HTTP Session (if appropriate). The source code for extension modules should be placed in their own folder inside - $EXIST_HOME/extensions/modules/src/org/exist/xquery/modules. They may - then be compiled in place using either $EXIST_HOME/build.sh - extension-modules or %EXIST_HOME%\build.bat - extension-modules depending on the platform. + $EXIST_HOME/extensions/modules/*/src/main/java/org/exist/xquery/modules/*. + They may then be added to $EXIST_HOME/extensions/modules/pom.xml and + compiled in place using mvn compile. Modules associated to modularized indexes must be placed in the - $EXIST_HOME/extensions/indexes/*/xquery/modules/* hierarchy. They + $EXIST_HOME/extensions/indexes/*/xquery/modules/* hierarchy. They + may then be added to $EXIST_HOME/extensions/indexes/pom.xml. They will be compiled automatically by the standard build targets or as indicated above. eXist-db must also be told which modules to load, this is done in @@ -65,10 +65,12 @@ Status: production - Class: org.exist.xquery.modules.example.ExampleModule + Class: org.exist.xquery.modules.example.ExampleModule + - Namespace: http://exist-db.org/xquery/examples + Namespace: http://exist-db.org/xquery/examples + @@ -86,10 +88,12 @@ Status: production - Class: org.exist.xquery.modules.cache.CacheModule + Class: org.exist.xquery.modules.cache.CacheModule + - Namespace: http://exist-db.org/xquery/cache + Namespace: http://exist-db.org/xquery/cache + @@ -111,7 +115,8 @@ - Namespace: http://exist-db.org/xquery/compression + Namespace: http://exist-db.org/xquery/compression + @@ -130,10 +135,12 @@ Status: production - Class: org.exist.xquery.modules.exi.EXIModule + Class: org.exist.xquery.modules.exi.EXIModule + - Namespace: http://exist-db.org/xquery/exi + Namespace: http://exist-db.org/xquery/exi + @@ -153,10 +160,12 @@ Status: production - Class: org.exist.xquery.modules.file.FileModule + Class: org.exist.xquery.modules.file.FileModule + - Namespace: http://exist-db.org/xquery/file + Namespace: http://exist-db.org/xquery/file + @@ -178,10 +187,12 @@ Status: production - Class: org.exist.xquery.modules.image.ImageModule + Class: org.exist.xquery.modules.image.ImageModule + - Namespace: http://exist-db.org/xquery/image + Namespace: http://exist-db.org/xquery/image + @@ -190,10 +201,6 @@ This extension module allows you to access and manipulate JNDI-based directories, such as LDAP, using XQuery functions. It can be very useful if you want to integration and LDAP directory into an eXist-db/XQuery based application. - To compile it, set the parameter include.module.jndi = true in - $EXIST_HOME/extensions/local.build.properties file (create it if - missing). Then, to enable it, edit the appropriate module entry in - conf.xml. Creator: Andrzej Taramina @@ -205,10 +212,12 @@ Status: production - Class: org.exist.xquery.modules.jndi.JNDIModule + Class: org.exist.xquery.modules.jndi.JNDIModule + - Namespace: http://exist-db.org/xquery/jndi + Namespace: http://exist-db.org/xquery/jndi + @@ -230,10 +239,12 @@ Status: production - Class: org.exist.xquery.modules.mail.MailModule + Class: org.exist.xquery.modules.mail.MailModule + - Namespace: http://exist-db.org/xquery/mail + Namespace: http://exist-db.org/xquery/mail + @@ -254,10 +265,12 @@ Status: production - Class: org.exist.xquery.modules.oracle.OracleModule + Class: org.exist.xquery.modules.oracle.OracleModule + - Namespace: http://exist-db.org/xquery/oracle + Namespace: http://exist-db.org/xquery/oracle + @@ -280,7 +293,8 @@ - Namespace: http://exist-db.org/xquery/scheduler + Namespace: http://exist-db.org/xquery/scheduler + @@ -303,16 +317,17 @@ - Namespace: http://exist-db.org/xquery/simple-ql + Namespace: http://exist-db.org/xquery/simple-ql + Spatial module Various functions for GML geometries, + xlink:href="http://www.opengeospatial.org/standards/gml">GML geometries, whether indexed or not. More information about the design is available here. + xlink:href="devguide_indexes.xml">here. Creator: Pierrick Brihaye @@ -324,10 +339,12 @@ Status: experimental - Class: org.exist.xquery.modules.spatial.SpatialModule + Class: org.exist.xquery.modules.spatial.SpatialModule + - Namespace: http://exist-db.org/xquery/spatial + Namespace: http://exist-db.org/xquery/spatial + @@ -349,10 +366,12 @@ Status: production - Class: org.exist.xquery.modules.sql.SQLModule + Class: org.exist.xquery.modules.sql.SQLModule + - Namespace: http://exist-db.org/xquery/sql + Namespace: http://exist-db.org/xquery/sql + @@ -374,10 +393,12 @@ Status: production - Class: org.exist.xquery.modules.xmldiff.XmlDiffModule + Class: org.exist.xquery.modules.xmldiff.XmlDiffModule + - Namespace: http://exist-db.org/xquery/xmldiff + Namespace: http://exist-db.org/xquery/xmldiff + @@ -398,28 +419,12 @@ Status: production - Class: org.exist.xquery.modules.xslfo.XSLFOModule - - - Namespace: http://exist-db.org/xquery/xslfo - - - - - XML Calabash Module - This module provides simple integration with XML Calabash XProc engine. - - - Creator: James Fuller - - - Licence: MPL v1.1 - - - Class: org.exist.xquery.modules.xmlcalabash + Class: org.exist.xquery.modules.xslfo.XSLFOModule + - Namespace: http://xmlcalabash.com + Namespace: http://exist-db.org/xquery/xslfo + diff --git a/src/main/xar-resources/data/java-admin-client/java-admin-client.xml b/src/main/xar-resources/data/java-admin-client/java-admin-client.xml index 943a120b..d4afaaf4 100644 --- a/src/main/xar-resources/data/java-admin-client/java-admin-client.xml +++ b/src/main/xar-resources/data/java-admin-client/java-admin-client.xml @@ -244,10 +244,9 @@ If you ever run into problems while experimenting with eXist-db and your database files get corrupt: just remove the data files created by eXist-db and everything should work again. The data files all end with - .dbx. You will either find them in directory - webapp/WEB-INF/data or WEB-INF/data, - depending on your installation. It is ok to backup those data-files to be able - to restore them in case of a database corruption. + .dbx. You will find them in directory + $EXIST_HOME/data. It is ok to backup those data-files to + be able to restore them in case of a database corruption. @@ -310,9 +309,9 @@ This is equivalent to the -ouri=xmldb:exist:// option shown above. When launching the client with option -l or - -ouri=xmldb:exist:// the configuration for the database - instance is read from conf.xml located in - EXIST_HOME. + -ouri=xmldb:exist:// the configuration for the + database instance is read from conf.xml located in + $EXIST_HOME/etc. Use the -C parameter to specify an alternate database location. For instance: bin/client.sh -C /home/exist/test/conf.xml diff --git a/src/main/xar-resources/data/newrangeindex/newrangeindex.xml b/src/main/xar-resources/data/newrangeindex/newrangeindex.xml index c849bbdf..4e92f0a8 100644 --- a/src/main/xar-resources/data/newrangeindex/newrangeindex.xml +++ b/src/main/xar-resources/data/newrangeindex/newrangeindex.xml @@ -46,7 +46,7 @@ Store this definition and do a re-index. Index files are created in the - webapp/WEB-INF/data/range directory (or wherever you configured your + $EXIST_HOME/data/range directory (or wherever you configured your data directory to be). The indexes will be used automatically for general or value comparisons, as well as string functions like fn:contains, fn:starts-with, diff --git a/src/main/xar-resources/data/production_good_practice/production_good_practice.xml b/src/main/xar-resources/data/production_good_practice/production_good_practice.xml index f1ff7c41..96aa6987 100644 --- a/src/main/xar-resources/data/production_good_practice/production_good_practice.xml +++ b/src/main/xar-resources/data/production_good_practice/production_good_practice.xml @@ -276,7 +276,7 @@ We recommend to prevent eXist's REST server from directly receiving web requests, and use URL Rewriting only to control code execution. The REST server feature is enabled by default in - $EXIST_HOME/webapp/WEB-INF/web.xml. Changing the + $EXIST_HOME/etc/webapp/WEB-INF/web.xml. Changing the param-value to true, allows you to filter request via your own XQuery controller. @@ -288,7 +288,7 @@ We recommend to restrict the REST servers ability to execute XQuery code to authenticated users, by modifying: - $EXIST_HOME/webapp/WEB-INF/web.xml: + $EXIST_HOME/etc/webapp/WEB-INF/web.xml: @@ -297,7 +297,7 @@ In addition, we recommend to restrict the REST servers ability to execute XUpdate statements. Simply modify - $EXIST_HOME/webapp/WEB-INF/web.xmlby + $EXIST_HOME/etc/webapp/WEB-INF/web.xmlby changing the param-value from enabled to disabled: @@ -446,8 +446,8 @@ of resources from the server to the client, hopefully resulting in a faster experience for the end-user. GZip Compression can be enabled in web.xml, which can be found in - either $EXIST_HOME/webapp/WEB-INF/web.xml for default deployments or - $EXIST_HOME/tools/jetty/etc/standalone/WEB-INF/web.xml for standalone + either $EXIST_HOME/etc/webapp/WEB-INF/web.xml for default deployments or + $EXIST_HOME/etc/jetty/standalone/WEB-INF/web.xml for standalone deployments. diff --git a/src/main/xar-resources/data/troubleshooting/troubleshooting.xml b/src/main/xar-resources/data/troubleshooting/troubleshooting.xml index 9d721a54..f0fe81e6 100644 --- a/src/main/xar-resources/data/troubleshooting/troubleshooting.xml +++ b/src/main/xar-resources/data/troubleshooting/troubleshooting.xml @@ -76,13 +76,9 @@ Make sure eXist-db is not running - If you installed the source code (and therefore the development tools), call - ant as follows: - build.sh clean-default-data-dir - If you do not have build.sh (or build.bat), you may - can manually remove the contents of your data directory. - The default data directory is - $EXIST_HOME/webapp/WEB-INF/data + Manually remove the contents of your data directory. + The default data directory is $EXIST_HOME/data + @@ -90,14 +86,11 @@ - <code>JAVA_HOME</code> and <code>EXIST_HOME</code> Environmental Variables - - When using one of the shell or batch scripts, eXist-db can fail to start up properly - if either of the two key environmental variables JAVA_HOME and/or - EXIST_HOME are not set properly. Both variables are used in the - startup.bat and startup.sh scripts and have to be - set correctly before the scripts are run (you can of course also insert the lines - required in the beginning of the scripts themselves). + <code>JAVA_HOME</code> Environment Variable + + When using one of the shell or batch scripts, eXist-db may fail to start up properly + if the environment variableJAVA_HOME is not set properly. The + variable us used by all scripts in $EXIST_HOME/bin. JAVA_HOME @@ -108,8 +101,8 @@ Windows Setting JAVA_HOME on Windows + xlink:href="http://confluence.atlassian.com/display/DOC/Setting+the+JAVA_HOME+Variable+in+Windows" + >Setting JAVA_HOME on Windows @@ -117,54 +110,22 @@ Linux Setting JAVA_HOME on Linux + xlink:href="http://www.cyberciti.biz/faq/linux-unix-set-java_home-path-variable/" + >Setting JAVA_HOME on Linux macOS Setting JAVA_HOME on macOS - - - - - - - EXIST_HOME - - This must point to the directory that contains eXist-db's configuration - file conf.xml. For example, if the - EXIST_HOME path is C:\Program - Files\eXist, the server will look for C:\Program - Files\eXist\conf.xml. - You can set EXIST_HOME in the same way that you set - JAVA_HOME. - On macOS, depending on how you installed eXist, you would open a terminal - and enter either: - - - for JAR based installs - - export EXIST_HOME=/Applications/eXist - - - - for DMG and homebrew installs - - export EXIST_HOME=/Applications/eXist-db.app/Contents/Resources/eXist-db + xlink:href="http://osxdaily.com/2015/07/28/set-enviornment-variables-mac-os-x/" + >Setting JAVA_HOME on macOS - . - - Ensure that you have "write" permissions for the data directory - (located by default in webapp/WEB-INF/). @@ -177,23 +138,19 @@ service occupies these ports, you cannot start up eXist-db unless you shut down the service in question or make eXist-db use another port. To see whether this is the case, enter http://localhost:8080/ in your browser. To - make eXist-db use another port, open /tools/jetty/etc/jetty-http.xml - and change the value 8080 to a port number that is not used (for instance + xlink:href="http://localhost:8080/">http://localhost:8080/ in your browser. + To make eXist-db use another port, open + $EXIST_HOME/etc/jetty/jetty-http.xml and change the value + 8080 to a port number that is not used (for instance 8899): eXist-db uses port 8443 for confidential communication. Another service may be using this port. To make eXist-db use another port, open the file - /tools/jetty/etc/jetty-ssl.xml and change the value 8443 - in to a port number that is not used (for instance 8444): + $EXIST_HOME/etc/jetty/jetty-ssl.xml and change the value + 8443 in to a port number that is not used (for instance + 8444): - If these changes do not launch eXist-db try the following: Change to the directory - where you installed eXist-db and enter the following command: - java -Xmx1024M -Djava.endorsed.dirs=lib/endorsed -jar start.jar jetty - If you have problems running the shell/batch scripts, read the section about alternative - scripts. @@ -207,11 +164,7 @@ By default, this output is written to the directory - webapp/WEB-INF/logs - - - If you are running eXist as a service, check the directory - tools/yajsw/logs + $EXIST_HOME/logs The main log files for eXist are exist.log and diff --git a/src/main/xar-resources/data/tuning/listings/listing-3.txt b/src/main/xar-resources/data/tuning/listings/listing-3.txt index dad1fbd2..640d6200 100644 --- a/src/main/xar-resources/data/tuning/listings/listing-3.txt +++ b/src/main/xar-resources/data/tuning/listings/listing-3.txt @@ -1,2 +1,2 @@ \ No newline at end of file + files="../data" pageSize="4096" nodesBuffer="-1"> \ No newline at end of file diff --git a/src/main/xar-resources/data/tuning/tuning.xml b/src/main/xar-resources/data/tuning/tuning.xml index 3d0a764f..03620ddb 100644 --- a/src/main/xar-resources/data/tuning/tuning.xml +++ b/src/main/xar-resources/data/tuning/tuning.xml @@ -22,30 +22,23 @@ Memory settings - Java always limits the maximum amount of memory available to a process. So eXist-db will not automatically use all of the available memory on your machine. The maximum amount of memory Java will allocate is determined by the - -Xmx parameter passed to Java on the command line. + -Xmx parameter passed to Java on the command line. When eXist-db is started via the graphical launcher or via one of the shell or batch - scripts, memory settings are read from the file vm.properties: + scripts, memory settings are read from the file + $EXIST_HOME/etc/launcher.properties: - - - For Unix systems, this is done in - $EXIST_HOME/bin/functions.d/eXist-settings.sh, with the - JAVA_OPTIONS variable. The CLIENT_JAVA_OPTIONS - variable does the same for the Java admin client. You can override those variables + For Unix/Linux systems, this is done in the .sh + files, for instance $EXIST_HOME/bin/startup.sh, from the + JAVA_OPTS evironment variable. You can override those variables globally in your own shell. On Windows,this is done in the main .bat files, for instance $EXIST_HOME\bin\startup.bat. - If you launch eXist-db as a service, all Java settings will be - controlled by the service wrapper. In this case, the file to edit - is EXIST_HOME/tools/yajsw/conf/wrapper.conf: - - + Cache settings @@ -56,8 +49,8 @@ them a few moment later. This "trashing effect" results in an immediate performance drop, in particular while indexing documents. All caches share a single memory pool, whose size is determined by the attribute - cacheSize in the db-connection section of - conf.xml: + cacheSize in the db-connection section of + $EXIST_HOME/etc/conf.xml: The global cache manager will dynamically grant more memory to caches while they are under load and free memory used by idle caches. diff --git a/src/main/xar-resources/data/upgrading/listings/sign.txt b/src/main/xar-resources/data/upgrading/listings/sign.txt deleted file mode 100644 index adbbb375..00000000 --- a/src/main/xar-resources/data/upgrading/listings/sign.txt +++ /dev/null @@ -1 +0,0 @@ -./build.sh jnlp-unsign-all all jnlp-sign-exist jnlp-sign-core jnlp-sign-exist-extensions diff --git a/src/main/xar-resources/data/upgrading/upgrading.xml b/src/main/xar-resources/data/upgrading/upgrading.xml index 544791e9..26ce1efb 100644 --- a/src/main/xar-resources/data/upgrading/upgrading.xml +++ b/src/main/xar-resources/data/upgrading/upgrading.xml @@ -60,12 +60,10 @@ Remove the still empty data directory from the new installation. By default the data directory is - located in webapp/WEB-INF/data. If you are not sure where the data directory - is, check the main logfile + located at $EXIST_HOME/data. If you are not sure where the data directory is, + check the main logfile exist.log - , searching for entries after start-up pertaining to - DATA_DIR. - + , searching for entries after start-up pertaining to DATA_DIR. Copy the entire existing data directory, and paste it to the location of the new data directory (the directory you deleted in the previous step). @@ -96,15 +94,33 @@ of ways: - Use Backup Central from the Dashboard (with "Zip" option for databases with less then 4GB) + Use Backup Central from the Dashboard - The Emergency Backup Tool (GUI) for installer based systems: - java -jar start.jar -Xmx2048m org.exist.backup.ExportGUI + The Emergency Export Tool (GUI): + + + Unix/Linux: + bin/export-gui.sh + + + Windows: + bin\export-gui.bat + + The Emergency Backup Tool (CLI) for headless sytems: - java -jar start.jar org.exist.backup.ExportMain -x -z + + + Unix/Linux: + bin/export.sh + + + Windows: + bin\export.bat + + Via XQuery: @@ -112,19 +128,17 @@ Once the backup is complete, you should check the backup report in the - export - directory within either the - data - directory (for backups created via the Dashboard or Xquery) or - $EXIST-HOME - (for backups created by the Emergency Backup Tool). + export directory within either the data directory (for backups + created via the Dashboard or Xquery) or $EXIST_HOME (for backups created by + the Emergency Backup Tool). Normally this report just contains the list of collections which were backed up. If you see any warnings or errors, it is even more important to perform a “full restore” of your backed-up data. Stop the existing installation of eXist. - Install the new version of eXist. DO not install one eXist version over another one. Always install the new version into a fresh new directory. + Install the new version of eXist. DO NOT install one eXist version over another one. + Always install the new version into a fresh new directory. Perform a full restore of the backup onto the new version of @@ -137,33 +151,32 @@ Upgrading from Source - The following steps only apply to users who wish to upgrade eXist instances that were build from (modified) source code, instead of from the provided installers. - Before attempting to upgrade always perform a - full backup - and make a copy of local.build.properties - if it exists. Stop eXist after the backup has been generated. - Determine which files contain local modification and would be in conflic with updated files from the new version of exist-db, by running - git status inside the local folder where you cloned exist. You should pay special attention to Configuration files, such as: + The following steps only apply to users who wish to upgrade eXist instances that were + built from (modified) source code, instead of from the provided installers. + Before attempting to upgrade always perform a full + backup. Stop eXist after the backup has been generated. + Determine which files contain local modification and would be in conflict with updated files + from the new version of exist-db, by running git status inside the local + folder where you cloned exist. You should pay special attention to Configuration files, + such as: - conf.xml + etc/conf.xml - webapp/WEB-INF/controller-config.xml + etc/webapp/WEB-INF/controller-config.xml - tools/jetty/webapps/exist-webapp-context.xml + etc/jetty/webapps/exist-webapp-context.xml - - If you previously signed your jar files, run - git checkout -- lib/ to unsign them. You should no longer see any files if you run - git status again now: A typical sequence to replay the local modifications on top of the upstream changes to the master branch would look like this: - Finally follow the build instructions for exist-db, and copy back the local.build.properties file if you had one. You can sign the jar files by running: + Finally follow the build + instructions for eXist-db. diff --git a/src/main/xar-resources/data/urlrewrite/urlrewrite.xml b/src/main/xar-resources/data/urlrewrite/urlrewrite.xml index b50aab03..853be2a0 100644 --- a/src/main/xar-resources/data/urlrewrite/urlrewrite.xml +++ b/src/main/xar-resources/data/urlrewrite/urlrewrite.xml @@ -243,7 +243,7 @@ This means that paths starting with /tools will be mapped to the collection hierarchy below /db/www. Everything else is handled by the catch all pattern pointing to the root directory of the webapp (by default corresponding - to EXIST_HOME/webapp). For example, the URI + to $EXIST_HOME/etc/webapp). For example, the URI http://localhost:8080/exist/tools/admin/admin.xql will be handled by the controller stored in database collection /db/www/admin/ (if there is one) or will directly resolve to diff --git a/src/main/xar-resources/data/validation/validation.xml b/src/main/xar-resources/data/validation/validation.xml index d95f2173..96dd2036 100644 --- a/src/main/xar-resources/data/validation/validation.xml +++ b/src/main/xar-resources/data/validation/validation.xml @@ -125,9 +125,7 @@ In the preceding example ${WEBAPP_HOME} can be substituted by a file:// URL pointing to the webapp directory of eXist - (for instance $EXIST_HOME/webapp/) or the equivalent directory of a - deployed WAR file when eXist is deployed in a servlet container (for instance - ${CATALINA_HOME}/webapps/exist/) + (for instance $EXIST_HOME/etc/webapp/). Here is an example of a catalog file: diff --git a/src/main/xar-resources/data/webdav/listings/listing-1.txt b/src/main/xar-resources/data/webdav/listings/listing-1.txt index 97f67f6b..b0025567 100644 --- a/src/main/xar-resources/data/webdav/listings/listing-1.txt +++ b/src/main/xar-resources/data/webdav/listings/listing-1.txt @@ -1,5 +1,5 @@ ## XML Serialization options for the WevDAV -## The file is read from EXIST_HOME +## The file is read from $EXIST_HOME/etc ## Be carefull changing the default values ! indent=no expand-xincludes=no diff --git a/src/main/xar-resources/data/webdav/webdav.xml b/src/main/xar-resources/data/webdav/webdav.xml index ac0e996c..a9fbab40 100644 --- a/src/main/xar-resources/data/webdav/webdav.xml +++ b/src/main/xar-resources/data/webdav/webdav.xml @@ -272,9 +272,9 @@ When retrieving an XML document via the WebDAV interface, the default serialization settings as defined in conf.xml are used. It is however possible to define custom serialization settings specific for the WebDAV interface. - Copy the file extensions/webdav/webdav.properties into - $EXIST_HOME directory and uncomment/modify the parameters. Changes in - this file requires a restart of eXist-db. + Copy the file extensions/webdav/src/main/resources/webdav.properties + into $EXIST_HOME/etc directory and uncomment/modify the parameters. Changes + in this file requires a restart of eXist-db. diff --git a/src/main/xar-resources/data/xforms/xforms.xml b/src/main/xar-resources/data/xforms/xforms.xml index 84f35bd8..edef284a 100644 --- a/src/main/xar-resources/data/xforms/xforms.xml +++ b/src/main/xar-resources/data/xforms/xforms.xml @@ -162,14 +162,14 @@ System global, by editing - $EXIST_HOME/webapp/WEB-INF/betterform-config.xml: + $EXIST_HOME/etc/webapp/WEB-INF/betterform-config.xml: <property name="filter.ignoreResponseBody" value="false"> Change the value of the property filter.ignoreResponseBody to true and restart eXist-db. By removing the configuration for XFormsFilter in - $EXIST_HOME/webapp/WEB-INF/web.xml. By commenting the + $EXIST_HOME/etc/webapp/WEB-INF/web.xml. By commenting the filter-mapping XForms processing will be disabled. However note that betterFORM still get loaded on the classpath. diff --git a/src/main/xar-resources/data/xquery/xquery.xml b/src/main/xar-resources/data/xquery/xquery.xml index b1d13740..c421bf91 100644 --- a/src/main/xar-resources/data/xquery/xquery.xml +++ b/src/main/xar-resources/data/xquery/xquery.xml @@ -588,7 +588,8 @@ java.text.RuleBasedCollator. For example: The .jar with the .class file(s) of the collator needs to be - in ${EXIST_HOME}/lib/user + placed in ${EXIST_HOME}/lib and added to the appropriate classpath + config file in ${EXIST_HOME}/etc, for standard server deployments this is ${EXIST_HOME}/etc/startup.xml. From d5bef2b85684761226504325cfd9f513e502f5ed Mon Sep 17 00:00:00 2001 From: duncdrum Date: Sat, 18 May 2019 12:43:24 +0200 Subject: [PATCH 2/7] fix(data): display errors and orphaned listings, update change date --- .../advanced-installation.xml | 2 +- .../data/ant-tasks/ant-tasks.xml | 2 +- src/main/xar-resources/data/backup/backup.xml | 2 +- .../contentextraction/contentextraction.xml | 2 +- .../contentextraction/listings/listing-1.txt | 2 - .../devguide_indexes/devguide_indexes.xml | 7 +- .../devguide_indexes/listings/listing-120.xml | 4 - .../devguide_indexes/listings/listing-121.xml | 14 --- .../data/devguide_log4j/devguide_log4j.xml | 4 +- .../data/exist-building/exist-building.xml | 2 +- .../exist-building/listings/listing-11.txt | 21 ---- .../exist-building/listings/listing-14.txt | 51 -------- .../data/extensions/extensions.xml | 2 +- .../java-admin-client/java-admin-client.xml | 2 +- .../data/newrangeindex/newrangeindex.xml | 2 +- .../listings/listing-3.xml | 17 ++- .../production_good_practice.xml | 2 +- .../troubleshooting/listings/listing-6.xml | 12 +- .../troubleshooting/listings/listing-8.xml | 12 +- .../data/troubleshooting/troubleshooting.xml | 2 +- .../data/tuning/listings/listing-2.txt | 3 - src/main/xar-resources/data/tuning/tuning.xml | 2 +- .../data/upgrading/upgrading.xml | 2 +- .../data/urlrewrite/listings/listing-4.xml | 4 +- .../data/urlrewrite/listings/listing-5.xml | 4 +- .../data/urlrewrite/listings/listing-9.xml | 14 +-- .../data/urlrewrite/urlrewrite.xml | 2 +- .../data/validation/listings/listing-1.xml | 8 +- .../data/validation/listings/listing-2.xml | 10 +- .../data/validation/listings/listing-3.xml | 22 ++-- .../data/validation/listings/listing-4.xml | 4 +- .../data/validation/listings/listing-5.xml | 8 +- .../data/validation/listings/listing-6.xml | 12 +- .../data/validation/listings/listing-7.txt | 30 ++--- .../data/validation/listings/listing-8.xml | 22 ++-- .../data/validation/validation.xml | 4 +- src/main/xar-resources/data/webdav/webdav.xml | 118 +++++++++--------- .../data/xforms/listings/listing-3.xml | 28 ++--- src/main/xar-resources/data/xforms/xforms.xml | 2 +- .../data/xquery/listings/listing-19.txt | 22 ++-- src/main/xar-resources/data/xquery/xquery.xml | 2 +- 41 files changed, 192 insertions(+), 295 deletions(-) delete mode 100644 src/main/xar-resources/data/contentextraction/listings/listing-1.txt delete mode 100644 src/main/xar-resources/data/devguide_indexes/listings/listing-120.xml delete mode 100644 src/main/xar-resources/data/devguide_indexes/listings/listing-121.xml delete mode 100644 src/main/xar-resources/data/exist-building/listings/listing-11.txt delete mode 100644 src/main/xar-resources/data/exist-building/listings/listing-14.txt delete mode 100644 src/main/xar-resources/data/tuning/listings/listing-2.txt diff --git a/src/main/xar-resources/data/advanced-installation/advanced-installation.xml b/src/main/xar-resources/data/advanced-installation/advanced-installation.xml index b0cd975b..841b5bb7 100644 --- a/src/main/xar-resources/data/advanced-installation/advanced-installation.xml +++ b/src/main/xar-resources/data/advanced-installation/advanced-installation.xml @@ -8,7 +8,7 @@ Advanced Installation Methods - 1Q18 + 2Q19 installation operations diff --git a/src/main/xar-resources/data/ant-tasks/ant-tasks.xml b/src/main/xar-resources/data/ant-tasks/ant-tasks.xml index 214e90c7..a8c9abe7 100644 --- a/src/main/xar-resources/data/ant-tasks/ant-tasks.xml +++ b/src/main/xar-resources/data/ant-tasks/ant-tasks.xml @@ -8,7 +8,7 @@ Ant Tasks - 1Q18 + 2Q19 operations diff --git a/src/main/xar-resources/data/backup/backup.xml b/src/main/xar-resources/data/backup/backup.xml index 84cbe38f..9cd02ea2 100644 --- a/src/main/xar-resources/data/backup/backup.xml +++ b/src/main/xar-resources/data/backup/backup.xml @@ -6,7 +6,7 @@ Database Backup and Restore - 1Q18 + 2Q19 operations diff --git a/src/main/xar-resources/data/contentextraction/contentextraction.xml b/src/main/xar-resources/data/contentextraction/contentextraction.xml index d7575869..b87386ee 100644 --- a/src/main/xar-resources/data/contentextraction/contentextraction.xml +++ b/src/main/xar-resources/data/contentextraction/contentextraction.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Extracting Content from Binary Files - 1Q18 + 2Q19 application-development diff --git a/src/main/xar-resources/data/contentextraction/listings/listing-1.txt b/src/main/xar-resources/data/contentextraction/listings/listing-1.txt deleted file mode 100644 index 27d857e2..00000000 --- a/src/main/xar-resources/data/contentextraction/listings/listing-1.txt +++ /dev/null @@ -1,2 +0,0 @@ -# Binary Content and Metadata Extraction Module -include.feature.contentextraction = true \ No newline at end of file diff --git a/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml b/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml index b691d33f..61c3e431 100644 --- a/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml +++ b/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Developer's Guide to Modularized Indexes - 1Q19 + 2Q19 java-development indexes @@ -429,8 +429,9 @@ Returns an array of org.exist.dom.DocumentImpl.Occurrences that is an ordered list of the index entries, in a textual form, associated with the number of occurences for the entries and a list of the documents - containing them. For some indexes, the concept of ordered or textual occurrences - might not be meaningful. + containing them. + For some indexes, the concept of ordered or textual occurrences + might not be meaningful. diff --git a/src/main/xar-resources/data/devguide_indexes/listings/listing-120.xml b/src/main/xar-resources/data/devguide_indexes/listings/listing-120.xml deleted file mode 100644 index 6ccc8a0a..00000000 --- a/src/main/xar-resources/data/devguide_indexes/listings/listing-120.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - - \ No newline at end of file diff --git a/src/main/xar-resources/data/devguide_indexes/listings/listing-121.xml b/src/main/xar-resources/data/devguide_indexes/listings/listing-121.xml deleted file mode 100644 index 6e17049e..00000000 --- a/src/main/xar-resources/data/devguide_indexes/listings/listing-121.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - ... - - - - ... - - - - ... - - - \ No newline at end of file diff --git a/src/main/xar-resources/data/devguide_log4j/devguide_log4j.xml b/src/main/xar-resources/data/devguide_log4j/devguide_log4j.xml index a98b3f36..f8ac099a 100644 --- a/src/main/xar-resources/data/devguide_log4j/devguide_log4j.xml +++ b/src/main/xar-resources/data/devguide_log4j/devguide_log4j.xml @@ -3,7 +3,7 @@ schematypens="http://purl.oclc.org/dsdl/schematron"?>
Log4j Logging Guide - 1Q18 + 2Q19 java-development @@ -639,4 +639,4 @@ import org.apache.logging.log4j.Logger; -
\ No newline at end of file + diff --git a/src/main/xar-resources/data/exist-building/exist-building.xml b/src/main/xar-resources/data/exist-building/exist-building.xml index d6187f97..28f6b347 100644 --- a/src/main/xar-resources/data/exist-building/exist-building.xml +++ b/src/main/xar-resources/data/exist-building/exist-building.xml @@ -26,6 +26,7 @@ Make sure you have the required build tools installed + Java JDK - Building eXist-db requires JDK 8 or newer. If you are looking for an OpenJDK, then the Azul Zulu JDK may suite you. @@ -51,7 +52,6 @@ Apple Developer Code signing certificate (optional) - If you are on a Mac and wish to build and sign a DMG. - diff --git a/src/main/xar-resources/data/exist-building/listings/listing-11.txt b/src/main/xar-resources/data/exist-building/listings/listing-11.txt deleted file mode 100644 index 7971c9f6..00000000 --- a/src/main/xar-resources/data/exist-building/listings/listing-11.txt +++ /dev/null @@ -1,21 +0,0 @@ -./build.sh -f build/scripts/jarsigner.xml -Starting Ant... - -Buildfile: ..../eXist-db/build/scripts/jarsigner.xml - -jnlp-prepare: - -jnlp-keygen: - [genkey] Generating Key for exist - -jnlp-sign-exist: - [signjar] Signing JAR: ..../eXist-db/exist-fluent.jar to ..../eXist-db/exist-fluent.jar as exist - [signjar] Signing JAR: ..../eXist-db/exist-optional.jar to ..../eXist-db/exist-optional.jar as exist - [signjar] Signing JAR: ..../eXist-db/exist.jar to ..../eXist-db/exist.jar as exist - [signjar] Signing JAR: ..../eXist-db/start.jar to ..../eXist-db/start.jar as exist - -jnlp-sign-core: - [signjar] Signing JAR: ..../eXist-db/lib/core/antlr-2.7.7.jar to ..../eXist-db/lib/core/antlr-2.7.7.jar as exist - [signjar] Signing JAR: ..../eXist-db/lib/core/commons-collections-3.2.1.jar to ..../eXist-db/lib/core/commons-collections-3.2.1.jar as exist - .... - [signjar] Signing JAR: ..../eXist-db/lib/core/xmlrpc-server-3.1.3.jar to ..../eXist-db/lib/core/xmlrpc-server-3.1.3.jar as exist \ No newline at end of file diff --git a/src/main/xar-resources/data/exist-building/listings/listing-14.txt b/src/main/xar-resources/data/exist-building/listings/listing-14.txt deleted file mode 100644 index 9d910a23..00000000 --- a/src/main/xar-resources/data/exist-building/listings/listing-14.txt +++ /dev/null @@ -1,51 +0,0 @@ -./build.sh -f build/scripts/jarsigner.xml jnlp-pack200 - Starting Ant... - - Buildfile: .../eXist-db/build/scripts/jarsigner.xml - - jnlp-pack200: - - jnlp-unsign-all: - [unsignjar] Unsigning exist-fluent.jar - [unsignjar] Unsigning exist-optional.jar - [unsignjar] Unsigning exist.jar - [unsignjar] Unsigning start.jar - [unsignjar] Unsigning antlr-2.7.7.jar - ... - [unsignjar] Unsigning xmlrpc-server-3.1.3.jar - [repack] Normalizing exist-fluent.jar - [repack] Normalizing exist-optional.jar - [repack] Normalizing exist.jar - [repack] Normalizing start.jar - [repack] Normalizing antlr-2.7.7.jar - ... - [repack] Normalizing xmlrpc-server-3.1.3.jar - - jnlp-prepare: - - jnlp-keygen: - - jnlp-sign-exist: - [signjar] Signing JAR: .../eXist-db/exist-fluent.jar to .../eXist-db/exist-fluent.jar as exist - [signjar] Signing JAR: .../eXist-db/exist-optional.jar to .../eXist-db/exist-optional.jar as exist - [signjar] Signing JAR: .../eXist-db/exist.jar to .../eXist-db/exist.jar as exist - [signjar] Signing JAR: .../eXist-db/start.jar to .../eXist-db/start.jar as exist - - jnlp-prepare: - - jnlp-keygen: - - jnlp-sign-core: - [signjar] Signing JAR: .../eXist-db/lib/core/antlr-2.7.7.jar to .../eXist-db/lib/core/antlr-2.7.7.jar as exist - ... - [signjar] Signing JAR: .../eXist-db/lib/core/xmlrpc-server-3.1.3.jar to .../eXist-db/lib/core/xmlrpc-server-3.1.3.jar as exist - [pack] Packing exist-fluent.jar - [pack] Packing exist-optional.jar - [pack] Packing exist.jar - [pack] Packing start.jar - [pack] Packing antlr-2.7.7.jar - ... - [pack] Packing xmlrpc-server-3.1.3.jar - - BUILD SUCCESSFUL - Total time: 1 minute 0 seconds \ No newline at end of file diff --git a/src/main/xar-resources/data/extensions/extensions.xml b/src/main/xar-resources/data/extensions/extensions.xml index 60e61624..2dbb6fe9 100644 --- a/src/main/xar-resources/data/extensions/extensions.xml +++ b/src/main/xar-resources/data/extensions/extensions.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Extension Modules - 1Q18 + 2Q19 java-development diff --git a/src/main/xar-resources/data/java-admin-client/java-admin-client.xml b/src/main/xar-resources/data/java-admin-client/java-admin-client.xml index d4afaaf4..4a8a3fce 100644 --- a/src/main/xar-resources/data/java-admin-client/java-admin-client.xml +++ b/src/main/xar-resources/data/java-admin-client/java-admin-client.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Java Admin Client - 1Q18 + 2Q19 operations diff --git a/src/main/xar-resources/data/newrangeindex/newrangeindex.xml b/src/main/xar-resources/data/newrangeindex/newrangeindex.xml index 4e92f0a8..082edfd7 100644 --- a/src/main/xar-resources/data/newrangeindex/newrangeindex.xml +++ b/src/main/xar-resources/data/newrangeindex/newrangeindex.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Range Index - 1Q18 + 2Q19 indexing diff --git a/src/main/xar-resources/data/production_good_practice/listings/listing-3.xml b/src/main/xar-resources/data/production_good_practice/listings/listing-3.xml index 3ec46618..17af91ca 100644 --- a/src/main/xar-resources/data/production_good_practice/listings/listing-3.xml +++ b/src/main/xar-resources/data/production_good_practice/listings/listing-3.xml @@ -1,12 +1,9 @@ -         - -             - -                 -                 -                 - -             - + + + + + + + diff --git a/src/main/xar-resources/data/production_good_practice/production_good_practice.xml b/src/main/xar-resources/data/production_good_practice/production_good_practice.xml index 96aa6987..5550fc34 100644 --- a/src/main/xar-resources/data/production_good_practice/production_good_practice.xml +++ b/src/main/xar-resources/data/production_good_practice/production_good_practice.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Production Use - Good Practice - 1Q18 + 2Q19 operations diff --git a/src/main/xar-resources/data/troubleshooting/listings/listing-6.xml b/src/main/xar-resources/data/troubleshooting/listings/listing-6.xml index a9f638e5..57d66033 100644 --- a/src/main/xar-resources/data/troubleshooting/listings/listing-6.xml +++ b/src/main/xar-resources/data/troubleshooting/listings/listing-6.xml @@ -1,7 +1,7 @@ - - - - - - \ No newline at end of file + + + + + + diff --git a/src/main/xar-resources/data/troubleshooting/listings/listing-8.xml b/src/main/xar-resources/data/troubleshooting/listings/listing-8.xml index fd6cc023..a1695fcf 100644 --- a/src/main/xar-resources/data/troubleshooting/listings/listing-8.xml +++ b/src/main/xar-resources/data/troubleshooting/listings/listing-8.xml @@ -1,7 +1,7 @@ - - - - - - \ No newline at end of file + + + + + + diff --git a/src/main/xar-resources/data/troubleshooting/troubleshooting.xml b/src/main/xar-resources/data/troubleshooting/troubleshooting.xml index f0fe81e6..a805aac9 100644 --- a/src/main/xar-resources/data/troubleshooting/troubleshooting.xml +++ b/src/main/xar-resources/data/troubleshooting/troubleshooting.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Troubleshooting - 1Q18 + 2Q19 operations diff --git a/src/main/xar-resources/data/tuning/listings/listing-2.txt b/src/main/xar-resources/data/tuning/listings/listing-2.txt deleted file mode 100644 index 40c96c51..00000000 --- a/src/main/xar-resources/data/tuning/listings/listing-2.txt +++ /dev/null @@ -1,3 +0,0 @@ -# Maximum Java Heap Size (in MB) -# alternative for wrapper.java.additional.=-Xmx -wrapper.java.maxmemory=NNNN \ No newline at end of file diff --git a/src/main/xar-resources/data/tuning/tuning.xml b/src/main/xar-resources/data/tuning/tuning.xml index 03620ddb..661f0b3b 100644 --- a/src/main/xar-resources/data/tuning/tuning.xml +++ b/src/main/xar-resources/data/tuning/tuning.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Tuning the Database - 1Q18 + 2Q19 operations application-development diff --git a/src/main/xar-resources/data/upgrading/upgrading.xml b/src/main/xar-resources/data/upgrading/upgrading.xml index 26ce1efb..30df3c04 100644 --- a/src/main/xar-resources/data/upgrading/upgrading.xml +++ b/src/main/xar-resources/data/upgrading/upgrading.xml @@ -3,7 +3,7 @@
Upgrade Guide - 4Q18 + 2Q19 operations diff --git a/src/main/xar-resources/data/urlrewrite/listings/listing-4.xml b/src/main/xar-resources/data/urlrewrite/listings/listing-4.xml index 5c507e70..5242f6b7 100644 --- a/src/main/xar-resources/data/urlrewrite/listings/listing-4.xml +++ b/src/main/xar-resources/data/urlrewrite/listings/listing-4.xml @@ -1,3 +1,3 @@ - - \ No newline at end of file + + diff --git a/src/main/xar-resources/data/urlrewrite/listings/listing-5.xml b/src/main/xar-resources/data/urlrewrite/listings/listing-5.xml index 23eb47f7..820cd373 100644 --- a/src/main/xar-resources/data/urlrewrite/listings/listing-5.xml +++ b/src/main/xar-resources/data/urlrewrite/listings/listing-5.xml @@ -1,3 +1,3 @@ - - \ No newline at end of file + + diff --git a/src/main/xar-resources/data/urlrewrite/listings/listing-9.xml b/src/main/xar-resources/data/urlrewrite/listings/listing-9.xml index e8df9bac..56a4feab 100644 --- a/src/main/xar-resources/data/urlrewrite/listings/listing-9.xml +++ b/src/main/xar-resources/data/urlrewrite/listings/listing-9.xml @@ -1,8 +1,8 @@ - - - - - - - \ No newline at end of file + + + + + + + diff --git a/src/main/xar-resources/data/urlrewrite/urlrewrite.xml b/src/main/xar-resources/data/urlrewrite/urlrewrite.xml index 853be2a0..e91b2692 100644 --- a/src/main/xar-resources/data/urlrewrite/urlrewrite.xml +++ b/src/main/xar-resources/data/urlrewrite/urlrewrite.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> URL Rewriting - 1Q18 + 2Q19 application-development diff --git a/src/main/xar-resources/data/validation/listings/listing-1.xml b/src/main/xar-resources/data/validation/listings/listing-1.xml index 8c8d0e9b..f28361f3 100644 --- a/src/main/xar-resources/data/validation/listings/listing-1.xml +++ b/src/main/xar-resources/data/validation/listings/listing-1.xml @@ -1,5 +1,5 @@ - - - - \ No newline at end of file + + + + diff --git a/src/main/xar-resources/data/validation/listings/listing-2.xml b/src/main/xar-resources/data/validation/listings/listing-2.xml index f5b89ef8..14685c29 100644 --- a/src/main/xar-resources/data/validation/listings/listing-2.xml +++ b/src/main/xar-resources/data/validation/listings/listing-2.xml @@ -1,6 +1,6 @@ - - - - - \ No newline at end of file + + + + + diff --git a/src/main/xar-resources/data/validation/listings/listing-3.xml b/src/main/xar-resources/data/validation/listings/listing-3.xml index 3e7b52da..f7da8fef 100644 --- a/src/main/xar-resources/data/validation/listings/listing-3.xml +++ b/src/main/xar-resources/data/validation/listings/listing-3.xml @@ -1,12 +1,12 @@ - - - - - - - - - - - \ No newline at end of file + + + + + + + + + + + diff --git a/src/main/xar-resources/data/validation/listings/listing-4.xml b/src/main/xar-resources/data/validation/listings/listing-4.xml index 10bade06..2481c487 100644 --- a/src/main/xar-resources/data/validation/listings/listing-4.xml +++ b/src/main/xar-resources/data/validation/listings/listing-4.xml @@ -1,3 +1,3 @@ - - \ No newline at end of file + + diff --git a/src/main/xar-resources/data/validation/listings/listing-5.xml b/src/main/xar-resources/data/validation/listings/listing-5.xml index 9f47c674..0c916eb4 100644 --- a/src/main/xar-resources/data/validation/listings/listing-5.xml +++ b/src/main/xar-resources/data/validation/listings/listing-5.xml @@ -1,5 +1,5 @@ - valid - MyNameSpace - 106 - \ No newline at end of file + valid + MyNameSpace + 106 + diff --git a/src/main/xar-resources/data/validation/listings/listing-6.xml b/src/main/xar-resources/data/validation/listings/listing-6.xml index 4429f9a3..1b15b14e 100644 --- a/src/main/xar-resources/data/validation/listings/listing-6.xml +++ b/src/main/xar-resources/data/validation/listings/listing-6.xml @@ -1,7 +1,7 @@ - invalid - MyNameSpace - 39 - cvc-datatype-valid.1.2.1: 'aaaaaaaa' is not a valid value for 'decimal'. - cvc-type.3.1.3: The value 'aaaaaaaa' of element 'c' is not valid. - \ No newline at end of file + invalid + MyNameSpace + 39 + cvc-datatype-valid.1.2.1: 'aaaaaaaa' is not a valid value for 'decimal'. + cvc-type.3.1.3: The value 'aaaaaaaa' of element 'c' is not valid. + diff --git a/src/main/xar-resources/data/validation/listings/listing-7.txt b/src/main/xar-resources/data/validation/listings/listing-7.txt index 5658dc5b..61108865 100644 --- a/src/main/xar-resources/data/validation/listings/listing-7.txt +++ b/src/main/xar-resources/data/validation/listings/listing-7.txt @@ -1,19 +1,13 @@ - - invalid - 2 - - java.net.MalformedURLException - unknown protocol: foo - java.net.MalformedURLException: unknown protocol: foo - at java.net.URL.(URL.java:574) - at java.net.URL.(URL.java:464) - at java.net.URL.(URL.java:413) - at org.exist.xquery.functions.validation.Shared.getStreamSource(Shared.java:140) - at org.exist.xquery.functions.validation.Shared.getInputSource(Shared.java:190) - at org.exist.xquery.functions.validation.Parse.eval(Parse.java:179) - at org.exist.xquery.BasicFunction.eval(BasicFunction.java:68) - at ...... - - - \ No newline at end of file + + invalid + 2 + + java.net.MalformedURLException + unknown protocol: foo + java.net.MalformedURLException: unknown protocol: foo at java.net.URL.(URL.java:574) at java.net.URL.(URL.java:464) at java.net.URL.(URL.java:413) at + org.exist.xquery.functions.validation.Shared.getStreamSource(Shared.java:140) at org.exist.xquery.functions.validation.Shared.getInputSource(Shared.java:190) at org.exist.xquery.functions.validation.Parse.eval(Parse.java:179) at + org.exist.xquery.BasicFunction.eval(BasicFunction.java:68) at ...... + + + diff --git a/src/main/xar-resources/data/validation/listings/listing-8.xml b/src/main/xar-resources/data/validation/listings/listing-8.xml index be622ebc..40e2fc25 100644 --- a/src/main/xar-resources/data/validation/listings/listing-8.xml +++ b/src/main/xar-resources/data/validation/listings/listing-8.xml @@ -1,12 +1,12 @@ - - http://www.w3.org/XML/1998/namespace - file:/Users/guest/existdb/trunk/webapp//WEB-INF/entities/XMLSchema.xsd - http://www.w3.org/2001/xml.xsd - http://www.w3.org/2001/xml.xsd - - - http://www.w3.org/2001/XMLSchema - file:/Users/guest/existdb/trunk/schema/collection.xconf.xsd - - \ No newline at end of file + + http://www.w3.org/XML/1998/namespace + file:/Users/guest/existdb/trunk/webapp//WEB-INF/entities/XMLSchema.xsd + http://www.w3.org/2001/xml.xsd + http://www.w3.org/2001/xml.xsd + + + http://www.w3.org/2001/XMLSchema + file:/Users/guest/existdb/trunk/schema/collection.xconf.xsd + + diff --git a/src/main/xar-resources/data/validation/validation.xml b/src/main/xar-resources/data/validation/validation.xml index 96dd2036..69e00c9b 100644 --- a/src/main/xar-resources/data/validation/validation.xml +++ b/src/main/xar-resources/data/validation/validation.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> XML Validation - 2Q18 + 2Q19 application-development testing @@ -22,7 +22,7 @@ inserting documents into the database. - must use one of the + must use one of the provided XQuery extension functions. diff --git a/src/main/xar-resources/data/webdav/webdav.xml b/src/main/xar-resources/data/webdav/webdav.xml index a9fbab40..a49ec0a1 100644 --- a/src/main/xar-resources/data/webdav/webdav.xml +++ b/src/main/xar-resources/data/webdav/webdav.xml @@ -3,27 +3,27 @@ schematypens="http://purl.oclc.org/dsdl/schematron"?>
WebDAV - 4Q18 + 2Q19 getting-started interfaces - + - + eXist-db ships with a WebDAV interface. WebDAV makes it possible to manage database collections and documents just like directories and files in a file system. You can copy, move, delete, view or edit files with any application supporting the WebDAV protocol, including Windows Explorer, macOS Finder, cadaver, KDE Konqueror, oXygen XML Editor, XML Spy, LibreOffice and many others (see below). In the default configuration the WebDAV server can be accessed via the URLs http://localhost:8080/exist/webdav/db/ and https://localhost:8443/exist/webdav/db/ (since eXist-db 2.0). - + - + Compatibility - + The Milton project, on which eXist-db's WebDAV implementation is build, maintains a detailed WebDAV client compatibility list that describes a "Recipe for broad client compatibility." In case of any problems please read this document. Some @@ -48,19 +48,19 @@ (Linux), OxygenXML and LibreOffice. The following clients are reported to have issues: GVFS (Nautilus) and NetDrive. However, this can change over time! - + - + Clients - - - + + + - + Windows Web Folders - + Out of the box, Windows has some native support for the WebDAV protocol, but there are some well-known issues. Please consult the following: @@ -76,9 +76,9 @@ security. - - - + + + To use WebDAV in Internet explorer: @@ -96,16 +96,16 @@ - + - + macOS Finder - + The eXist-db database can be accessed easily with the macOS Finder using the Go, Connect to Server... menu. Use the eXist-db WebDAV URL http://localhost:8080/exist/webdav/db/. - + In some previous MacOS releases, Apple repetitively changed their WebDAV implementation significantly, introducing new bugs and problems. The main issue is that @@ -121,12 +121,12 @@ the client does not work perfectly, for instance at bulk operations. - + - + oXygen XML Editor - + Select File -> Open URL. @@ -165,59 +165,59 @@ on another folder or resource by mistake, you overwrite the wrong resource. - + - + davfs2 By default, non-XML files (plain text files, images, etc) are working as expected with davfs2. - Because eXist-db reports the size of XML documents as a multiple of the internal pagesize, you can list XML files - (ls -l) but you cannot view or edit them. The davfs2 logs (syslog/journalctl) contain: + Because eXist-db reports the size of XML documents as a multiple of the internal pagesize, you can list XML files + (ls -l) but you cannot view or edit them. The davfs2 logs (syslog/journalctl) contain: Could not read response body: connection was closed by server - In order to access XML files stored in eXist from a mounted directory in a filesystem via dafvs2, - have to add the following additional Java parameters when starting eXist: + In order to access XML files stored in eXist from a mounted directory in a filesystem via dafvs2, + have to add the following additional Java parameters when starting eXist: org.exist.webdav.PROPFIND_METHOD_XML_SIZE=EXACT org.exist.webdav.GET_METHOD_XML_SIZE=EXACT - + If eXist is installed as a service (systemd) the configuration has to be done in /tools/yajsw/conf/wrapper.conf - + - - NULL and APPROXIMATE values work for Oxygen and Cadaver but only EXACT can be used with davfs2. - - You must first uninstall the service before - modifying wrapper.conf, for changes to be applied when reinstalling: + + NULL and APPROXIMATE values work for Oxygen and Cadaver but only EXACT can be used with davfs2. + + You must first uninstall the service before + modifying wrapper.conf, for changes to be applied when reinstalling: - + - + Uninstall (with service name eXist-db) - + - + - + Reinstall and enable - + - + - + LinuxTested on davfs2 1.4.7 on RHEL7.5 and 1.5.4 on Arch Linux. - + - + - + KDE Konqueror - + Enter an URL like webdav://localhost:8080/exist/webdav/db. Use webdavs:// for WebDAV over SSL. @@ -228,12 +228,12 @@ - + - + LibreOffice - + For LibreOffice and OpenOffice.org the recommended way for opening documents stored in eXist-db is using the 'native' WebDAV client, as documented in the LibreOffice Help documentation. @@ -263,29 +263,29 @@ - + - + Serialization - + When retrieving an XML document via the WebDAV interface, the default serialization settings as defined in conf.xml are used. It is however possible to define custom serialization settings specific for the WebDAV interface. Copy the file extensions/webdav/src/main/resources/webdav.properties into $EXIST_HOME/etc directory and uncomment/modify the parameters. Changes in this file requires a restart of eXist-db. - + - + - + Notes - + From the community we have received feedback that the WebDAV interface is not fully functional when it is accessed via a reverse proxy and a resource's path is altered (aliased) with it. -
\ No newline at end of file +
diff --git a/src/main/xar-resources/data/xforms/listings/listing-3.xml b/src/main/xar-resources/data/xforms/listings/listing-3.xml index 53e4a96d..96419feb 100644 --- a/src/main/xar-resources/data/xforms/listings/listing-3.xml +++ b/src/main/xar-resources/data/xforms/listings/listing-3.xml @@ -1,15 +1,15 @@ - - - (: Apply xsltforms.xsl stylesheet :) - - - - - - - - - - - \ No newline at end of file + + + (: Apply xsltforms.xsl stylesheet :) + + + + + + + + + + + diff --git a/src/main/xar-resources/data/xforms/xforms.xml b/src/main/xar-resources/data/xforms/xforms.xml index edef284a..1eade61b 100644 --- a/src/main/xar-resources/data/xforms/xforms.xml +++ b/src/main/xar-resources/data/xforms/xforms.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> XForms Introduction - 1Q18 + 2Q19 application-development diff --git a/src/main/xar-resources/data/xquery/listings/listing-19.txt b/src/main/xar-resources/data/xquery/listings/listing-19.txt index f8818de0..2bbde3bc 100644 --- a/src/main/xar-resources/data/xquery/listings/listing-19.txt +++ b/src/main/xar-resources/data/xquery/listings/listing-19.txt @@ -1,14 +1,14 @@ declare namespace file="java:java.io.File"; - { - for $f in file:list-files( file:new(".") ) - let $n := file:get-name($f) - order by $n - return - if (file:is-directory($f)) then - - else - - } - \ No newline at end of file + { + for $f in file:list-files( file:new(".") ) + let $n := file:get-name($f) + order by $n + return + if (file:is-directory($f)) then + + else + + } + diff --git a/src/main/xar-resources/data/xquery/xquery.xml b/src/main/xar-resources/data/xquery/xquery.xml index c421bf91..6867bfc0 100644 --- a/src/main/xar-resources/data/xquery/xquery.xml +++ b/src/main/xar-resources/data/xquery/xquery.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> XQuery in eXist-db - 1Q18 + 2Q19 xquery From 777d8855e3559c84fb101dabf212dffdfec102b8 Mon Sep 17 00:00:00 2001 From: Adam Retter Date: Sat, 18 May 2019 18:29:15 +0400 Subject: [PATCH 3/7] Remove references to start.jar --- .../advanced-installation.xml | 16 +----- src/main/xar-resources/data/backup/backup.xml | 33 ++++++++++-- .../data/backup/listings/listing-7.txt | 53 ++++++++++++++++--- .../basic-installation/basic-installation.xml | 16 ++---- .../data/deployment/deployment.xml | 4 +- .../data/devguide_xmldb/devguide_xmldb.xml | 31 ++++++----- .../devguide_xmldb/listings/listing-1.txt | 13 ++++- .../java-admin-client/java-admin-client.xml | 24 --------- src/main/xar-resources/data/jmx/jmx.xml | 15 ++++-- .../data/tuning/listings/listing-1.txt | 3 +- 10 files changed, 129 insertions(+), 79 deletions(-) diff --git a/src/main/xar-resources/data/advanced-installation/advanced-installation.xml b/src/main/xar-resources/data/advanced-installation/advanced-installation.xml index 841b5bb7..96003a78 100644 --- a/src/main/xar-resources/data/advanced-installation/advanced-installation.xml +++ b/src/main/xar-resources/data/advanced-installation/advanced-installation.xml @@ -197,7 +197,6 @@ startup.sh (Unix) / startup.bat (Windows) - java -jar start.jar jetty Starts the included Jetty web server at port 8080. eXist runs as a web application, located at http://localhost:8080/exist/. @@ -206,7 +205,7 @@ shutdown.sh (Unix) / shutdown.bat (Windows) - java -jar start.jar shutdown -p youradminpassword + shutdown.sh -p youradminpassword Closes the running instance of eXist. If eXist has been started with startup.sh, calling shutdown.sh will also stop the Jetty web server. Otherwise, only the database is stopped by @@ -215,22 +214,11 @@ shutdown before killing the server process. - - server.sh (Unix) / server.bat (Windows) - - java -jar start.jar standalone - Launches eXist as a stand-alone server process. In this setup, eXist is - only accessible through the XMLRPC and the built-in HTTP interface. - - client.sh (Unix) / client.bat (Windows) - java -jar start.jar client Launches the Java Admin - Client. This application is also launched if no application is - selected on the command-line, like this: - java -jar start.jar + Client. diff --git a/src/main/xar-resources/data/backup/backup.xml b/src/main/xar-resources/data/backup/backup.xml index 9cd02ea2..4a1cde99 100644 --- a/src/main/xar-resources/data/backup/backup.xml +++ b/src/main/xar-resources/data/backup/backup.xml @@ -309,7 +309,16 @@ eXist also includes a command-line JMX client. Call it with parameter -s to see the latest consistency report: - java -jar start.jar org.exist.management.client.JMXClient -s + + + Unix/Linux: + $EXIST_HOME/bin/jmxclient.sh -s + + + WINDOWS: + $EXIST_HOME\bin\jmxclient.bat -s + + This may produce output as shown below: You can also subscribe to the notifications made available by the SanityReport @@ -550,7 +559,16 @@ This tool needs direct access to the database files, so you must stop the running database instance first if it is active. Use the following command line to start the utility as a GUI: - java -jar start.jar org.exist.backup.ExportGUI + + + Unix/Linux: + $EXIST_HOME/bin/export-gui.sh + + + WINDOWS: + $EXIST_HOME\bin\export-gui.bat + + @@ -564,7 +582,16 @@ consistency check and a full backup. On a headless system use the command-line version instead (The -h parameter will get you a list of possible options): - java -jar start.jar org.exist.backup.ExportMain + + + Unix/Linux: + $EXIST_HOME/bin/export.sh + + + WINDOWS: + $EXIST_HOME\bin\export.bat + + diff --git a/src/main/xar-resources/data/backup/listings/listing-7.txt b/src/main/xar-resources/data/backup/listings/listing-7.txt index 899e9b91..07b45943 100644 --- a/src/main/xar-resources/data/backup/listings/listing-7.txt +++ b/src/main/xar-resources/data/backup/listings/listing-7.txt @@ -1,6 +1,47 @@ -java -jar start.jar backup - -u [admin_username] - -p [admin_password] - -b [collection_path] - -d [target_path] - -ouri=[xml_uri] \ No newline at end of file +backup.sh --h + + Usage: backup.sh [Arguments] + + Arguments: + -b, --backup backup the specified collection. + : any string + Default: + -d, --dir specify the directory to use for + backups. + : a file path + Default: /Users/aretter/code/exist.maven/. + --deduplicate-blobs Deduplicate BLOBS in the backup. + : true or false + Default: false + -h, --help : an argument to print help for + Default: If no specific parameter is given the whole usage text is given + -o, --option= specify extra options: + property=value. For available properties see client. + properties. + =: where "" is any string and "" is any string + Default: Empty map + -p, --password set the password for connecting to + the database. + : any string + Default: + -P, --dba-password if the backup specifies a different + password for the admin user, use this option + to specify the new password. Otherwise + you will get a permission denied + : any string + Default: + -q, --quiet be quiet. Just print errors. + Default: disabled + -r, --restore read the specified __contents__.xml + file and restore the resources described + there. + : a file path + Default: /Users/aretter/code/exist.maven/. + -R, --rebuild rebuild the EXpath app repository + after restore. + Default: disabled + -u, --user set user. + : any string + Default: admin + -U, --gui start in GUI mode + Default: disabled \ No newline at end of file diff --git a/src/main/xar-resources/data/basic-installation/basic-installation.xml b/src/main/xar-resources/data/basic-installation/basic-installation.xml index d5e826c1..139f5d84 100644 --- a/src/main/xar-resources/data/basic-installation/basic-installation.xml +++ b/src/main/xar-resources/data/basic-installation/basic-installation.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Basic Installation - 3Q18 + 2Q19 installation getting-started @@ -303,14 +303,13 @@ Change (cd) to the directory where you installed eXist-db - (for instance, /usr/local/lib/exist/ for Linux, - /Applications/eXist/ for Mac, or C:\Program - Files\eXist for Windows). + (for instance, /opt/exist/ for Linux, + /Applications/eXist/ for Mac, or C:\eXist for Windows). - Simply calling start.jar will start eXist-db via the + Simply calling launcher.sh or launcher.bat will start eXist-db via the desktop launcher: - java -jar start.jar + $EXIST_HOME\bin\launcher.sh @@ -386,11 +385,6 @@ bin/shutdown.sh -u admin -p youradminpassword bin/shutdown.bat -u admin -p youradminpassword - - From the command line, run the following Java command, using your admin - account's credentials: - java -jar start.jar shutdown -u admin -p youradminpassword - From the Java Admin Client: select Connection, Shutdown from diff --git a/src/main/xar-resources/data/deployment/deployment.xml b/src/main/xar-resources/data/deployment/deployment.xml index 615b0a41..d950d4ce 100644 --- a/src/main/xar-resources/data/deployment/deployment.xml +++ b/src/main/xar-resources/data/deployment/deployment.xml @@ -3,7 +3,7 @@ schematypens="http://purl.oclc.org/dsdl/schematron"?>
Database Deployment - 1Q18 + 2Q19 operations java-development @@ -350,7 +350,7 @@ If your database is running in stand-alone mode, you must specify a different server URI. For instance, to stop eXist when running in stand-alone mode, listening on port 8088, use: - java -jar start.jar shutdown --uri=xmldb:exist://localhost:8088/xmlrpc + $EXIST_HOME/bin/shutdown.sh --uri=xmldb:exist://localhost:8088/xmlrpc diff --git a/src/main/xar-resources/data/devguide_xmldb/devguide_xmldb.xml b/src/main/xar-resources/data/devguide_xmldb/devguide_xmldb.xml index a668ceb8..85f386c1 100644 --- a/src/main/xar-resources/data/devguide_xmldb/devguide_xmldb.xml +++ b/src/main/xar-resources/data/devguide_xmldb/devguide_xmldb.xml @@ -3,7 +3,7 @@ schematypens="http://purl.oclc.org/dsdl/schematron"?>
Writing Java Applications with the XML:DB API - 1Q18 + 2Q19 java-development @@ -21,9 +21,10 @@ Introduction The preferred way to work with eXist-db when developing Java applications is to use - the XML:DB API. eXist-db's implementation of the XML:DB standards follows the XIndice - implementation, and conforms to the latest working drafts put forth by the XML:DB Initiative. For more - information, refer to the Javadocs for this API. + the XML:DB API. eXist-db's implementation of the XML:DB standard conforms to the latest + working drafts put forth by the XML:DB Initiative. For + more information, refer to the Javadocs for this API. The basic components employed by the XML:DB API are drivers, collections, resources and services. @@ -37,11 +38,10 @@ document or a document fragment, selected by a previously executed XPath query. Finally, services are requested for special tasks such as querying a collection with XPath, or managing a collection. - There are several XML:DB examples provided in eXist's samples - directory . To start an example, use the start.jar jar file and pass - the name of the example class as the first parameter, for instance: - - + There are also several XML:DB examples provided in the + sample code + that accompanies the Integration chapter of the eXist-db book. + @@ -49,8 +49,10 @@ Using the XML:DB API - Programming with the XML:DB API is straightforward. You will find some code examples - in the samples/org/exist/examples/xmldb directory. + For working with eXist-db via XML:DB API, you will need two dependencies, one for the XML:DB API + and one for eXist-db's implementation of the API. These dependencies are available from Maven and should + be added to your Maven pom.xml or project's dependency tool like so: + In the following simple example, a document is retrieved from the eXist server and printed to standard output. @@ -156,7 +158,10 @@ Extensions to XML:DB - eXist provides extensions on top of the XML:DB specification. + eXist provides extensions on top of the XML:DB specification. + If you wish to use these extensions, you should make sure that the scope for your exist-core + dependency is set to compile. + @@ -205,4 +210,4 @@ in the configuration files. -
\ No newline at end of file +
diff --git a/src/main/xar-resources/data/devguide_xmldb/listings/listing-1.txt b/src/main/xar-resources/data/devguide_xmldb/listings/listing-1.txt index 1d49ba97..f1e7bc98 100644 --- a/src/main/xar-resources/data/devguide_xmldb/listings/listing-1.txt +++ b/src/main/xar-resources/data/devguide_xmldb/listings/listing-1.txt @@ -1 +1,12 @@ -java -jar start.jar org.exist.examples.xmldb.Retrieve [- other options] \ No newline at end of file + + net.sf.xmldb-org + xmldb-api + 1.7.0 + + + + org.exist-db + exist-core + 5.0.0 + runtime + \ No newline at end of file diff --git a/src/main/xar-resources/data/java-admin-client/java-admin-client.xml b/src/main/xar-resources/data/java-admin-client/java-admin-client.xml index 4a8a3fce..a3b8c63b 100644 --- a/src/main/xar-resources/data/java-admin-client/java-admin-client.xml +++ b/src/main/xar-resources/data/java-admin-client/java-admin-client.xml @@ -29,36 +29,12 @@ Windows and Linux users: Click the eXist-db icon in the taskbar and choose the Open Java Admin Client menu entry. - - You can download its Java WebStart file exist.jnlp via your web - browser. Once the download has completed, double-click it to launch the client: - - - - - - You can also find a link to download the Java WebStart file on the - dashboard. - - If you built eXist-db from source rather than using the downloadable - installer, the Java WebStart function will not work unless you sign the - jars. To do so, enter the following on your command line from the eXist - directory: - build.bat -f build/scripts/jarsigner.xml (DOS/Windows) - build.sh -f build/scripts/jarsigner.xml (Unix) - - Enter the following on your command line from the eXist installation directory (with the JAVA_HOME environment variable set correctly): bin\client.bat (DOS/Windows) bin/client.sh (Unix) - - Or enter the following on the command line (again from the eXist installation - directory): - java -jar start.jar client - diff --git a/src/main/xar-resources/data/jmx/jmx.xml b/src/main/xar-resources/data/jmx/jmx.xml index 12ce7361..be7ecb36 100644 --- a/src/main/xar-resources/data/jmx/jmx.xml +++ b/src/main/xar-resources/data/jmx/jmx.xml @@ -3,7 +3,7 @@ schematypens="http://purl.oclc.org/dsdl/schematron"?>
Java Management Extensions (JMX) - 1Q18 + 2Q19 java-development operations @@ -69,7 +69,16 @@ eXist includes a simple command-line JMX client which provides quick access to some important server statistics. - java -jar start.jar org.exist.management.client.JMXClient <params> + + + Unix/Linux: + $EXIST_HOME/bin/jmxclient.sh <params> + + + Windows: + $EXIST_HOME\bin\jmxclient.bat <params> + + This accepts the following command-line parameters: @@ -140,7 +149,7 @@ The following command should print some statistics about cache usage within eXist: - java -jar start.jar org.exist.management.client.JMXClient -c -w 2000 + $EXIST_home/bin/jmxclient.sh -c -w 2000 diff --git a/src/main/xar-resources/data/tuning/listings/listing-1.txt b/src/main/xar-resources/data/tuning/listings/listing-1.txt index 20410278..88028f07 100644 --- a/src/main/xar-resources/data/tuning/listings/listing-1.txt +++ b/src/main/xar-resources/data/tuning/listings/listing-1.txt @@ -1,6 +1,5 @@ # This file contains a list of VM parameters to be passed to Java -# when eXist is started by double clicking on start.jar (or calling -# "java -jar start.jar" without parameters on the shell). +# when eXist is started # Minimum and maximum memory memory.max=2048 From 46300e32d8e2301f8cf31f0415d8b99af0f4c7aa Mon Sep 17 00:00:00 2001 From: Joe Wicentowski Date: Sat, 18 May 2019 12:18:39 -0400 Subject: [PATCH 4/7] Fix Windows-related formulations --- src/main/xar-resources/data/backup/backup.xml | 6 +++--- .../data/basic-installation/basic-installation.xml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/xar-resources/data/backup/backup.xml b/src/main/xar-resources/data/backup/backup.xml index 4a1cde99..c3348817 100644 --- a/src/main/xar-resources/data/backup/backup.xml +++ b/src/main/xar-resources/data/backup/backup.xml @@ -315,7 +315,7 @@ $EXIST_HOME/bin/jmxclient.sh -s - WINDOWS: + Windows: $EXIST_HOME\bin\jmxclient.bat -s @@ -565,7 +565,7 @@ $EXIST_HOME/bin/export-gui.sh - WINDOWS: + Windows: $EXIST_HOME\bin\export-gui.bat @@ -588,7 +588,7 @@ $EXIST_HOME/bin/export.sh - WINDOWS: + Windows: $EXIST_HOME\bin\export.bat diff --git a/src/main/xar-resources/data/basic-installation/basic-installation.xml b/src/main/xar-resources/data/basic-installation/basic-installation.xml index 139f5d84..a6c58872 100644 --- a/src/main/xar-resources/data/basic-installation/basic-installation.xml +++ b/src/main/xar-resources/data/basic-installation/basic-installation.xml @@ -309,7 +309,7 @@ Simply calling launcher.sh or launcher.bat will start eXist-db via the desktop launcher: - $EXIST_HOME\bin\launcher.sh + $EXIST_HOME/bin/launcher.sh From 487a133af1a7fc1aced98b4c5e6e288b8027d13e Mon Sep 17 00:00:00 2001 From: Joe Wicentowski Date: Sun, 19 May 2019 00:28:22 -0400 Subject: [PATCH 5/7] Place maven options in tags --- .../data/exist-building/exist-building.xml | 37 ++++++++++--------- 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/src/main/xar-resources/data/exist-building/exist-building.xml b/src/main/xar-resources/data/exist-building/exist-building.xml index 28f6b347..edffbd65 100644 --- a/src/main/xar-resources/data/exist-building/exist-building.xml +++ b/src/main/xar-resources/data/exist-building/exist-building.xml @@ -107,7 +107,7 @@ - mvn clean + mvn clean Cleans the files and directories generated by a previous build. Data is not preserved unless you have overriden the path to the data directory. @@ -115,7 +115,7 @@ - mvn compile + mvn compile Recompiles any changed source code. @@ -123,7 +123,7 @@ - mvn dependency:analyze + mvn dependency:analyze Checks for any problems with the dependencies that eXist-db depends on. @@ -131,7 +131,7 @@ - mvn test + mvn test Runs all tests across all modules. Surefire HTML reports can be found in the modules target/surefire-reports/html folder. @@ -139,7 +139,7 @@ - mvn install + mvn install Installs all Maven artifacts to your local Maven repository (i.e. Unix/Linux: ~/.m2/repository, or Windows: %USERPROFILE%\.m2\repository. @@ -147,7 +147,7 @@ - mvn package + mvn package Performs the full lifecycle build, after which eXist-db distributions can be found in exist-distribution/target, and an eXist-db IzPack installer can be found in exist-installer/target. @@ -162,7 +162,7 @@ - -V + -V Show the version of Maven and Java used for the build. @@ -170,7 +170,7 @@ - -o + -o Execute Maven in offline (i.e. no Internet access!) mode. @@ -178,7 +178,7 @@ - -U + -U Force Maven to check online for any updates to dependency versions. @@ -186,7 +186,7 @@ - -T + -T Force Maven to execute the lifecycle for the reactor modules in parallel. For example -T 2C instructs Maven to use 2x the core count of threads to parallelise the build. This can have a large positive imapact on build times. @@ -194,7 +194,7 @@ - -Ddocker=true + -Ddocker=true Enable buiding eXist-db Docker images. @@ -202,7 +202,7 @@ - -Dmac.signing=true + -Dmac.signing=true Enable signing of Mac .app and .DMG files (only on Mac platforms). @@ -210,7 +210,8 @@ - -Dmac.codesign.identity="The ID of your Apple Developer Certificate" + -Dmac.codesign.identity="The ID of your Apple Developer + Certificate" Specify the certificate for signing of Mac .app and .DMG files (only on Mac platforms). @@ -218,7 +219,7 @@ - -DskipTests + -DskipTests Do not execute any tests. @@ -226,7 +227,7 @@ - -Ddependency-check.skip=true + -Ddependency-check.skip=true Skip the OWASP dependency security analysis. @@ -234,7 +235,7 @@ - -Dtest=MyTestClassName + -Dtest=MyTestClassName The name of a single test to run. If running Maven from the root of the project as opposed to inside the specific module which houses the test, you sould also add -DfailIfNoTests=false. @@ -242,7 +243,7 @@ - -DtrimStackTrace=false + -DtrimStackTrace=false When running tests, if a stacktrace is produced as part of an error, show the full output instead of trimming it. @@ -250,7 +251,7 @@ - MAVEN_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005" + MAVEN_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005" When this precedes the mvn command, Maven will be run through the Java debugger, which allows you to connect from IntelliJ or another IDE which support JDWP. From 487350b11547224a08970489ba0fe1a080866a08 Mon Sep 17 00:00:00 2001 From: Adam Retter Date: Sun, 19 May 2019 14:26:29 +0400 Subject: [PATCH 6/7] Removed further legacy references as mentioned by @joewiz --- .../advanced-installation.xml | 43 ++----------------- .../listings/listing-2.txt | 2 +- .../devguide_indexes/devguide_indexes.xml | 8 ++-- .../getting-help-how-to-report.xml | 10 ++--- .../xar-resources/data/indexing/indexing.xml | 33 +------------- src/main/xar-resources/data/lucene/lucene.xml | 40 +++-------------- .../production_good_practice.xml | 28 ++++-------- src/main/xar-resources/data/repo/repo.xml | 2 +- .../data/scheduler/scheduler.xml | 2 +- .../data/urlrewrite/urlrewrite.xml | 4 +- src/main/xar-resources/data/webdav/webdav.xml | 1 - src/main/xar-resources/data/xforms/xforms.xml | 2 +- 12 files changed, 35 insertions(+), 140 deletions(-) diff --git a/src/main/xar-resources/data/advanced-installation/advanced-installation.xml b/src/main/xar-resources/data/advanced-installation/advanced-installation.xml index 96003a78..aca44e5c 100644 --- a/src/main/xar-resources/data/advanced-installation/advanced-installation.xml +++ b/src/main/xar-resources/data/advanced-installation/advanced-installation.xml @@ -46,25 +46,6 @@ background service which is automatically launched during system start-up. This can be convenient, especially for servers. eXist-db continues to run even after users have logged off. - eXist-db comes with pre-configured scripts that use YAJSW (Yet Another Java Service - Wrapper) to handle the setup procedure. The scripts for this are contained in the - directory tools/yajsw. - Out of the box the following mainstream platforms are supported: - - - Windows x86 (32bit/64bit) - - - Linux x86 (32bit/64bit) & IA (64bit) - - - macOS x86 (32bit/64bit) - - - Solaris x86 (32bit/64bit) & SPARC (32bit/64bit) - - @@ -81,10 +62,6 @@ Choose Install eXist-db as Service from eXist-db's entry in the Windows start menu. - - Run tools/yajsw/bin/installService.bat from the command - line. - Installing eXist-db as a service on Windows requires full administrator rights. @@ -98,9 +75,6 @@ - Launch it via the service manager (as shown in the screenshot above) or from the - command line: - tools\yaysw\bin\startService.bat @@ -109,7 +83,7 @@ Unix/Linux The scripts for running eXist-db as a service for Unix and Linux based system - (among which MacOS)can be found in the tools/yajsw/bin/ + (among which MacOS) can be found in the tools/serviced/ sub-directory. Run the following command to get eXist-db started during initialization of the system: @@ -168,17 +142,6 @@ - - - - - Other platforms - - Support for additional platforms can be bootstrapped by looking at templates in - the tools/yajsw/templates sub-directory. Consult the YAJSW - documentation for more information. - @@ -187,8 +150,8 @@ Alternatives for scripts in the bin Directory Included in the distribution are a number of useful .sh (Unix - Shell) and .bat (DOS batch) programs located in the - bin sub-directory. Their names speak for themselves. + Shell) and .bat (Windows batch) programs located in the + bin sub-directory. Their names speak for themselves. However, if you find that programs do not launch, you can try to manually launch them on the command-line without the scripting wrapper. This often provides useful debugging information. diff --git a/src/main/xar-resources/data/advanced-installation/listings/listing-2.txt b/src/main/xar-resources/data/advanced-installation/listings/listing-2.txt index 96a0c2bf..cfa5e925 100644 --- a/src/main/xar-resources/data/advanced-installation/listings/listing-2.txt +++ b/src/main/xar-resources/data/advanced-installation/listings/listing-2.txt @@ -5,7 +5,7 @@ press 1 to continue, 2 to quit, 3 to redisplay 1 Set Data Directory Please select a directory where eXist will keep its data files. On Vista and Windows 7, this should be outside the usual 'Program Files' directory: -Data dir: [webapp/WEB-INF/data] +Data dir: [data] press 1 to continue, 2 to quit, 3 to redisplay 1 diff --git a/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml b/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml index 61c3e431..7318ce6a 100644 --- a/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml +++ b/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml @@ -521,10 +521,10 @@ the Indexes and org.exist.xquery.* for their associated Modules. There is also a dedicated location for required external libraries and for the test cases. The build system should normally be able to - download the required libraries and build all the files automatically, in particular the - extension-modules Ant target, and even launch the tests provided - that the DB's configuration file declares the Indexes (see above) and - their associated Modules (see below). + download the required libraries and build all the files automatically, and even launch + the tests provided that the DB's configuration file declares the + Indexes (see above) and their associated + Modules (see below). The described spatial Index heavily relies on the excellent open source librairies provided by the Geotools project. We have experienced a few problems that will be mentioned diff --git a/src/main/xar-resources/data/getting-help-how-to-report/getting-help-how-to-report.xml b/src/main/xar-resources/data/getting-help-how-to-report/getting-help-how-to-report.xml index fa827b96..e7864fd6 100644 --- a/src/main/xar-resources/data/getting-help-how-to-report/getting-help-how-to-report.xml +++ b/src/main/xar-resources/data/getting-help-how-to-report/getting-help-how-to-report.xml @@ -48,14 +48,12 @@ Include relevant parts of the logfile - (webapp/WEB-INF/logs/exist.log and - tools/yajsw/logs/wrapper.log) + (logs/exist.log). Mention the changes made in the configuration files, for instance - conf.xml, vm.properties, - tools/yajsw/conf/wrapper.conf and - tools/jetty/etc/jetty.xml. + etc/conf.xml, etc/launcher.properties, + and etc/jetty/jetty.xml. @@ -92,4 +90,4 @@ -
\ No newline at end of file + diff --git a/src/main/xar-resources/data/indexing/indexing.xml b/src/main/xar-resources/data/indexing/indexing.xml index dd2651e0..dd035e4b 100644 --- a/src/main/xar-resources/data/indexing/indexing.xml +++ b/src/main/xar-resources/data/indexing/indexing.xml @@ -286,37 +286,8 @@ Enabling Index Modules - - While some indexes (n-gram, full text) are already pre-build in the standard eXist-db - distribution, other modules may need to be enabled first. For example, the spatial index - depends on external libraries which do not ship with eXist-db. However, as an example, - enabling the spatial index is a simple process: - - - Copy the properties file - extensions/indexes/build.properties and store it as - local.build.properties in the same directory (if it does not - already exist). - - - Edit extensions/indexes/local.build.properties: - - - To include a spatial index, change the corresponding property to - "true". - - - Call the Ant build system once to regenerate the eXist-db libraries using - build.sh or build.bat. - - - The build process should create a .jar file for every index - implementation in directory lib/extensions. For example, the spatial - index is packaged into the .jar - exist-spatial-module.jar. - Once the index module has been built, it can be announced to eXist-db. To activate an - index plug-in, it needs to be added to the modules section within the global - configuration file conf.xml: + To activate an index plug-in, it needs to be added to the modules section + within the global configuration file conf.xml: diff --git a/src/main/xar-resources/data/lucene/lucene.xml b/src/main/xar-resources/data/lucene/lucene.xml index 229f8aea..fc3feb13 100644 --- a/src/main/xar-resources/data/lucene/lucene.xml +++ b/src/main/xar-resources/data/lucene/lucene.xml @@ -32,41 +32,15 @@ - - Enabling the Lucene Module - - The Lucene full text index is enabled by default (since eXist-db version 1.4). In case - it is not enabled in your installation, here's how to get it up and running: - - - Enable it according to the instructions in the article on index - modules. - - - Then (re-)build eXist-db using the provided - build.sh or build.bat script. The build - process downloads the required Lucene jars automatically. If everything builds - ok, you'll find a jar exist-lucene-module.jar in the - lib/extensions directory. - - - Edit the main configuration file, conf.xml and un-comment - the Lucene-related section: - - - - - The index has a single configuration parameter on the - modules/module element called buffer. It - defines the amount of memory (in megabytes) Lucene will use for buffering index entries - before they are written to disk. See the Lucene Javadocs. - - - - - Configuring the Index + The index has a single configuration parameter on the + modules/module element called + buffer. It defines the amount of memory (in megabytes) Lucene will use for + buffering index entries before they are written to disk. See the Lucene Javadocs. Like other indexes, you create a Lucene index by configuring it in a collection.xconf document as explained in documentation. For example: diff --git a/src/main/xar-resources/data/production_good_practice/production_good_practice.xml b/src/main/xar-resources/data/production_good_practice/production_good_practice.xml index 5550fc34..e26e0f10 100644 --- a/src/main/xar-resources/data/production_good_practice/production_good_practice.xml +++ b/src/main/xar-resources/data/production_good_practice/production_good_practice.xml @@ -310,26 +310,16 @@ Further considerations for a live environment: - - Standalone mode - - eXist-db can be operated in a cut-down standalone mode (see - server.(sh|bat)). This provides just the core services from - the database (no webapp file system access and no documentation). The - entire application has to be stored in the database and is served from - there. This is an ideal starting place for a production system. - - Services eXist-db provides services for accessing the database. You should reduce these to the absolute minimum you need for your production - application. If you are operating in standalone mode, this is done via - server.xml, otherwise webapp/WEB-INF/web.xml. + application.This is done via + etc/webapp/WEB-INF/web.xml. You should look at each configured service, servlet or filter and ask - yoursel: do we use this? Most production environments are unlikely to - need WebDAV or SOAP Admin (Axis). + yourself: do we use this? Most production environments are unlikely to + need WebDAV. @@ -337,7 +327,7 @@ eXist-db loads several XQuery and Index extension modules by default. You should modify the builtin-modules section of - conf.xml and only load what you + etc/conf.xml and only load what you need for your application. @@ -357,15 +347,15 @@ However you decide to deploy and start eXist, please ensure that you allocate enough maximum memory to eXist-db uwing the Java - -Xmx setting. See backup.sh and - startup.sh. + -Xmx setting. See bin/backup.sh and + bin/startup.sh. cacheSize and collectionCache These two settings in db-connection of - conf.xml should be adjusted appropriately based on + etc/conf.xml should be adjusted appropriately based on your -Xmx setting (see above). See the tuning guide for advice on sensible values. @@ -389,7 +379,7 @@ Keeping the eXist-db application, data and journal on separate disks, connected to different I/O channels, can have a positive impact on performance. The location of - the data files and journals can be changed in conf.xml. + the data files and journals can be changed in etc/conf.xml. diff --git a/src/main/xar-resources/data/repo/repo.xml b/src/main/xar-resources/data/repo/repo.xml index 95a549d3..7935f430 100644 --- a/src/main/xar-resources/data/repo/repo.xml +++ b/src/main/xar-resources/data/repo/repo.xml @@ -439,7 +439,7 @@ repo.xml will always be relative to this root collection. eXist-db's URL rewriting is by default configured to map any path starting with /apps to the repository root collection. Check - webapp/WEB-INF/controller-config.xml and the etc/webapp/WEB-INF/controller-config.xml and the URL rewriting documentation. diff --git a/src/main/xar-resources/data/scheduler/scheduler.xml b/src/main/xar-resources/data/scheduler/scheduler.xml index 17b7cc36..f5a51848 100644 --- a/src/main/xar-resources/data/scheduler/scheduler.xml +++ b/src/main/xar-resources/data/scheduler/scheduler.xml @@ -59,7 +59,7 @@ The scheduler keeps a log file of its actions and issues that occur when executing - jobs in webapp/WEB-INF/logs/scheduler.log. + jobs in logs/scheduler.log. diff --git a/src/main/xar-resources/data/urlrewrite/urlrewrite.xml b/src/main/xar-resources/data/urlrewrite/urlrewrite.xml index e91b2692..0b3c345f 100644 --- a/src/main/xar-resources/data/urlrewrite/urlrewrite.xml +++ b/src/main/xar-resources/data/urlrewrite/urlrewrite.xml @@ -29,7 +29,7 @@ forward them to the appropriate handlers, which are again standard servlets. In fact, there's nothing eXist-specific to the servlet filter, except that it uses XQuery scripts to configure the forwarding and URL rewriting. Like any other servlet filter, it is - configured in webapp/WEB-INF/web.xml. + configured in etc/webapp/WEB-INF/web.xml. A controller XQuery is executed once for every requests. It must return an XML fragment, which tells the servlet filter how to proceed with the request. The returned XML fragment can range from simply define forwarding up to describing complex pipelines @@ -215,7 +215,7 @@ you may want to keep the main webapp within the file system, while some tools and scripts should be served from a database collection. This can be done by configuring two roots within the controller-config.xml file in - webapp/WEB-INF. controller-config.xml defines the + etc/webapp/WEB-INF. controller-config.xml defines the base mappings used by XQueryURLRewrite. It basically has two components: diff --git a/src/main/xar-resources/data/webdav/webdav.xml b/src/main/xar-resources/data/webdav/webdav.xml index a49ec0a1..78751d89 100644 --- a/src/main/xar-resources/data/webdav/webdav.xml +++ b/src/main/xar-resources/data/webdav/webdav.xml @@ -182,7 +182,6 @@ org.exist.webdav.PROPFIND_METHOD_XML_SIZE=EXACT org.exist.webdav.GET_METHOD_XML_SIZE=EXACT - If eXist is installed as a service (systemd) the configuration has to be done in /tools/yajsw/conf/wrapper.conf diff --git a/src/main/xar-resources/data/xforms/xforms.xml b/src/main/xar-resources/data/xforms/xforms.xml index 1eade61b..17a56700 100644 --- a/src/main/xar-resources/data/xforms/xforms.xml +++ b/src/main/xar-resources/data/xforms/xforms.xml @@ -63,7 +63,7 @@ betterFORM can also be configured to listen for a certain collection in the database only or to fetch documents from the filesystem (from a directory below the webapp directory). This can be done by changing the filter mapping in - webapp/WEB-INF/web.xml: + etc/webapp/WEB-INF/web.xml: From a2f02c6e8b59c6c0f06e49fea32a25a4b8d7a7e1 Mon Sep 17 00:00:00 2001 From: Adam Retter Date: Sun, 19 May 2019 14:46:38 +0400 Subject: [PATCH 7/7] Update article date --- .../getting-help-how-to-report/getting-help-how-to-report.xml | 2 +- src/main/xar-resources/data/indexing/indexing.xml | 4 ++-- src/main/xar-resources/data/lucene/lucene.xml | 2 +- src/main/xar-resources/data/repo/repo.xml | 2 +- src/main/xar-resources/data/scheduler/scheduler.xml | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/main/xar-resources/data/getting-help-how-to-report/getting-help-how-to-report.xml b/src/main/xar-resources/data/getting-help-how-to-report/getting-help-how-to-report.xml index e7864fd6..3b8a2cb8 100644 --- a/src/main/xar-resources/data/getting-help-how-to-report/getting-help-how-to-report.xml +++ b/src/main/xar-resources/data/getting-help-how-to-report/getting-help-how-to-report.xml @@ -3,7 +3,7 @@ schematypens="http://purl.oclc.org/dsdl/schematron"?>
How to report issues - 1Q18 + 2Q19 getting-started diff --git a/src/main/xar-resources/data/indexing/indexing.xml b/src/main/xar-resources/data/indexing/indexing.xml index dd035e4b..9010705f 100644 --- a/src/main/xar-resources/data/indexing/indexing.xml +++ b/src/main/xar-resources/data/indexing/indexing.xml @@ -3,7 +3,7 @@ schematypens="http://purl.oclc.org/dsdl/schematron"?>
Configuring Database Indexes - 1Q18 + 2Q19 application-development @@ -324,4 +324,4 @@ join between these node sets to determine which section elements are in fact children of book elements. -
\ No newline at end of file +
diff --git a/src/main/xar-resources/data/lucene/lucene.xml b/src/main/xar-resources/data/lucene/lucene.xml index fc3feb13..04846779 100644 --- a/src/main/xar-resources/data/lucene/lucene.xml +++ b/src/main/xar-resources/data/lucene/lucene.xml @@ -3,7 +3,7 @@ schematypens="http://purl.oclc.org/dsdl/schematron"?>
Full Text Index - 4Q18 + 2Q19 indexing diff --git a/src/main/xar-resources/data/repo/repo.xml b/src/main/xar-resources/data/repo/repo.xml index 7935f430..e60c5472 100644 --- a/src/main/xar-resources/data/repo/repo.xml +++ b/src/main/xar-resources/data/repo/repo.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Package Repository - 1Q18 + 2Q19 application-development diff --git a/src/main/xar-resources/data/scheduler/scheduler.xml b/src/main/xar-resources/data/scheduler/scheduler.xml index f5a51848..1cec3f21 100644 --- a/src/main/xar-resources/data/scheduler/scheduler.xml +++ b/src/main/xar-resources/data/scheduler/scheduler.xml @@ -5,7 +5,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Scheduler Module - 1Q18 + 2Q19 operations application-development