Revision: b629d8688115
Author: [email protected] <[email protected]>
Date: Wed Jan 2 05:40:52 2013
Log: doc review slee diameter RF resource adaptor
http://code.google.com/p/jain-slee/source/detail?r=b629d8688115&repo=diameter
Modified:
/resources/diameter-rf/docs/sources/src/main/resources/en-US/Book_Info.xml
/resources/diameter-rf/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
/resources/diameter-rf/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
/resources/diameter-rf/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
=======================================
---
/resources/diameter-rf/docs/sources/src/main/resources/en-US/Book_Info.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-rf/docs/sources/src/main/resources/en-US/Book_Info.xml
Wed Jan 2 05:40:52 2013
@@ -13,7 +13,9 @@
<pubsnumber>1</pubsnumber>
<abstract>
- <para>&THIS.PLATFORM; JAIN SLEE &THIS.RA; Resource Adaptor
(<acronym>RA</acronym>) is the JAIN SLEE 1.1 RA for the
<acronym>IMS</acronym> Rf Interface, the reference point for Offline
Charging in <acronym>IMS</acronym> and follows a mechanism where charging
information <emphasis>does not</emphasis> affect, in real-time, the service
rendered. In other words, <acronym>CTF</acronym> simply informs
<acronym>OCF</acronym> how many units service intaraction consumed. It is
described in <ulink
url="http://www.3gpp.org/ftp/Specs/html-info/32260.htm";>TS32.260</ulink>
and <ulink
url="http://www.3gpp.org/ftp/Specs/html-info/32299.htm";>TS32.299</ulink> by
<acronym>3GPP</acronym>.</para>
+ <para>&THIS.PLATFORM; JAIN SLEE &THIS.RA; Resource Adaptor
(<acronym>RA</acronym>) is the JAIN SLEE 1.1 RA for the
<acronym>IMS</acronym> Rf Interface. It is the reference point for Offline
Charging in <acronym>IMS</acronym> and it follows a mechanism where
charging information <emphasis>does not</emphasis> affect, in real-time,
the service rendered. In other words, <acronym>CTF</acronym> informs
<acronym>OCF</acronym> how many units service interaction is consumed.
+
+It is described in <ulink
url="http://www.3gpp.org/ftp/Specs/html-info/32260.htm";>TS32.260</ulink>
and <ulink
url="http://www.3gpp.org/ftp/Specs/html-info/32299.htm";>TS32.299</ulink> by
<acronym>3GPP</acronym>.</para>
<para>This RA implements the Resource Adaptor Type defined by Mobicents
development teams.</para>
</abstract>
=======================================
---
/resources/diameter-rf/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-rf/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Wed Jan 2 05:40:52 2013
@@ -10,7 +10,7 @@
<title>Introduction to &THIS.PLATFORM; JAIN SLEE &THIS.RA; Resource
Adaptor</title>
<para>This resource adaptor provides a Diameter API for JAIN SLEE
applications, according to Rf inteface based on Diameter protocol.</para>
- <para>Rf is one of two IMS reference point for charging. It covers
offline charging - scenarios where charging information <emphasis>does
not</emphasis> affect, in real-time, the service rendered.</para>
+ <para>Rf is one of two IMS reference points for charging. It covers
offline charging - scenarios where charging information <emphasis>does
not</emphasis> affect, in real-time, the service rendered.</para>
<para>Offline Charging occurs between two peers: the CTF (the online
client, which issues request for accounting) and CDF (the server which
performs accounting).</para>
<para>Two cases are currently distinguished for offline charging
purposes:
<itemizedlist>
@@ -18,7 +18,7 @@
<listitem>Session based charging.</listitem>
</itemizedlist>
</para>
- <para>For offline charging the Diameter Base Accounting defined in IETF
<ulink url="http://tools.ietf.org/html/rfc3588";>RFC 3588</ulink> is used
with additional AVPs defined. Also it reuses the FSM from Diameter Base
Accounting.</para>
+ <para>For offline charging, the Diameter Base Accounting defined in IETF
<ulink url="http://tools.ietf.org/html/rfc3588";>RFC 3588</ulink> is used
with additional AVPs defined. It also reuses the FSM from Diameter Base
Accounting.</para>
<para>Events are reused from Diameter Base Resource Adaptor and represent
messages received by the Diameter stack. Different events types are
specified for each Diameter request or answer. Events are fired either on
client or server activities.</para>
<para>The Activities are defined by <acronym>RA</acronym> Type (and are
an extension to Base Accounting Activities) to ease use of
<acronym>RA</acronym>. Activities represent Diameter session between two
peers. <acronym>SLEE</acronym> applications use activities to create, send
and receive messages.</para>
=======================================
---
/resources/diameter-rf/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Tue Sep 11 20:38:40 2012
+++
/resources/diameter-rf/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Wed Jan 2 05:40:52 2013
@@ -10,15 +10,19 @@
<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 Resource Adaptor hardware's main concern is RAM memory and
Java Heap size, the more the better. For instance, while the underlying
&THIS.PLATFORM; JAIN SLEE may run with 1GB of RAM, 8GB is needed to achieve
performance higher than 800 new requests per second.</para>
- <para>Of course, memory is only needed to store the Resource Adaptor
state, the faster the CPU more requests per second are supported, yet no
particular CPU is a real requirement to use the RA.</para>
+ <para>RAM and Java Heap size are very important with regards to
Resource Adaptor. The more the RAM, the better the performance will be. For
instance, while the underlying Mobicents JAIN SLEE may run with 1GB of RAM,
8GB is needed to achieve performance higher than 800 new requests per
second</para>
+ <para>Memory is only needed to store the Resource Adaptor state.
Therefore, the faster the CPU, the more requests per second can be quickly
processed. That said, there is no minimum specified CPU speed required to
use the RA.</para>
</section>
<section id="software_prerequisites">
<title>Software Prerequisites</title>
- <para>The RA requires &THIS.PLATFORM; JAIN SLEE properly set and
Mobicents Diameter Multiplexer (<acronym>MUX</acronym>), which includes the
stack, and &THIS.PLATFORM; Diameter Base RA to be properly installed
too.</para>
+
+<para>
+The RA requires that &THIS.PLATFORM; is correctly set and that Mobicents
Diameter Multiplexer (<acronym>MUX</acronym>), which includes the stack and
the &THIS.PLATFORM; is correctly installed.
+</para>
+
</section>
</section>
@@ -34,7 +38,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 &THIS.SOURCE_CODE_URL; , 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 &THIS.SOURCE_CODE_URL;. Choose the desired
release version as can be seen in the following example
&THIS.VERSION;.</para>
<programlisting>
[usr]$ git clone &THIS.SOURCE_CODE_URL;
mobicents-jain-slee-diameter
[usr]$ cd mobicents-jain-slee-diameter
@@ -51,14 +55,14 @@
[usr]$ cd resources/&THIS.RA.DIRNAME;
[usr]$ mvn install
</programlisting>
- <para>Once the process finishes you should have the
<literal>deployable-unit</literal> jar file in the
<filename>target</filename> directory, if &THIS.PLATFORM; JAIN SLEE is
installed and environment variable JBOSS_HOME is pointing to its underlying
&JEE.PLATFORM; directory, then the deployable unit jar will also be
deployed in the container.</para>
+ <para>Once the build is completed, you should have the
<literal>deployable-unit</literal> jar file in the
<filename>target</filename> directory, if &THIS.PLATFORM; JAIN SLEE is
installed and environment variable JBOSS_HOME is pointing to its underlying
&JEE.PLATFORM; directory, then the deployable unit jar will also be
deployed in the container.</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"/>, 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>
<programlisting>
[usr]$ git checkout master
</programlisting>
@@ -72,6 +76,10 @@
<programlisting>
[usr]$ ant
</programlisting>
+
+<para>
+The script will copy the RA deployable unit jar to the
<literal>default</literal> &THIS.PLATFORM; server/default/deploy directory.
To deploy to another server profile, use the argument -Dnode=.
+</para>
<para>The script will copy the RA deployable unit jar to the
<literal>default</literal> &THIS.PLATFORM; JAIN SLEE server profile deploy
directory, to deploy to another server profile use the argument
<literal>-Dnode=</literal>.</para>
</section>
=======================================
---
/resources/diameter-rf/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-rf/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Wed Jan 2 05:40:52 2013
@@ -9,7 +9,7 @@
<title>Resource Adaptor Implementation</title>
- <para>This <acronym>RA</acronym> uses the &THIS.PLATFORM; Diameter Stack,
an improvement over <ulink url="http://jdiameter.dev.java.net";>jDiameter
Stack</ulink>. The stack is the result of the work done by &THIS.PLATFORM;
Diameter and jDiameter development teams, and source code is provided in
all releases.</para>
+ <para>This <acronym>RA</acronym> uses the &THIS.PLATFORM; Diameter Stack,
which is an improvement over <ulink
url="http://jdiameter.dev.java.net";>jDiameter Stack</ulink>. The stack is
the result of the work done by &THIS.PLATFORM; Diameter and jDiameter
development teams, and source code is provided in all releases.</para>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude";
