<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/2030/1/7/_/styles/combined.css?spaceKey=TOP&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/TOP/Building+Java+components">Building Java components</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~dlee">David M. Lee</a>
</h4>
<br/>
<div class="notificationGreySide">
<p>Components that interact with Asterisk SCF may be written in <a href="http://java.com" class="external-link" rel="nofollow">Java</a>. They can do this by using the Java bindings for the Asterisk SCF interfaces.</p>
<p>Asterisk SCF provides an <a href="htttp://ant.apache.org" class="external-link" rel="nofollow">Ant</a> <tt>build.xml</tt> file for building the Java bindings, and installing them into the local <a href="http://www.maven.org" class="external-link" rel="nofollow">Maven</a> repository.</p>
<h1><a name="BuildingJavacomponents-Buildinstructions"></a>Build instructions</h1>
<p>If you've built Asterisk SCF from a clone of <tt>gitall</tt>, then you can cd into the <tt>slice</tt> directory. Otherwise, you can obtain the latest slice definitions by cloning <tt>git://git.asterisk.org/asterisk-scf/integration/slice</tt>.</p>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/wiki/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>Be sure that the slice definitions you are using are consistent with those you used to compile Asterisk SCF. The safest thing to do is to just build the Java bindings from the same sources as you built Asterisk SCF.</td></tr></table></div>
<h2><a name="BuildingJavacomponents-%28Maven%29InstallingIcetothelocalrepository"></a>(Maven) Installing Ice to the local repository</h2>
<p>If you're using Maven, you must install the Ice <tt>.jar</tt> file to your local Maven repository. Our <tt>build.xml</tt> file provides a <tt>install-ice</tt> target for doing just this. You only need to do this once, or whenever you re-compile Ice.</p>
<ol>
<li>Set the environment variable <tt>ICE_HOME</tt> to your Ice installation prefix.</li>
<li>Change to the <tt>slice</tt> directory, and run <tt>ant install-ice</tt></li>
</ol>
<h2><a name="BuildingJavacomponents-Building"></a>Building </h2>
<ol>
<li>Set the environment variable <tt>ICE_HOME</tt> to your Ice installation prefix.</li>
<li>Change to the <tt>slice</tt> directory, and run <tt>ant install</tt></li>
</ol>
<p>The build generates the following files:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<script type="syntaxhighlighter" class="toolbar: false; theme: Confluence; brush: java; gutter: false"><![CDATA[
./target/asterisk-scf-api.jar
./target/asterisk-scf-api-javadoc.jar
./target/asterisk-scf-api-sources.jar
]]></script>
</div></div>
<h1><a name="BuildingJavacomponents-UsagewithMaven"></a>Usage with Maven</h1>
<p>Add the following dependency to your <tt>pom.xml</tt> file:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<script type="syntaxhighlighter" class="toolbar: false; theme: Confluence; brush: xml; gutter: false"><![CDATA[
<dependency>
<groupId>com.digium.asteriskscf</groupId>
<artifactId>api</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
]]></script>
</div></div>
<h1><a name="BuildingJavacomponents-UsagewithoutMaven"></a>Usage without Maven</h1>
<p>Copy <tt>./target/asterisk-scf-api.jar</tt> to wherever you like to keep Java libraries, and add it to your classpath. Also add <tt>$ICE_HOME/lib/Ice.jar</tt> to your classpath, where <tt>$ICE_HOME</tt> is the installation prefix for your Ice install.</p>
<p>If you use an IDE, I also recommend attaching the sources and javadoc to the library. This makes navigating the API much easier.</p>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;">
<a href="https://wiki.asterisk.org/wiki/users/viewnotifications.action" class="grey">Change Notification Preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/TOP/Building+Java+components">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/TOP/Building+Java+components?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>