Skip to content

Commit a453b2b

Browse files
adamretteradamretter
committed
Remove references to start.jar
1 parent ece9b07 commit a453b2b

File tree

10 files changed

+129
-79
lines changed

10 files changed

+129
-79
lines changed

‎src/main/xar-resources/data/advanced-installation/advanced-installation.xml‎

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,6 @@
197197
<varlistentry>
198198
<term> <code>startup.sh</code> (Unix) / <code>startup.bat</code> (Windows)</term>
199199
<listitem>
200-
<programlisting>java -jar start.jar jetty</programlisting>
201200
<para>Starts the included Jetty web server at port 8080. eXist runs as a web
202201
application, located at <link xlink:href="http://localhost:8080/exist/"
203202
>http://localhost:8080/exist/</link>. </para>
@@ -206,7 +205,7 @@
206205
<varlistentry>
207206
<term> <code>shutdown.sh</code> (Unix) / <code>shutdown.bat</code> (Windows)</term>
208207
<listitem>
209-
<programlisting>java -jar start.jar shutdown -p youradminpassword</programlisting>
208+
<programlisting>shutdown.sh -p youradminpassword</programlisting>
210209
<para>Closes the running instance of eXist. If eXist has been started with
211210
<literal>startup.sh</literal>, calling <literal>shutdown.sh</literal> will
212211
also stop the Jetty web server. Otherwise, only the database is stopped by
@@ -215,22 +214,11 @@
215214
<literal>shutdown</literal> before killing the server process.</para>
216215
</listitem>
217216
</varlistentry>
218-
<varlistentry>
219-
<term> <code>server.sh</code> (Unix) / <code>server.bat</code> (Windows)</term>
220-
<listitem>
221-
<programlisting>java -jar start.jar standalone</programlisting>
222-
<para>Launches eXist as a stand-alone server process. In this setup, eXist is
223-
only accessible through the XMLRPC and the built-in HTTP interface.</para>
224-
</listitem>
225-
</varlistentry>
226217
<varlistentry>
227218
<term> <code>client.sh</code> (Unix) / <code>client.bat</code> (Windows)</term>
228219
<listitem>
229-
<programlisting>java -jar start.jar client</programlisting>
230220
<para>Launches the <link xlink:href="java-admin-client">Java Admin
231-
Client</link>. This application is also launched if no application is
232-
selected on the command-line, like this:</para>
233-
<programlisting>java -jar start.jar</programlisting>
221+
Client</link>.</para>
234222
</listitem>
235223
</varlistentry>
236224
</variablelist>

‎src/main/xar-resources/data/backup/backup.xml‎

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,16 @@
309309

310310
<para>eXist also includes a command-line JMX client. Call it with parameter
311311
<literal>-s</literal> to see the latest consistency report:</para>
312-
<programlisting>java -jar start.jar org.exist.management.client.JMXClient -s</programlisting>
312+
<itemizedlist>
313+
<listitem>
314+
<para>Unix/Linux:</para>
315+
<programlisting>$EXIST_HOME/bin/jmxclient.sh -s</programlisting>
316+
</listitem>
317+
<listitem>
318+
<para>WINDOWS:</para>
319+
<programlisting>$EXIST_HOME\bin\jmxclient.bat -s</programlisting>
320+
</listitem>
321+
</itemizedlist>
313322
<para>This may produce output as shown below:</para>
314323
<programlisting xlink:href="listings/listing-6.txt"/>
315324
<para>You can also subscribe to the notifications made available by the SanityReport
@@ -550,7 +559,16 @@
550559
<para>This tool needs direct access to the database files, so you must stop the running
551560
database instance first if it is active.</para>
552561
<para>Use the following command line to start the utility as a GUI:</para>
553-
<programlisting>java -jar start.jar org.exist.backup.ExportGUI</programlisting>
562+
<itemizedlist>
563+
<listitem>
564+
<para>Unix/Linux:</para>
565+
<programlisting>$EXIST_HOME/bin/export-gui.sh</programlisting>
566+
</listitem>
567+
<listitem>
568+
<para>WINDOWS:</para>
569+
<programlisting>$EXIST_HOME\bin\export-gui.bat</programlisting>
570+
</listitem>
571+
</itemizedlist>
554572
<informalfigure>
555573
<mediaobject>
556574
<imageobject>
@@ -564,7 +582,16 @@
564582
consistency check <emphasis>and</emphasis> a full backup.</para>
565583
<para>On a headless system use the command-line version instead (The <literal>-h</literal>
566584
parameter will get you a list of possible options):</para>
567-
<programlisting>java -jar start.jar org.exist.backup.ExportMain</programlisting>
585+
<itemizedlist>
586+
<listitem>
587+
<para>Unix/Linux:</para>
588+
<programlisting>$EXIST_HOME/bin/export.sh</programlisting>
589+
</listitem>
590+
<listitem>
591+
<para>WINDOWS:</para>
592+
<programlisting>$EXIST_HOME\bin\export.bat</programlisting>
593+
</listitem>
594+
</itemizedlist>
568595
</sect1>
569596

