Difference between revisions of "Maven"

From BaseX Documentation
Jump to navigation Jump to search
 
(46 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<p>As BaseX is offered in a Maven repository, you can easily embed and [[Integrate|integrate]] it into your own projects.
+
This page is part of the [[Developer Section]]. It demonstrates how [https://maven.apache.org Maven] is used to compile and run BaseX, and embed it into other projects.
To use the BaseX Maven Artifacts, add the following lines to your
+
 
<code>pom.xml</code> file:</p>  
+
==Using Maven==
<pre class="brush:xml">&lt;repositories&gt;
+
  &lt;repository&gt;
+
If you have [[Git|cloned our repository]] and installed Maven on your machine,
    &lt;id&gt;dbis-ukn&lt;/id&gt;
+
you can run the following commands from all local repository directories:
    &lt;name&gt;DBIS Maven Repository&lt;/name&gt;
+
 
    &lt;url&gt;http://www.inf.uni-konstanz.de/dbis/basex/maven&lt;/url&gt;
+
* <code>mvn compile</code>: the BaseX source files are compiled.
  &lt;/repository&gt;
+
* <code>mvn package</code>: JAR archives are created in the {{Code|target}} class directory, and all relevant libraries are created in the {{Code|lib}} directory. Packaging is useful if you want to use the start scripts.
&lt;/repositories&gt;</pre>
+
* <code>mvn install</code>: the JAR archive is installed to the local repository, and made available to other Maven projects. This is particularly useful if you are compiling a beta version of BaseX, for which no archives exist in the repositories.
 
   
 
   
===BaseX Artifact===  
+
By adding the flag <code>-DskipTests</code> you can skip the JUnit tests and speed up packaging. You may as well use [[Developing with Eclipse|Eclipse and m2eclipse]] to compile the BaseX sources.
<pre class="brush:xml">&lt;dependency&gt;
+
 
   &lt;groupId&gt;org.basex&lt;/groupId&gt;
+
There are several alternatives for starting BaseX:
   &lt;artifactId&gt;basex&lt;/artifactId&gt;
+
 
   &lt;version&gt;6.5&lt;/version&gt;
+
* type in {{Code|java -cp target/classes org.basex.BaseX}} in the {{Code|basex-core}} directory to start BaseX on the command-line mode,
&lt;/dependency&gt;</pre>
+
* type in {{Code|mvn jetty:run}} in the {{Code|basex-api}} directory to start BaseX with Jetty and the HTTP servers,
 +
* run one of the [[Start Scripts]] contained in the {{Code|etc}} directory
 +
 
 +
==Artifacts==
 +
 
 +
You can easily embed BaseX into your own Maven projects by adding the following XML snippets to your {{Code|pom.xml}} file:
 +
 
 +
<syntaxhighlight lang="xml"><repositories>
 +
  <repository>
 +
    <id>basex</id>
 +
    <name>BaseX Maven Repository</name>
 +
    <url>http://files.basex.org/maven</url>
 +
  </repository>
 +
</repositories></syntaxhighlight>
 +
 +
===BaseX Main Package===  
 +
 
 +
<syntaxhighlight lang="xml"><dependency>
 +
  <groupId>org.basex</groupId>
 +
  <artifactId>basex</artifactId>
 +
  <version>7.6</version>
 +
</dependency></syntaxhighlight>
 +
 
 +
===APIs and Services===
 +
 
 +
<p>...including APIs and the [[REST]], [[RESTXQ]] and [[WebDAV]] services:</p>
 +
<syntaxhighlight lang="xml"><dependency>
 +
   <groupId>org.basex</groupId>
 +
   <artifactId>basex-api</artifactId>
 +
   <version>7.6</version>
 +
</dependency></syntaxhighlight>
 +
 
 +
===XQJ API===
  
===BaseX API Artifact===  
+
<p>The XQJ API is hosted at http://xqj.net:</p>
<p>...including the [[JAX-RX]], [http://sourceforge.net/projects/xmldb-org XML:DB]
+
<syntaxhighlight lang="xml">
[http://jcp.org/en/jsr/detail?id=225 XQJ] and API:</p>  
+
<repository>
<pre class="brush:xml">&lt;dependency&gt;
+
  <id>xqj</id>
   &lt;groupId&gt;org.basex&lt;/groupId&gt;
+
  <name>XQJ Maven Repository</name>
   &lt;artifactId&gt;basex-api&lt;/artifactId&gt;
+
  <url>http://xqj.net/maven</url>
   &lt;version&gt;6.3.4&lt;/version&gt;
+
</repository>
&lt;/dependency&gt;</pre>
+
...
[[Category:Developer]]
+
<dependency>
 +
  <groupId>net.xqj</groupId>
 +
  <artifactId>basex-xqj</artifactId>
 +
  <version>1.2.0</version>
 +
</dependency>
 +
<dependency>
 +
  <groupId>com.xqj2</groupId>
 +
  <artifactId>xqj2</artifactId>
 +
  <version>0.1.0</version>
 +
</dependency>
 +
<dependency>
 +
   <groupId>javax.xml.xquery</groupId>
 +
   <artifactId>xqj-api</artifactId>
 +
   <version>1.0</version>
 +
</dependency>
 +
</syntaxhighlight>

Latest revision as of 10:52, 29 July 2020

This page is part of the Developer Section. It demonstrates how Maven is used to compile and run BaseX, and embed it into other projects.

Using Maven[edit]

If you have cloned our repository and installed Maven on your machine, you can run the following commands from all local repository directories:

  • mvn compile: the BaseX source files are compiled.
  • mvn package: JAR archives are created in the target class directory, and all relevant libraries are created in the lib directory. Packaging is useful if you want to use the start scripts.
  • mvn install: the JAR archive is installed to the local repository, and made available to other Maven projects. This is particularly useful if you are compiling a beta version of BaseX, for which no archives exist in the repositories.

By adding the flag -DskipTests you can skip the JUnit tests and speed up packaging. You may as well use Eclipse and m2eclipse to compile the BaseX sources.

There are several alternatives for starting BaseX:

  • type in java -cp target/classes org.basex.BaseX in the basex-core directory to start BaseX on the command-line mode,
  • type in mvn jetty:run in the basex-api directory to start BaseX with Jetty and the HTTP servers,
  • run one of the Start Scripts contained in the etc directory

Artifacts[edit]

You can easily embed BaseX into your own Maven projects by adding the following XML snippets to your pom.xml file:

<repositories>
  <repository>
    <id>basex</id>
    <name>BaseX Maven Repository</name>
    <url>http://files.basex.org/maven</url>
  </repository>
</repositories>

BaseX Main Package[edit]

<dependency>
  <groupId>org.basex</groupId>
  <artifactId>basex</artifactId>
  <version>7.6</version>
</dependency>

APIs and Services[edit]

...including APIs and the REST, RESTXQ and WebDAV services:

<dependency>
  <groupId>org.basex</groupId>
  <artifactId>basex-api</artifactId>
  <version>7.6</version>
</dependency>

XQJ API[edit]

The XQJ API is hosted at http://xqj.net:

<repository>
  <id>xqj</id>
  <name>XQJ Maven Repository</name>
  <url>http://xqj.net/maven</url>
</repository>
...
<dependency>
  <groupId>net.xqj</groupId>
  <artifactId>basex-xqj</artifactId>
  <version>1.2.0</version>
</dependency>
<dependency>
  <groupId>com.xqj2</groupId>
  <artifactId>xqj2</artifactId>
  <version>0.1.0</version>
</dependency>
<dependency>
  <groupId>javax.xml.xquery</groupId>
  <artifactId>xqj-api</artifactId>
  <version>1.0</version>
</dependency>