Revision: 5e7b19eb65d3
Author: [email protected] <[email protected]>
Date: Mon Dec 10 10:05:17 2012
Log: review example slee-connectivity
http://code.google.com/p/jain-slee/source/detail?r=5e7b19eb65d3&repo=javaee
Modified:
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Logging_Traces_and_Alarms.xml
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Running.xml
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Source_Code_Overview.xml
=======================================
---
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
Wed Aug 15 08:29:07 2012
+++
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
Mon Dec 10 10:05:17 2012
@@ -8,8 +8,10 @@
<title>Design Overview</title>
- <para>The &THIS.EXAMPLE;
- Example is composed by two parts: a JMX Bean to be deployed in a JBoss
AS5 instance, the Java EE application which will be used to fire JAIN SLEE
event to the JAIN SLEE container; and a JAIN SLEE application, to be
deployed in the JAIN SLEE container, which will handle the events fired,
printing information about it in the container's console.
+ <para>There are two parts to the &THIS.EXAMPLE;
+ example. </para>
+ <para>The first part is the JMX Bean to be deployed in a JBoss AS5
instance. Within this context, the Java EE application will be used to fire
JAIN SLEE events to the JAIN SLEE container </para>
+<para> The second part is the JAIN SLEE application to be deployed in the
JAIN SLEE container, which will handle the events fired, printing
information about it in the container's console.
</para>
<section id="design_overview_sbb">
@@ -20,10 +22,10 @@
</para>
<itemizedlist>
<listitem>
- <para>detach from activity where the event was fired, this will allow
the container to end it implicitly, since it becomes unreferenced.</para>
+ <para>The Slee service detaches from the activity where the event was
fired. This lets the container end the event as it becomes
unreferenced.</para>
</listitem>
<listitem>
- <para>log the message contained in the event, which can be seen in the
container's console.</para>
+ <para>The Slee service logs the message contained in the event. The
message will then become visible in the container's console.</para>
</listitem>
</itemizedlist>
</section>
=======================================
---
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Wed Aug 15 08:29:07 2012
+++
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Mon Dec 10 10:05:17 2012
@@ -13,7 +13,7 @@
Example
</title>
<para>
- This example demonstrates the usage of SLEEConnection API, present in
JAIN SLEE 1.1 specification, by a Java EE application, to fire events into
a &THIS.PLATFORM; JAIN SLEE container. The Java EE application and the
&THIS.PLATFORM; JAIN SLEE container may be in same or different JVM.
+ This is an example that will demonstrate how to use SLEEConnection API
that is present in JAIN SLEE 1.1 specification. A Java EE application will
be used to fire events into a &THIS.PLATFORM; JAIN SLEE container. The Java
EE application and the &THIS.PLATFORM; JAIN SLEE container may be in the
same or in different JVM.
</para>
</chapter>
=======================================
---
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Logging_Traces_and_Alarms.xml
Wed Aug 15 08:29:07 2012
+++
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Logging_Traces_and_Alarms.xml
Mon Dec 10 10:05:17 2012
@@ -16,7 +16,7 @@
<section id="alarms">
<title>Alarms</title>
- <para>Example does not rise any alarms.</para>
+ <para>The example does not raise any alarms.</para>
</section>
</chapter>
=======================================
---
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Running.xml
Wed Aug 15 08:29:07 2012
+++
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Running.xml
Mon Dec 10 10:05:17 2012
@@ -8,8 +8,11 @@
<title>Running the Example</title>
- <para>To run example, start <literal>JBOSS AS</literal> container and
access its <literal>jmx-console</literal>. Open
<literal>http://${jboss.bind.address}:port/jmx-console</literal> in
browser.</para>
- <note><para><literal>jboss.bind.address</literal> and
<literal>port</literal> depends on how container is started, by default its
equal to: <literal>http://127.0.0.1:8080/jmx-console</literal> </para>
</note>
- <para>Lookup bean with name equal to:
<literal>org.mobicents.slee:name=SleeConnectivityExample</literal> and
invoke operations. Pass distinct argument to operation. If operation is
successful, passed value should be shown in &THIS.PLATFORM; JAIN SLEE
Console</para>
+ <para>To run the example, start the <literal>JBOSS AS</literal> container
and access its <literal>jmx-console</literal>. </para>
+
+<para> Open
<literal>http://${jboss.bind.address}:port/jmx-console</literal> in your
internet browser.</para>
+
+ <note><para><literal>jboss.bind.address</literal> and
<literal>port</literal> depends on how the container is started. The
default port is 8080 and can be accessed as follows:
<literal>http://127.0.0.1:8080/jmx-console</literal> </para> </note>
+ <para>Look for the bean named as:
<literal>org.mobicents.slee:name=SleeConnectivityExample</literal> and
invoke its operations. Pass distinct argument to operation. If the
operation is successful, passed value will be shown in &THIS.PLATFORM; JAIN
SLEE Console</para>
</chapter>
=======================================
---
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Tue Sep 11 20:37:35 2012
+++
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Mon Dec 10 10:05:17 2012
@@ -10,14 +10,14 @@
<section id="preinstall_requirements_and_prerequisites">
<title>Pre-Install Requirements and Prerequisites</title>
- <para>Ensure that the following requirements have been met before
continuing with the install.</para>
+ <para>Ensure that the following requirements have been met before
continuing with the installation.</para>
<section id="hardware_requirements">
<title>Hardware Requirements</title>
- <para>The Example doesn't change the &THIS.PLATFORM; JAIN SLEE Hardware
Requirements, refer to &THIS.PLATFORM; JAIN SLEE documentation for more
information.</para>
+ <para>The Example doesn't change the &THIS.PLATFORM; JAIN SLEE Hardware
Requirements. Refer to &THIS.PLATFORM; JAIN SLEE documentation for more
information.</para>
</section>
<section id="software_prerequisites">
<title>Software Prerequisites</title>
- <para>The Example requires &THIS.PLATFORM; JAIN SLEE properly set. In
case of using separated JVMs to host the JAva EE and JAIN SLEE
applications, the &THIS.PLATFORM; JAIN SLEE Remote SLEE Connection Tool
must be deployed in the Java EE server, and properly configured, to be able
to interact with the remote JAIN SLEE container.</para>
+ <para>The example in this user guide requires that &THIS.PLATFORM; JAIN
SLEE is properly set. In case you are using separated JVMs to host the Java
EE and JAIN SLEE applications, the &THIS.PLATFORM; JAIN SLEE Remote SLEE
Connection Tool must be deployed in the Java EE server. The remote
connection tool must be properly configured so that it can interact with
the remote JAIN SLEE container.</para>
</section>
</section>
@@ -33,7 +33,7 @@
<important>
<para>Git is used to manage Mobicents JAIN SLEE source code.
Instructions for downloading, installing and using Git can be found at
<ulink url="http://git-scm.com/"; /></para>
</important>
- <para>Use Git to checkout a specific release source, the Git
repository URL is https://code.google.com/p/jain-slee.javaee/ , then switch
to the specific release version, lets consider &THIS.VERSION;.</para>
+ <para>Use Git to checkout a specific release source. The Git
repository URL is located at https://code.google.com/p/jain-slee.javaee/ .
For example, if the release version is &THIS.VERSION;, you will proceed as
follows:</para>
<programlisting>
[usr]$ git clone https://code.google.com/p/jain-slee.javaee
mobicents-jain-slee-javaee
[usr]$ cd mobicents-jain-slee-javaee
@@ -45,19 +45,23 @@
<important>
<para>Maven 2.0.9 (or higher) is used to build the release.
Instructions for using Maven2, including install, can be found at <ulink
url="http://maven.apache.org"; /></para>
</important>
- <para>Use Ant to build the binary.</para>
- <programlisting>
+ <note>
+ <title>Building the binary </title>
+ <para>You must use Ant to build the
binary.</para>
+ </note>
+
+ <programlisting>
[usr]$ cd examples/slee-connectivity
[usr]$ mvn install
</programlisting>
- <para>Once the process finishes you should have the JAIN SLEE
<literal>deployable-unit</literal> jar file in the
<filename>slee/du/target</filename> directory, and JMX Client in the
javaee/beans/target directory.</para>
+ <para>Once the process is completed, you should have the JAIN SLEE
<literal>deployable-unit</literal> jar file in the
<filename>slee/du/target</filename> directory, and JMX Client in the
javaee/beans/target directory.</para>
</step>
</procedure>
</section>
<section id="master_source_building">
<title>Development Master Source Building</title>
- <para>Similar process as for <xref linkend="release_source_building"/>,
the only change is the Git reference should be the
<literal>master</literal>. The <literal>git checkout
tags/&THIS.VERSION;</literal> command should not be performed. If already
performed, the following should be used in order to switch back to the
master:</para>
+ <para>The procedure is similar to <xref
linkend="release_source_building"/>. You must make sure you are in the
<literal>master</literal> branch. The <literal>git checkout
tags/&THIS.VERSION;</literal> command should not be performed. Use the
following command to check out the master branch:</para>
<programlisting>
[usr]$ git checkout master
</programlisting>
@@ -67,17 +71,17 @@
<section id="install">
<title>Installing &THIS.PLATFORM; JAIN SLEE &THIS.EXAMPLE;
Example</title>
- <para>To install just copy the JMX Client -bean directory to the deploy
directory of the JBoss AS5, and the JAIN SLEE deployable unit to the deploy
directory of the JAIN SLEE container.</para>
+ <para>Installing the example requires that you copy the JMX Client -bean
directory to the deploy directory of the JBoss AS5, and the JAIN SLEE
deployable unit to the deploy directory of the JAIN SLEE container.</para>
</section>
<section id="uninstall">
<title>Uninstalling &THIS.PLATFORM; JAIN SLEE &THIS.EXAMPLE;
Example</title>
- <para>To uninstall simply delete the JMX Client -bean directory and JAIN
SLEE deployable unit jar copied in the install procedures.</para>
+ <para>To uninstall simply delete the JMX Client -bean directory and JAIN
SLEE deployable unit jar created in the install phase.</para>
</section>
<section id="remote-javaee-configuration">
<title>Configuring the Java EE server to interact with a remote JAIN
SLEE</title>
- <para>In this setup the &THIS.PLATFORM; JAIN SLEE Remote SLEE Connection
Tool must be deployed and properly configured, in the Java EE server,
please refer to its User Guide for instructions on how to install and
configure it.</para>
+ <para>You must configure and deploy the &THIS.PLATFORM; JAIN SLEE Remote
SLEE Connection Tool in the Java EE server. Please refer to the Java EE
server User Guide for instructions on how to install and configure the
remote connection tool.</para>
</section>
</chapter>
=======================================
---
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Source_Code_Overview.xml
Wed Aug 15 08:29:07 2012
+++
/examples/slee-connectivity/docs/sources/src/main/resources/en-US/Chapter-Source_Code_Overview.xml
Mon Dec 10 10:05:17 2012
@@ -9,7 +9,7 @@
<title>Source Code Overview</title>
<important>
<para>
- To obtain the example's complete source code please
refer to
+ To obtain the complete source code of this example
please refer to
<xref linkend="source_code" />.
</para>
</important>
@@ -18,9 +18,9 @@
<title>Source Code Overview: Sbb</title>
<note>
<para>
- For full descirption of
+ The sip-wakeup example has more detailed
descirption of the
<acronym>XML</acronym>
- please refer to simpler examples, like
sip-wakeup
+ and it should be easier to grasp for most users.
</para>
</note>
<para><acronym>SBB</acronym> descriptor is very simple. Its only purpose
is to define <acronym>SBB</acronym> abstract class and event handler.