570597
<sect1 xml:id="standalone">

‎src/main/xar-resources/data/backup/listings/listing-7.txt‎

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,47 @@
1-
java -jar start.jar backup
2-
-u [admin_username]
3-
-p [admin_password]
4-
-b [collection_path]
5-
-d [target_path]
6-
-ouri=[xml_uri]
1+
backup.sh --h
2+
3+
Usage: backup.sh [Arguments]
4+
5+
Arguments:
6+
-b, --backup <string> backup the specified collection.
7+
<string>: any string
8+
Default:
9+
-d, --dir <path> specify the directory to use for
10+
backups.
11+
<path>: a file path
12+
Default: /Users/aretter/code/exist.maven/.
13+
--deduplicate-blobs <boolean> Deduplicate BLOBS in the backup.
14+
<boolean>: true or false
15+
Default: false
16+
-h, --help <argument-to-print-help-for> <argument-to-print-help-for>: an argument to print help for
17+
Default: If no specific parameter is given the whole usage text is given
18+
-o, --option<string>=<string> specify extra options:
19+
property=value. For available properties see client.
20+
properties.
21+
<string>=<string>: where "<string>" is any string and "<string>" is any string
22+
Default: Empty map
23+
-p, --password <string> set the password for connecting to
24+
the database.
25+
<string>: any string
26+
Default:
27+
-P, --dba-password <string> if the backup specifies a different
28+
password for the admin user, use this option
29+
to specify the new password. Otherwise
30+
you will get a permission denied
31+
<string>: any string
32+
Default:
33+
-q, --quiet be quiet. Just print errors.
34+
Default: disabled
35+
-r, --restore <path> read the specified __contents__.xml
36+
file and restore the resources described
37+
there.
38+
<path>: a file path
39+
Default: /Users/aretter/code/exist.maven/.
40+
-R, --rebuild rebuild the EXpath app repository
41+
after restore.
42+
Default: disabled
43+
-u, --user <string> set user.
44+
<string>: any string
45+
Default: admin
46+
-U, --gui start in GUI mode
47+
Default: disabled

‎src/main/xar-resources/data/basic-installation/basic-installation.xml‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
xmlns:xlink="http://www.w3.org/1999/xlink">
66
<info>
77
<title>Basic Installation</title>
8-
<date>3Q18</date>
8+
<date>2Q19</date>
99
<keywordset>
1010
<keyword>installation</keyword>
1111
<keyword>getting-started</keyword>
@@ -303,14 +303,13 @@
303303
</listitem>
304304
<listitem>
305305
<para>Change (<code>cd</code>) to the directory where you installed eXist-db
306-
(for instance, <literal>/usr/local/lib/exist/</literal> for Linux,
307-
<literal>/Applications/eXist/</literal> for Mac, or <literal>C:\Program
308-
Files\eXist</literal> for Windows).</para>
306+
(for instance, <literal>/opt/exist/</literal> for Linux,
307+
<literal>/Applications/eXist/</literal> for Mac, or <literal>C:\eXist</literal> for Windows).</para>
309308
</listitem>
310309
<listitem>
311-
<para>Simply calling <literal>start.jar</literal> will start eXist-db via the
310+
<para>Simply calling <literal>launcher.sh</literal> or <literal>launcher.bat</literal> will start eXist-db via the
312311
desktop launcher:</para>
313-
<programlisting>java -jar start.jar</programlisting>
312+
<programlisting>$EXIST_HOME\bin\launcher.sh</programlisting>
314313

