<?xml version="1.0" encoding="UTF-8"?>
<!--
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - JASMINe
  - Copyright (C) 2012 Bull S.A.S.
  - Contact: jasmine@ow2.org
  -
  - This library is free software; you can redistribute it and/or
  - modify it under the terms of the GNU Lesser General Public
  - License as published by the Free Software Foundation; either
  - version 2.1 of the License, or any later version.
  -
  - This library is distributed in the hope that it will be useful,
  - but WITHOUT ANY WARRANTY; without even the implied warranty of
  - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  - Lesser General Public License for more details.
  -
  - You should have received a copy of the GNU Lesser General Public
  - License along with this library; if not, write to the Free Software
  - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  - USA
  -
  -
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  - $Id$
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-->
<sect1 version="5.0" xml:lang="en" xml:id="jasmineprobe.install" xmlns="http://docbook.org/ns/docbook"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:svg="http://www.w3.org/2000/svg"
  xmlns:mml="http://www.w3.org/1998/Math/MathML"
  xmlns:html="http://www.w3.org/1999/xhtml"
  xmlns:db="http://docbook.org/ns/docbook">

  <title>Installing JASMINe Probe</title>

    <para>
    The JASMINe Probe project provides several packages allowing to install and run the JASMINe Probe application.
    </para>
    <para>
      <itemizedlist>
       <listitem>
         <para>
           The <emphasis>jasmine-probe-standalone.zip</emphasis> package contains a ready to run OSGi based, micro <ulink url="http://jonas.ow2.org">JOnAS</ulink> platform,
           with the JASMINe Probe's application bundles already deployed, and a default configuration containing some probes definitions.
         </para>
       </listitem>
       <listitem>
         <para>A second package named <emphasis>jasmine-probe-rest.zip</emphasis> is available providing an extra interface based on REST for managing probes.
         The execution framework is based on another JOnAS profile containing support for JAX-RS.</para>
       </listitem>
       <listitem>
         <para>Finally, <emphasis>jprobe-client.jar</emphasis> represents a client Java application providing commands for the management of JASMINe Probe artifacts.</para>
       </listitem>
      </itemizedlist>
    </para>

    <para>
      Unpacking one of the packages results to a JASMINe Probe Agent - the pre-configured JOnAS platform having the JASMINe Probe application readily deployed and configured.
    </para>

    <para>
      Let's consider choosing <emphasis>jasmine-probe-standalone.zip</emphasis> package.
    </para>

    <para>
    <screen>
       $ cd ...
       $ unzip jasmine-probe-standalone.zip
       $ cd jasmine-probe-standalone
       $ pwd
       /home/.../jasmine-probe-standalone    &lt;------- <emphasis>jasmine-probe-standalone_dir</emphasis>
    </screen>
    </para>


    <para>Set the following environment variables:</para>

    <para>
    <screen>
       $ export JPROBE_ROOT=<emphasis>jasmine-probe-standalone_dir</emphasis>
       $ export PATH=$JPROBE_ROOT:$PATH
    </screen>
    </para>

  <para>
    The <emphasis>jasmine-probe-standalone_dir</emphasis> installation directory contains
    several files and directories including:
  </para>
  <para>
    <itemizedlist>
     <listitem>
       <para><emphasis>jasmine-probe.sh</emphasis> and <emphasis>jasmine-probe.bat</emphasis> commands allowing to start/stop the platform.</para>
     </listitem>
     <listitem>
       <para><emphasis>conf</emphasis> directory containing configuration files for JOnAS and a <emphasis>probe-config.xml</emphasis> configuration file containing some JASMINe Probe artifacts definitions.</para>
     </listitem>
     <listitem>
       <para><emphasis>jprobe-client.jar</emphasis> client application allowing to dynamically create and manage JASMINe Probe artifacts.</para>
     </listitem>
     <listitem>
       <para>
         <emphasis>deploy</emphasis> directory containing a deployment plan for JASMINe Probe modules' deployment.
       </para>
     </listitem>
     <listitem>
       <para><emphasis>repositories</emphasis>, a local maven repository containing the JASMINe Probe modules.
       </para>
     </listitem>
   </itemizedlist>
  </para>

    <para>
      The same result is obtained by choosing <emphasis>jasmine-probe-rest.zip</emphasis> package.
      The difference consists in additional JASMINe Probe modules containing a RESTful Web Service for the management of JASMINe Probe artifacts.
    </para>
</sect1>
