Revision: 16268
Author: baranowb
Date: Sat Jan 8 07:03:48 2011
Log: [No log message]
http://code.google.com/p/mobicents/source/detail?r=16268
Modified:
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-MAP.xml
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Shell.xml
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-TCAP.xml
=======================================
---
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-MAP.xml
Sat Jan 8 00:47:01 2011
+++
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-MAP.xml
Sat Jan 8 07:03:48 2011
@@ -5,27 +5,61 @@
%BOOK_ENTITIES;
]>
-<chapter id="map">
+<chapter
+ id="map">
<title>MAP</title>
- <para>Mobile application part (<acronym>MAP</acronym>) is the protocol
that is used to allow the <acronym>GSM</acronym> network nodes
- within the Network Switching Subsystem (<acronym>NSS</acronym>) to
communicate with each other to provide services, such as roaming capability,
- text messaging (<acronym>SMS</acronym>), Unstructured Supplementary
Service Data (<acronym>USSD</acronym>) and subscriber authentication.
- <acronym>MAP</acronym> provides an application layer on which to build
the services that support a <acronym>GSM</acronym> network.
- This application layer provides a standardized set of services.
<acronym>MAP</acronym> uses the services of the <acronym>SS7</acronym>
network,
- specifically the Signaling Connection Control Part
(<acronym>SCCP</acronym>) and the Transaction Capabilities Application Part
(<acronym>TCAP</acronym>)
- </para>
- <important><para>For better understanding of this chapter please read GSM
09.02.</para> </important>
-
<para>
- <classname>org.mobicents.protocols.ss7.map.api.MAPStack</classname>
interface defines the methods required to represent MAP Protocol Stack.
- MAPStack exposes
<classname>org.mobicents.protocols.ss7.map.api.MAPProvider</classname> that
interacts directly with MAPStack. This interface
- defines the methods that will be used by any registered MAP User
application implementing the
-
<classname>org.mobicents.protocols.ss7.map.api.MAPDialogListener</classname>
and
<classname>org.mobicents.protocols.ss7.map.api.MAPServiceListener</classname>
- interface to listen MAP messages and dialogue handling primitives. The
class diagram looks like
+ Mobile application part (
+ <acronym>MAP</acronym>
+ ) is the protocol that is used to allow the
+ <acronym>GSM</acronym>
+ network nodes
+ within the Network Switching Subsystem (
+ <acronym>NSS</acronym>
+ ) to communicate with each other to provide services, such as roaming
capability,
+ text messaging (
+ <acronym>SMS</acronym>
+ ), Unstructured Supplementary Service Data (
+ <acronym>USSD</acronym>
+ ) and subscriber authentication.
+ <acronym>MAP</acronym>
+ provides an application layer on which to build the services that
support a
+ <acronym>GSM</acronym>
+ network.
+ This application layer provides a standardized set of services.
+ <acronym>MAP</acronym>
+ uses the services of the
+ <acronym>SS7</acronym>
+ network,
+ specifically the Signaling Connection Control Part (
+ <acronym>SCCP</acronym>
+ ) and the Transaction Capabilities Application Part (
+ <acronym>TCAP</acronym>
+ )
</para>
-
+ <important>
+ <para>For better understanding of this chapter please read GSM
09.02.</para>
+ </important>
+ <section
+ id="map_usage">
+ <title>&THIS.APPLICATION;
+ MAP Usage
+ </title>
+ <para>
+
<classname>org.mobicents.protocols.ss7.map.api.MAPStack</classname>
+ interface defines the methods required to represent MAP
Protocol Stack.
+ MAPStack exposes
+
<classname>org.mobicents.protocols.ss7.map.api.MAPProvider</classname>
+ that interacts directly with MAPStack. This interface
+ defines the methods that will be used by any registered MAP User
application implementing the
+
<classname>org.mobicents.protocols.ss7.map.api.MAPDialogListener</classname>
+ and
+
<classname>org.mobicents.protocols.ss7.map.api.MAPServiceListener</classname>
+ interface to listen MAP messages and dialogue handling primitives. The
class diagram looks like
+ </para>
+
<mediaobject
id="map_classdia">
<imageobject>
@@ -36,43 +70,90 @@
format="PNG" />
</imageobject>
<caption>
- <para>&THIS.PLATFORM; &THIS.APPLICATION; MAP
Class Diagram
+ <para>&THIS.PLATFORM; &THIS.APPLICATION;
+ MAP Class Diagram
</para>
</caption>
- </mediaobject>
-
- <note><para>&THIS.PLATFORM; &THIS.APPLICATION; MAP has implementation for
USSD Message only. Any contribution to implement
- message specific to SMS or other are welcome. We will provide you all the
help that you may need initially.</para></note>
-
- <para>
- <classname>org.mobicents.protocols.ss7.map.MAPStackImpl</classname> is
concrete implementation of <classname>MAPStack</classname>.
- The MAP User application creates instance of
<classname>MAPStackImpl</classname> passing the reference of
<classname>SccpProvider</classname> and
- new instance of <classname>SccpAddress</classname> representing address
to which bind listenes. TODO : Bartek
- </para>
-
- <programlisting
- language="Java"
- role="JAVA"><![CDATA[
+ </mediaobject>
+
+ <note>
+ <para>&THIS.PLATFORM; &THIS.APPLICATION;
+ MAP has implementation for USSD Message only. Any contribution to
implement
+ message specific to SMS or other are welcome. We will provide you all
the help that you may need initially.
+ </para>
+ </note>
+
+ <para>
+
<classname>org.mobicents.protocols.ss7.map.MAPStackImpl</classname>
+ is concrete implementation of
+ <classname>MAPStack</classname>
+ .
+ The MAP User application creates instance of
+ <classname>MAPStackImpl</classname>
+ passing the reference of
+ <classname>SccpProvider</classname>
+ and
+ new instance of
+ <classname>SccpAddress</classname>
+ representing address to which bind listener. This addess will be used
to match against destination address in <literal>SCCP</literal> messages.
+ </para>
+
+ <programlisting
+ language="Java"
+ role="JAVA"><![CDATA[
SccpProvider sccpProvider = getSccpProvider(); //JNDI lookup of SCCP
Stack and get Provider
SccpAddress localAddress createLocalAddress();
MAPStackImpl mapStack = new MAPStackImpl(sccpPprovider,
localAddress);
-
- ]]>
- </programlisting>
-
- <para>The reference to <classname>SccpProvider</classname> is received
from <classname>SccpStack</classname>.
- To get handle to <classname>SccpStack</classname> do the JNDI look-up
passing the
- JNDI name configured in SS7 service as explained in <xref
linkend="sccp_access_point"/> </para>
-
- <para>The MAP User application should register the concrete
implementation of
- <classname>MAPDialogListener</classname> and
<classname>MAPServiceListener</classname>
- with <classname>MAPProvider</classname> to listen for incoming MAP
Dialog and MAP Primitive messages.
- </para>
-
- <programlisting
- language="Java"
- role="JAVA"><![CDATA[
+
+ ...
+
+ private SccpAddress createLocalAddress()
+ {
+ int translationType = 0;
+
+ int subSystemNumber = 0;
+
+
+ GlobalTitle gt = GlobalTitle.getInstance(translationType,
+
+ NumberingPlan.ISDN_MOBILE, NatureOfAddress.NATIONAL, "1234");
+
+ SccpAddress localAddress = new SccpAddress(gt, 0);
+ return localAddress;
+ }
+
+
+ ]]>
+ </programlisting>
+
+ <para>
+ The reference to
+ <classname>SccpProvider</classname>
+ is received from
+ <classname>SccpStack</classname>
+ .
+ To get handle to
+ <classname>SccpStack</classname>
+ do the JNDI look-up passing the
+ JNDI name configured in SS7 service as explained in
+ <xref
+ linkend="sccp_access_point" />
+ </para>
+
+ <para>
+ The MAP User application should register the concrete
implementation of
+ <classname>MAPDialogListener</classname>
+ and
+ <classname>MAPServiceListener</classname>
+ with
+ <classname>MAPProvider</classname>
+ to listen for incoming MAP Dialog and MAP Primitive
messages.
+ </para>
+
+ <programlisting
+ language="Java"
+ role="JAVA"><![CDATA[
public class MAPExample implements MAPDialogListener, MAPServiceListener {
.....
mapProvider = mapStack.getMAPProvider();
@@ -81,14 +162,20 @@
....
}
]]>
- </programlisting>
-
- <para>The MAP User Application leverages
<classname>MapServiceFactory</classname> to create instance of
- <classname>USSDString</classname> and
<classname>AddressString</classname> </para>
-
- <programlisting
- language="Java"
- role="JAVA"><![CDATA[
+ </programlisting>
+
+ <para>
+ The MAP User Application leverages
+ <classname>MapServiceFactory</classname>
+ to create instance of
+ <classname>USSDString</classname>
+ and
+ <classname>AddressString</classname>
+ </para>
+
+ <programlisting
+ language="Java"
+ role="JAVA"><![CDATA[
MapServiceFactory servFact = mapProvider.getMapServiceFactory();
USSDString ussdString =
servFact.createUSSDString("*125*+31628839999#",
null);
@@ -97,14 +184,19 @@
AddressNature.international_number, NumberingPlan.ISDN,
"31628838002");
]]>
- </programlisting>
-
- <para>The MAP User Application leverages
<classname>MAPProvider</classname> to create new
- <classname>MAPDialog</classname> and send USSD message</para>
-
- <programlisting
- language="Java"
- role="JAVA"><![CDATA[
+ </programlisting>
+
+ <para>
+ The MAP User Application leverages
+ <classname>MAPProvider</classname>
+ to create new
+ <classname>MAPDialog</classname>
+ and send USSD message
+ </para>
+
+ <programlisting
+ language="Java"
+ role="JAVA"><![CDATA[
// First create Dialog
MAPDialog mapDialog = mapProvider.createNewDialog(
MAPApplicationContext.networkUnstructuredSsContextV2,
@@ -129,13 +221,19 @@
// This will initiate the TC-BEGIN with INVOKE component
mapDialog.send();
]]>
- </programlisting>
-
- <para>The complete example looks like</para>
-
- <programlisting
- language="Java"
- role="JAVA"><![CDATA[
+ </programlisting>
+
+ </section>
+ <section
+ id="map_usage_example">
+ <title>&THIS.APPLICATION;
+ MAP Usage
+ </title>
+ <para>The complete example looks like</para>
+
+ <programlisting
+ language="Java"
+ role="JAVA"><![CDATA[
public class MAPExample implements MAPDialogListener, MAPServiceListener {
private MAPStack mapStack;
@@ -288,5 +386,6 @@
}
]]>
- </programlisting>
+ </programlisting>
+ </section>
</chapter>
=======================================
---
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Shell.xml
Fri Jan 7 02:20:48 2011
+++
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Shell.xml
Sat Jan 8 07:03:48 2011
@@ -83,7 +83,7 @@
<example>
<title>Disconnect</title>
<screen>
-mobicents(10.65.208.215:3435)>ss7 connect
+mobicents(10.65.208.215:3435)>ss7 disconnect
Bye
mobicents>
=======================================
---
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-TCAP.xml
Sat Jan 8 00:47:01 2011
+++
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-TCAP.xml
Sat Jan 8 07:03:48 2011
@@ -54,7 +54,8 @@
<para>
<classname>org.mobicents.protocols.ss7.tcap.TCAPStackImpl</classname>
is concrete implementation of <classname>TCAPStack</classname>.
The TCAP User Part creates instance of
<classname>TCAPStackImpl</classname> passing the reference of
<classname>SccpProvider</classname> and
- new instance of <classname>SccpAddress</classname> representing address
to which bind listens. TODO : Bartek
+ new instance of <classname>SccpAddress</classname> representing address
to which bind listenr. <literal>TCAP</literal> stack creates internaly
&THIS.PLATFORM; <literal>MAP</literal> Stack implementation.
+ Passed <literal>SccpAddress</literal> is used to match against incoming
messages destination address.
</para>
<programlisting
@@ -64,6 +65,24 @@
SccpAddress localAddress createLocalAddress();
TCAPStack tcapStack = new TCAPStackImpl(sccpPprovider,
localAddress);
+
+
+ ...
+
+ private SccpAddress createLocalAddress()
+ {
+ int translationType = 0;
+
+ int subSystemNumber = 0;
+
+
+ GlobalTitle gt =
GlobalTitle.getInstance(translationType,
+
+ NumberingPlan.ISDN_MOBILE, NatureOfAddress.NATIONAL,
"1234");
+
+ SccpAddress localAddress = new SccpAddress(gt, 0);
+ return localAddress;
+ }
]]>
</programlisting>
@@ -120,7 +139,8 @@
<section>
<title>&THIS.PLATFORM; &THIS.APPLICATION; TCAP User Part
Example</title>
- <para>Below is TCAP User Part example</para>
+ <para>Below is TCAP User Part example. This example creates dialog and
exchanges messages withing structured dialog. Refer to source for function
calls:
+ </para>
<programlisting
language="Java"
role="JAVA"><![CDATA[