315314
</listitem>
316315
</orderedlist>
@@ -386,11 +385,6 @@
386385
<programlisting>bin/shutdown.sh -u admin -p youradminpassword</programlisting>
387386
<programlisting>bin/shutdown.bat -u admin -p youradminpassword</programlisting>
388387
</listitem>
389-
<listitem>
390-
<para>From the command line, run the following Java command, using your admin
391-
account's credentials:</para>
392-
<programlisting>java -jar start.jar shutdown -u admin -p youradminpassword</programlisting>
393-
</listitem>
394388
<listitem>
395389
<para>From the <link xlink:href="java-admin-client">Java Admin Client</link>: select
396390
<guimenuitem>Connection</guimenuitem>, <guimenuitem>Shutdown</guimenuitem> from

‎src/main/xar-resources/data/deployment/deployment.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
schematypens="http://purl.oclc.org/dsdl/schematron"?><article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
44
<info>
55
<title>Database Deployment</title>
6-
<date>1Q18</date>
6+
<date>2Q19</date>
77
<keywordset>
88
<keyword>operations</keyword>
99
<keyword>java-development</keyword>
@@ -350,7 +350,7 @@
350350
<para>If your database is running in stand-alone mode, you must specify a different
351351
server URI. For instance, to stop eXist when running in stand-alone mode, listening
352352
on port <literal>8088</literal>, use:</para>
353-
<programlisting>java -jar start.jar shutdown --uri=xmldb:exist://localhost:8088/xmlrpc</programlisting>
353+
<programlisting>$EXIST_HOME/bin/shutdown.sh --uri=xmldb:exist://localhost:8088/xmlrpc</programlisting>
354354
</sect2>
355355
</sect1>
356356

‎src/main/xar-resources/data/devguide_xmldb/devguide_xmldb.xml‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
schematypens="http://purl.oclc.org/dsdl/schematron"?><article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
44
<info>
55
<title>Writing Java Applications with the XML:DB API</title>
6-
<date>1Q18</date>
6+
<date>2Q19</date>
77
<keywordset>
88
<keyword>java-development</keyword>
99
</keywordset>
@@ -21,9 +21,10 @@
2121
<title>Introduction</title>
2222

2323
<para>The preferred way to work with eXist-db when developing Java applications is to use
24-
the XML:DB API. eXist-db's implementation of the XML:DB standards follows the XIndice
25-
implementation, and conforms to the latest working drafts put forth by the <link xlink:href="http://xmldb-org.sourceforge.net/xapi/">XML:DB Initiative</link>. For more
26-
information, refer to the Javadocs for this API.</para>
24+
the XML:DB API. eXist-db's implementation of the XML:DB standard conforms to the latest
25+
working drafts put forth by the <link
26+
xlink:href="https://github.com/xmldb-org/xmldb-api">XML:DB Initiative</link>. For
27+
more information, refer to the Javadocs for this API.</para>
2728
<para>The basic components employed by the XML:DB API are <emphasis>drivers</emphasis>,
2829
<emphasis>collections</emphasis>, <emphasis>resources</emphasis> and
2930
<emphasis>services</emphasis>.</para>
@@ -37,20 +38,21 @@
3738
document or a document fragment, selected by a previously executed XPath query.</para>
3839
<para>Finally, <emphasis>services</emphasis> are requested for special tasks such as
3940
querying a collection with XPath, or managing a collection.</para>
40-
<para>There are several XML:DB examples provided in eXist's <literal>samples</literal>
41-
directory . To start an example, use the <literal>start.jar</literal> jar file and pass
42-
the name of the example class as the first parameter, for instance:</para>
43-
<programlisting xlink:href="listings/listing-1.txt"/>
44-
41+
<para>There are also several XML:DB examples provided in the
42+
<link xlink:href="https://github.com/eXist-book/book-code/tree/master/chapters/integration">sample code</link>
43+
that accompanies the Integration chapter of the <link xlink:href="http://shop.oreilly.com/product/0636920026525.do">eXist-db book</link>.
44+
</para>
4545
</sect1>
4646

