Revision: 6ca00b6003b1
Author: [email protected] <[email protected]>
Date: Tue Dec 11 06:33:11 2012
Log: doc review diameter-cca
http://code.google.com/p/jain-slee/source/detail?r=6ca00b6003b1&repo=diameter
Modified:
/resources/diameter-cca/docs/sources/src/main/resources/en-US/Chapter-Clustering.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Chapter-Resource_Adaptor_Type.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Section-Activities.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Section-Events.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Section-Resource_Adaptor_Interface.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Section-Default_Resource_Adaptor_Entities.xml
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Section-Logging_Traces_and_Alarms.xml
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/Chapter-Clustering.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/Chapter-Clustering.xml
Tue Dec 11 06:33:11 2012
@@ -11,8 +11,8 @@
id="ra_clustering_failover">
<title>Failover</title>
<para>
- The Diameter stack used by the &THIS.PLATFORM; JAIN SLEE &THIS.RA;
Resource Adaptor supports application session failover, with specific
session state being replicated, thus only available for Application
sessions.
- Failover of application activities is transparent to SLEE applications.
This means that SLEE applications must be in charge of properly adapting
its state machine to recover generic session on node failure.
+ The Diameter stack used by the &THIS.PLATFORM; JAIN SLEE &THIS.RA;
Resource Adaptor supports application session failover with specific
session state being replicated. Therefore, failover is only available for
Application sessions.
+ Failover of application activities is transparent to SLEE applications.
This means that SLEE applications must be in charge of correctly adapting
its state machine to recover generic session on node failure.
</para>
</section>
<section
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
Tue Dec 11 06:33:11 2012
@@ -9,7 +9,7 @@
<title>Introduction to &THIS.PLATFORM; JAIN SLEE &THIS.RA; Resource
Adaptor</title>
- <para>This resource adaptor provides <acronym>DIAMETER</acronym>
<acronym>API</acronym> for <acronym>JSLEE</acronym> applications. <ulink
url="http://tools.ietf.org/html/rfc4006";>CCA</ulink> is a
<acronym>RFC</acronym> specification of <acronym>DIAMETER</acronym>
extension to allow real time credit control of end user services, ie.
<acronym>SIP</acronym> services, equipment access, network access, ...
etc.</para>
- <para>Events represent <acronym>DIAMETER CCA</acronym> messages received
by stack, that is requests and answers with command code equal to 272.
Events are fired either on client or server activity.</para>
+ <para>This resource adaptor provides <acronym>DIAMETER</acronym>
<acronym>API</acronym> for <acronym>JSLEE</acronym> applications. <ulink
url="http://tools.ietf.org/html/rfc4006";>CCA</ulink> is a
<acronym>RFC</acronym> specification of <acronym>DIAMETER</acronym>
extension to allow real time credit control of end user services, ie.
<acronym>SIP</acronym> services, equipment access, network
access,etc.</para>
+ <para>Events represent <acronym>DIAMETER CCA</acronym> messages received
by the stack. These events are, requests and answers with command code
equal to 272. Events are fired either on client or server activity.</para>
<para>The activities are custom defined by <acronym>RA</acronym> Type to
ease use of <acronym>RA</acronym>. Activities represent
<acronym>DIAMETER</acronym> session between two peers.
<acronym>SLEE</acronym> applications use activities to create,send and
receive messages.</para>
</chapter>
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Tue Sep 11 20:38:40 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/Chapter-Setup.xml
Tue Dec 11 06:33:11 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 Resource Adaptor hardware's main concern is RAM memory and
Java Heap size. It is recomended that for higher loads than 400 calls per
second <acronym>JVM</acronym> has atleast 1GB heap.</para>
+ <para>Sufficient system RAM and Java Heap size are very important when
working with Resource Adaptors. For loads higher than 400 calls per second,
it is recommended that your <acronym>JVM</acronym> has at least 1GB
heap.</para>
</section>
<section id="software_prerequisites">
<title>Software Prerequisites</title>
- <para>The <acronym>RA</acronym> requires &THIS.PLATFORM; JAIN SLEE
properly set.</para>
+ <para>The <acronym>RA</acronym> requires that &THIS.PLATFORM; JAIN SLEE
is correctly set.</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 &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 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
@@ -50,14 +50,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 set to point to the
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>This is a similar procedure to <xref
linkend="release_source_building"/>. However, the Git reference should be
the <literal>master</literal> branch. The <literal>git checkout
tags/&THIS.VERSION;</literal> command should not be performed. To switch to
the master branch, do the following:</para>
<programlisting>
[usr]$ git checkout master
</programlisting>
@@ -71,16 +71,16 @@
<programlisting>
[usr]$ ant
</programlisting>
- <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>
+ <para>The script will copy the RA deployable unit jar to the
<literal>default</literal> &THIS.PLATFORM; JAIN SLEE server/default/deploy
directory. You can deploy to another server profile using the argument
<literal>-Dnode=</literal>.</para>
</section>
<section id="uninstall">
<title>Uninstalling &THIS.PLATFORM; JAIN SLEE &THIS.RA; Resource
Adaptor</title>
- <para>To uninstall the Resource Adaptor simply execute provided ant
script <filename>build.xml</filename> <literal>undeploy</literal>
target:</para>
+ <para>To uninstall the Resource Adaptor simply execute the provided ant
script <filename>build.xml</filename> <literal>undeploy</literal>
target:</para>
<programlisting>
[usr]$ ant undeploy
</programlisting>
- <para>The script will delete the RA deployable unit jar from the
<literal>default</literal> &THIS.PLATFORM; JAIN SLEE server profile deploy
directory, to undeploy from another server profile use the argument
<literal>-Dnode=</literal>.</para>
+ <para>The script will delete the RA deployable unit jar from the
<literal>default</literal> &THIS.PLATFORM; JAIN SLEE server profile deploy
directory. To undeploy from another server profile use the argument
<literal>-Dnode=</literal>.</para>
</section>
</chapter>
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Chapter-Resource_Adaptor_Type.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Chapter-Resource_Adaptor_Type.xml
Tue Dec 11 06:33:11 2012
@@ -9,7 +9,7 @@
<title>Resource Adaptor Type</title>
- <para>Diameter CCA Resource Adaptor Type is defined by Mobicents team as
part of effort to standarize RA Types.</para>
+ <para>Diameter CCA Resource Adaptor Type is defined by Mobicents team as
part of the effort to standarize RA Types.</para>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude";
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Section-Activities.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Section-Activities.xml
Tue Dec 11 06:33:11 2012
@@ -25,7 +25,7 @@
requests.
</para>
<para>
- This activity type can be created with
call to one of
+ This activity type can be created with
a call to one of the
methods
of
CreditControlProvider. It ends once
underlying credit control
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Section-Events.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Section-Events.xml
Tue Dec 11 06:33:11 2012
@@ -152,6 +152,6 @@
</table>
<important>
- <para>Spaces where introduced in <literal>Name</literal> and
<literal>Class</literal> column values, to correctly render the table.
Please remove them when using copy/paste.</para>
+ <para>Spaces where introduced in <literal>Name</literal> and
<literal>Class</literal> column values so that tables can be correctly
render. Please remove them when using copy/paste.</para>
</important>
</section>
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Section-Resource_Adaptor_Interface.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra-type/Section-Resource_Adaptor_Interface.xml
Tue Dec 11 06:33:11 2012
@@ -9,8 +9,8 @@
<title>Resource Adaptor Interface</title>
- <para>Resource Adaptor SBB Interface provides SBBs with means of
- accessing RA objects required for interaction in DIAMETER
world. It
+ <para>Resource Adaptor SBB Interface provides SBBs with ways to access
+ RA objects that are required for interaction in the DIAMETER
world. It
is defined as follows:</para>
<programlisting language="Java" role="JAVA">
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Chapter-Resource_Adaptor.xml
Tue Dec 11 06:33:11 2012
@@ -9,7 +9,7 @@
<title>Resource Adaptor Implementation</title>
- <para>This <acronym>RA</acronym> uses the &THIS.PLATFORM; diameter stack
to provide service. The stack is the result of the work done by
&THIS.PLATFORM; JAIN SLEE and Diameter development teams.</para>
+ <para>This <acronym>RA</acronym> uses the &THIS.PLATFORM; diameter stack
to provide service. The stack is the result of the work done by the
&THIS.PLATFORM; JAIN SLEE and the Diameter development teams.</para>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude";
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Section-Configuration.xml
Tue Dec 11 06:33:11 2012
@@ -38,7 +38,7 @@
</table>
<important>
- <para>JAIN SLEE 1.1 Specification requires values set for properties
without a default value, which means the configuration for those properties
are mandatory, otherwise the Resource Adaptor Entity creation will
fail!</para>
+ <para>JAIN SLEE 1.1 Specification requires values set for properties
without a default value, which means the configuration for those properties
are mandatory, otherwise, the Resource Adaptor Entity creation will
fail!</para>
</important>
</section>
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Section-Default_Resource_Adaptor_Entities.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Section-Default_Resource_Adaptor_Entities.xml
Tue Dec 11 06:33:11 2012
@@ -11,7 +11,7 @@
<para>There is a single Resource Adaptor Entity created when deploying
the Resource Adaptor, named <literal>DiameterCCA</literal>. The
<literal>DiameterCCA</literal> entity uses the default Resource Adaptor
configuration, specified in <xref linkend="ra_configuration" />.</para>
- <para>The <literal>DiameterCCA</literal> entity is also bound to Resource
Adaptor Link Name <literal>DiameterCCA</literal>, to use it in an Sbb add
the following XML to its descriptor:</para>
+ <para>The <literal>DiameterCCA</literal> entity is also bound to Resource
Adaptor Link Name <literal>DiameterCCA</literal>. The following XML
descriptor must be added if you want to use <literal>DiameterCCA</literal>
in an Sbb:</para>
<programlisting language="XML" role="XML"><![CDATA[
<resource-adaptor-type-binding>
=======================================
---
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Section-Logging_Traces_and_Alarms.xml
Sun Aug 12 10:49:01 2012
+++
/resources/diameter-cca/docs/sources/src/main/resources/en-US/ra/Section-Logging_Traces_and_Alarms.xml
Tue Dec 11 06:33:11 2012
@@ -12,7 +12,7 @@
<section id="ra_tracers">
<title>Tracers</title>
<para>Each Resource Adaptor Entity uses a single JAIN SLEE 1.1 Tracer,
named <literal>DiameterCCAResourceAdaptor</literal>.
- The related Log4j Logger category, which can be used to change the
Tracer level from Log4j configuration, is
<literal>javax.slee.RAEntityNotification[entity=DiameterCCAResourceAdaptor]</literal>.</para>
+ The related Log4j Logger category,
<literal>javax.slee.RAEntityNotification[entity=DiameterCCAResourceAdaptor]</literal>,
can be used to change the Tracer level from Log4j configuration.</para>
</section>
<section id="ra_alarms">
