docs/3.0/jar-files-and-dependencies.html

Title: JAR Files and Dependencies

	<P>This sections explains where all the relevant jar files are located. It also lists Cayenne dependencies.</P>

<H3><A name="JARFilesandDependencies-CayenneRuntimeFramework"></A>Cayenne Runtime Framework</H3>

<P>The following runtime jars are included in Cayenne distribution <TT>&quot;lib&quot;</TT> directory:</P>

<UL>
	<LI><B><TT>cayenne-server-x.x.jar</TT></B> - contains full Cayenne runtime WITHOUT dependencies. Most applications will use only this file.</LI>
</UL>


<UL>
	<LI><TT>cayenne-client-x.x.jar</TT> - a subset of cayenne-server.jar trimmed for use on the client in an <A href="remote-object-persistence-guide.html" title="Remote Object Persistence Guide">ROP application</A>.</LI>
	<LI><TT>cayenne-tools-x.x.jar</TT> - Ant tasks</LI>
	<LI><TT>cayenne-modeler-x.x.jar</TT> - CayenneModeler runtime library. Most applications won't ever use it. It is only needed for the <A href="using-jndi.html" title="Using JNDI">local JNDI hack</A>.</LI>
</UL>


<P>When using <TT>cayenne-server-x.x.jar</TT> you'll need a few third party jars (all included in <TT>&quot;lib/third-party&quot;</TT> directory of the distribution):</P>

<UL>
	<LI><A href="http://objectstyle.org/ashwood/" class="external-link" rel="nofollow">ObjectStyle Ashwood Graph Library</A>, version 2.0</LI>
	<LI><A href="http://jakarta.apache.org/velocity/" class="external-link" rel="nofollow">Apache Velocity Template Engine</A>, version 1.3 (and all its dependencies bundled with velocity-dep)</LI>
	<LI><A href="http://jakarta.apache.org/commons/collections" class="external-link" rel="nofollow">Apache Commons Collections</A>, version 3.1</LI>
	<LI><A href="http://jakarta.apache.org/commons/logging/" class="external-link" rel="nofollow">Apache Commons Logging</A>, version 1.1</LI>
</UL>


<P>ROP client dependencies are explained <A href="remote-object-persistence-installation.html" title="Remote Object Persistence Installation">here</A>.</P>

<H3><A name="JARFilesandDependencies-OptionalRuntimeDependencies"></A>Optional Runtime Dependencies</H3>

<P>One or more of the following libraries may be needed depending on how you use Cayenne:</P>

<UL>
	<LI><A href="http://ant.apache.org/" class="external-link" rel="nofollow">Apache Ant</A>, version 1.6 or newer. Needed for <A href="ant-tasks.html" title="Ant Tasks">Cayenne Ant Tasks</A>.</LI>
	<LI><A href="http://jakarta.apache.org/commons/pool/" class="external-link" rel="nofollow">Apache Commons Pool</A>, version 1.2 and <A href="http://jakarta.apache.org/commons/dbcp/" class="external-link" rel="nofollow">Apache Commons DBCP</A>, version 1.2.1. Needed if you use DBCPDataSourceFactory for one of the DataNodes.</LI>
	<LI><A href="http://www.jgroups.org/" class="external-link" rel="nofollow">JGroups</A>, version 2.2.7 or newer. Needed if you plan to use remote notifications via JGroups transport.</LI>
	<LI><A href="http://java.sun.com/products/jms/" class="external-link" rel="nofollow">Java Messaging Service (JMS)</A>. Needed if you plan to use remote notifications via JMS transport.</LI>
	<LI><A href="http://vpp.sourceforge.net/" class="external-link" rel="nofollow">Foundry Logic VPP Library</A>, version 2.2.1 (included in <TT>&quot;lib/third-party&quot;</TT> directory of the distribution). Needed for <A href="cgen.html" title="cgen">class generation options</A> with Ant.</LI>
	<LI><A href="http://www.opensymphony.com/oscache/" class="external-link" rel="nofollow">OSCache</A> version 2.3.2 or newer. Needed if you plan to use OSCache as your <A href="query-result-caching.html" title="Query Result Caching">query results cache provider</A>.</LI>
</UL>