4747
<!-- ================================================================== -->
4848

4949
<sect1 xml:id="use-xmldb">
5050
<title>Using the XML:DB API</title>
5151

52-
<para>Programming with the XML:DB API is straightforward. You will find some code examples
53-
in the <literal>samples/org/exist/examples/xmldb</literal> directory.</para>
52+
<para>For working with eXist-db via XML:DB API, you will need two dependencies, one for the XML:DB API
53+
and one for eXist-db's implementation of the API. These dependencies are available from Maven and should
54+
be added to your Maven <literal>pom.xml</literal> or project's dependency tool like so:</para>
55+
<programlisting language="xml" xlink:href="listings/listing-1.txt"/>
5456
<para>In the following simple example, a document is retrieved from the eXist server and
5557
printed to standard output.</para>
5658

@@ -156,7 +158,10 @@
156158
<sect1 xml:id="extend-xmldb">
157159
<title>Extensions to XML:DB</title>
158160

159-
<para>eXist provides extensions on top of the XML:DB specification.</para>
161+
<para>eXist provides extensions on top of the XML:DB specification.
162+
If you wish to use these extensions, you should make sure that the scope for your <literal>exist-core</literal>
163+
dependency is set to <literal>compile</literal>.
164+
</para>
160165

161166
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
162167

@@ -205,4 +210,4 @@
205210
in the configuration files.</para>
206211
</sect2>
207212
</sect1>
208-
</article>
213+
</article>

‎src/main/xar-resources/data/devguide_xmldb/listings/listing-1.txt‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
1-
java -jar start.jar org.exist.examples.xmldb.Retrieve [- other options]
1+
<dependency>
2+
<groupId>net.sf.xmldb-org</groupId>
3+
<artifactId>xmldb-api</artifactId>
4+
<version>1.7.0</version>
5+
</dependency>
6+
7+
<dependency>
8+
<groupId>org.exist-db</groupId>
9+
<artifactId>exist-core</artifactId>
10+
<version>5.0.0</version>
11+
<scope>runtime</scope>
12+
</dependency>

‎src/main/xar-resources/data/java-admin-client/java-admin-client.xml‎

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,36 +29,12 @@
2929
<para>Windows and Linux users: Click the eXist-db icon in the taskbar and choose the
3030
<guimenuitem>Open Java Admin Client</guimenuitem> menu entry.</para>
3131
</listitem>
32-
<listitem>
33-
<para>You can download its Java WebStart file <code>exist.jnlp</code> via your web
34-
browser. Once the download has completed, double-click it to launch the client: </para>
35-
<para> <link xlink:href="/webstart/exist.jnlp"> <inlinemediaobject>
36-
<imageobject>
37-
<imagedata fileref="assets/webstart.small.jpg"/>
38-
</imageobject>
39-
</inlinemediaobject> </link> </para>
40-
<para>You can also find a link to download the Java WebStart file on the
41-
dashboard.</para>
42-
<note>
43-
<para>If you built eXist-db from source rather than using the downloadable
44-
installer, the Java WebStart function will not work unless you sign the
45-
jars. To do so, enter the following on your command line from the eXist
46-
directory: </para>
47-
<programlisting>build.bat -f build/scripts/jarsigner.xml (DOS/Windows)</programlisting>
48-
<programlisting>build.sh -f build/scripts/jarsigner.xml (Unix)</programlisting>
49-
</note>
50-
</listitem>
5132
<listitem>
5233
<para>Enter the following on your command line from the eXist installation directory
5334
(with the <code>JAVA_HOME</code> environment variable set correctly):</para>
5435
<programlisting>bin\client.bat (DOS/Windows)</programlisting>
5536
<programlisting>bin/client.sh (Unix)</programlisting>
5637
</listitem>
57-
<listitem>
58-
<para>Or enter the following on the command line (again from the eXist installation
59-
directory):</para>
60-
<programlisting>java -jar start.jar client</programlisting>
61-
</listitem>
6238
</itemizedlist>
6339
</sect1>
6440

0 commit comments

Comments
 (0)