Changes

Jump to navigation Jump to search
1,830 bytes added ,  15:56, 17 January 2016
no edit summary
This page is part of the [[Developer Section]]. It demonstrates how [http://maven.apache.org Maven] is used to compile and run BaseX, and embed it into other projects. ==Using Maven== If you have [[Git|cloned our repository]] and installed Maven on your machine,you can run the following commands from all local repository directories: * <pcode>As mvn compile</code>: the BaseX source files are compiled.* <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.* <code>mvn install</code>: the JAR archive is installed to the local repository, and made available to other Maven projects. This is offered in particularly useful if you are compiling a Maven repositorybeta version of BaseX, for which no archives exist in the repositories. By adding the flag <code>-DskipTests</code> you can easily embed skip the JUnit tests and speed up packaging. You may as well use [[IntegrateDeveloping with Eclipse|integrateEclipse and m2eclipse]] it to compile the BaseX sources. There are several alternatives for starting BaseX: * type in your own projects{{Code|java -cp target/classes org.basex.BaseX}} in the {{Code|basex-core}} directory to start BaseX on the command-line mode,In order * type in {{Code|mvn jetty:run}} in the {{Code|basex-api}} directory to use 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 Artifacts, add projects by adding the following lines XML snippets to your<code>{{Code|pom.xml</code> }} file:</p>  
<pre class="brush:xml">&lt;repositories&gt;
&lt;repository&gt;
&lt;id&gt;dbis-uknbasex&lt;/id&gt; &lt;name&gt;DBIS BaseX Maven Repository&lt;/name&gt; &lt;url&gt;http://wwwfiles.inf.uni-konstanzbasex.de/dbis/basexorg/maven&lt;/url&gt;
&lt;/repository&gt;
&lt;/repositories&gt;</pre>
===BaseX ArtifactMain Package===
<pre class="brush:xml">&lt;dependency&gt;
&lt;groupId&gt;org.basex&lt;/groupId&gt;
&lt;artifactId&gt;basex&lt;/artifactId&gt;
&lt;version&gt;7.6.3.4&lt;/version&gt;
&lt;/dependency&gt;</pre>
===BaseX API ArtifactAPIs and Services=== <p>...including APIs and the [http://jcp.org/en/jsr/detail?id=225 XQJ[REST]], [[RESTXQ]] and [http://sourceforge.net/projects/xmldb-org XML:DB[WebDAV]] APIservices:</p>
<pre class="brush:xml">&lt;dependency&gt;
&lt;groupId&gt;org.basex&lt;/groupId&gt;
&lt;artifactId&gt;basex-api&lt;/artifactId&gt;
&lt;version&gt;7.6.3.4&lt;/version&gt;
&lt;/dependency&gt;</pre>
[[Category:Developer]]
[[Category===XQJ API=== <p>The XQJ API is hosted at http:Finish]]//xqj.net:</p> <pre class="brush:xml"><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></pre>
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu