blob: 86a61dd971717bf58eb0b76f602e6f765a450dfc [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>2.5. General setup information</title>
<link rel="stylesheet" type="text/css" href="../../css/style.css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../index.html" title="Jubula Developer Manual">
<link rel="up" href="clientAPI.html" title="Chapter 2. Writing UI tests via API">
<link rel="prev" href="creating-cap-instances.html" title="2.4. Creating CAP instances">
<link rel="next" href="ch02s06.html" title="2.6. Sample setup of the API usage">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">2.5. General setup information</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="creating-cap-instances.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2. Writing UI tests via API</th>
<td width="20%" align="right"> <a accesskey="n" href="ch02s06.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div xmlns:d="http://docbook.org/ns/docbook" class="breadcrumbs">
<span class="breadcrumb-link"><a href="../index.html">Jubula Developer Manual</a></span> &gt; <span class="breadcrumb-link"><a href="clientAPI.html">Writing UI tests via API</a></span> &gt; <span class="breadcrumb-node">General setup information</span>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="id295608"></a>2.5. General setup information</h2></div></div></div>
<p>The following section describes where to find the relevant JARs / artifacts to use the API.
The provided API has a miminum required runtime environment of <span class="strong"><strong>Java 6</strong></span>.</p>
<p>In general the usage of the client API falls apart into three categories of JARs / maven artifacts
/ OSGi bundles:</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<p>Each project requires dependencies to <span class="strong"><strong>all</strong></span> of the <span class="strong"><strong>toolkit neutral parts</strong></span>
of the API:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>org.eclipse.jubula.client.api</p></li>
<li class="listitem"><p>org.eclipse.jubula.client.api.commands</p></li>
<li class="listitem"><p>org.eclipse.jubula.toolkit.api</p></li>
<li class="listitem"><p>org.eclipse.jubula.tools</p></li>
<li class="listitem"><p>org.eclipse.jubula.communication</p></li>
</ul></div>
</li>
<li class="listitem">
<p>Each project requires dependencies to <span class="strong"><strong>indiviual</strong></span> parts of the <span class="strong"><strong>toolkit specific elements</strong></span>
dependent from the used toolkit of the API:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>org.eclipse.jubula.toolkit.base.api</p></li>
<li class="listitem"><p>org.eclipse.jubula.toolkit.concrete.api</p></li>
<li class="listitem"><p>org.eclipse.jubula.toolkit.javafx.api</p></li>
<li class="listitem"><p>org.eclipse.jubula.toolkit.swt.api</p></li>
<li class="listitem"><p>org.eclipse.jubula.toolkit...TOOLKIT_ID...api</p></li>
</ul></div>
<p>Please keep in mind that <span class="strong"><strong>toolkits are derived</strong></span> from each other. So if you're e.g. setting up a JavaFX projects it is also
necessary to include the direct dependency to the specific toolkit artifact "org.eclipse.jubula.toolkit.javafx.api" itself as well as the toolkits its based upon:
"org.eclipse.jubula.toolkit.concrete.api" and its base "org.eclipse.jubula.toolkit.base.api".</p>
</li>
<li class="listitem">
<p>Each project also requires dependencies to <span class="strong"><strong>all</strong></span> of the <span class="strong"><strong>3rd party dependencies</strong></span>
of the API:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>Apache Commons Lang 2.4</p></li>
<li class="listitem"><p>Apache Commons Codec 1.4</p></li>
<li class="listitem"><p>SLF4j API</p></li>
<li class="listitem"><p>XStream 1.3.1</p></li>
<li class="listitem"><p>XPP3 min 1.1.4c</p></li>
<li class="listitem"><p>xmlpull 1.1.3.4a</p></li>
</ul></div>
</li>
</ol></div>
<p>You can find the artifacts in different shapes (plain JAR, maven artifact and OSGi bundles) within
the <span class="emphasis"><em>ITEInstallationFolder/development/api</em></span> folder.</p>
</div>
<br xmlns:d="http://docbook.org/ns/docbook"><hr xmlns:d="http://docbook.org/ns/docbook">
<address xmlns:d="http://docbook.org/ns/docbook">Copyright BREDEX GmbH 2015. Made available under the Eclipse Public License v1.0.</address>
<br xmlns:d="http://docbook.org/ns/docbook">
</body>
</html>