_posts/2011-01-18-use_apache_ant_to

--- layout: post status: PUBLISHED published: true title: Use Apache Ant to post to Apache ESME id: aaf2d338-5b89-45d9-bade-9fa4ba9cb8d1 date: '2011-01-18 11:28:43 -0500' categories: esme tags: - esme - microblogging permalink: esme/entry/use_apache_ant_to_post --- Apache ESME has an integration with <a href="http://ant.apache.org/" class="external-link" rel="nofollow">Apache Ant</a>. It is now possible to send messages to Apache ESME that describe the progress of your build steps. This is especially useful when Apache ESME is being used in development projects where individual developers can be made aware of the status of various-build related actions. For example, a development team could be informed that a build is broken or if it is successful.   <h2>Setup</h2> <h4 style="line-height: normal; font-weight: bold; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; margin-top: 25px; margin-right: 0px; margin-bottom: 4px; margin-left: 0px; "><a name="AntClient-Setup"></a></h4> <ol style="line-height: 13pt; list-style-type: decimal; "> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Install Apache Ant</li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Install Apache Maven</li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Download the Apache Commons packages <a href="http://commons.apache.org/codec/" class="external-link" rel="nofollow">"Codec"</a> and <a href="http://commons.apache.org/logging/download_logging.cgi" class="external-link" rel="nofollow">Logger</a>. We also need <a href="http://hc.apache.org/" class="external-link" rel="nofollow">Apache "Httpclient</a>" . Please note that we are currently using the legacy 3.1 version of the HTTP Client. </li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Check-out the ESME java client: <a href="https://svn.apache.org/repos/asf/esme/trunk/esme-java-client_" class="external-link" rel="nofollow">https://svn.apache.org/repos/asf/esme/trunk/esme-java-client</a></li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Perform a maven build in this directory with the following command "mvn compile package -Dmaven.test.skip=true" . This will create a jar file "esme-rest-api-0.1.jar" in the target directory. </li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Create lib directory and copy "rest-api-0.1-SNAPSHOT.jar", "commons-codec-1.2.jar", "commons-httpclient-3.1.jar" and "commons-logging-1.1.1.jar" into this directory. </li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Create src directory and copy the "EsmeAntTask.java" file to this directory</li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Change the build.xml file to point to the appropriate directories</li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Change the token in the "esme" target in the build.xml file to a correct token.</li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">Change the proxy in the "esme" target in the build.xml file to a correct proxy.</li> <li style="line-height: 13pt; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; ">call ant dist esme to test the application</li> </ol> <div> Here is what the result looks like: <a href="https://blogs.apache.org/esme/mediaresource/d4d6de99-366b-49f3-ad5b-4bbbb35949c3"><img src="https://blogs.apache.org/esme/mediaresource/d4d6de99-366b-49f3-ad5b-4bbbb35949c3?t=true" alt="ant blog.jpg" /></a> <a href="https://blogs.apache.org/esme/mediaresource/d4d6de99-366b-49f3-ad5b-4bbbb35949c3"> Note: We wrote a version of this blog two years ago on our old blog. I've updated it and added an image plus more details.  </a> </div> <h2>Build.xml</h2> <div> <pre class="code-xml" style="padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; text-align: left; overflow-x: auto; overflow-y: auto; direction: ltr; "><project name="EsmeViaAnt" default="dist" basedir=".">  <property name="src" location="src"/> <property name="build" location="build"/> <property name="dist" location="dist"/> <path id="project.class.path"> <pathelement path="./dist/lib/EsmeViaAnt.jar:./lib/esme-rest-api-0.1.jar:./lib/commons-codec-1.4.jar:./lib/commons-logging-1.1.1.jar:./lib/commons-httpclient-3.1.jar"/> </path> <target name="init">  <tstamp/>  <mkdir dir="${build}"/> </target> <target name="compile" depends="init" description="compile the source " >  <javac srcdir="${src}" destdir="${build}"> <classpath refid="project.class.path"/> </javac> </target> <target name="dist" depends="compile" description="generate the distribution" >  <mkdir dir="${dist}/lib"/>  <jar jarfile="${dist}/lib/EsmeViaAnt.jar" basedir="${build}"/> </target> <target name="esme" description="Send Esme" > <java fork="true" classname="EsmeAntTask"> <arg value="http://esmecloudserverapache.dickhirsch.staxapps.net/api"/> <arg value="31EL0R0M15NTD2LSOS0BKC5Y0P5JOVAZ6"/> <arg value="myproxy:81"/> <arg value="A message from the ant build process"/> <classpath> <pathelement path="./dist/lib/EsmeViaAnt.jar:./lib/esme-rest-api-0.1.jar:./lib/commons-codec-1.4.jar:./lib/commons-logging-1.1.1.jar:./lib/commons-httpclient-3.1.jar"/> </classpath> </java> </target> </project> <h2>EsmeAntTask java class</h2><pre class="code-java" style="padding-top: 0px; padding-right: 0px; padding-bottom: 0px; padding-left: 0px; margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px; text-align: left; overflow-x: auto; overflow-y: auto; 'Courier New', Courier, monospace; line-height: 1.3; ">import org.apache.esme.api.EsmeRestApi; import org.apache.esme.model.Message; public class EsmeAntTask { public static void main (String[] args) { String apiUrl; String authToken; String localProxy; String message; EsmeRestApi esme; apiUrl = args[0]; authToken = args[1]; localProxy = args[2]; message = args[3]; try { esme = new EsmeRestApi(apiUrl); if ((localProxy != null) && !("".equals(localProxy))) { // Split proxyHost:port into two parts String[] proxy = localProxy.split(":"); esme.setProxy(proxy[0], Integer.parseInt(proxy[1])); } esme.login(authToken); Message esmeMsg = new Message(); esmeMsg.setBody(message); String[] tags = new String[1]; tags[0] = "Ant Task"; esmeMsg.setTags(tags); esmeMsg.setSource("Ant"); esme.sendMsg(esmeMsg); } catch (Exception e) {} } </pre> }    </div>

_posts/2011-01-18-use_apache_ant_to_post.html (120 lines of code) (raw):