Revision: 16147
Author: baranowb
Date: Mon Jan 3 03:31:49 2011
Log: [No log message]
http://code.google.com/p/mobicents/source/detail?r=16147
Modified:
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Management.xml
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Setup_Configure.xml
=======================================
---
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Management.xml
Sun Jan 2 06:27:22 2011
+++
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Management.xml
Mon Jan 3 03:31:49 2011
@@ -4,12 +4,396 @@
%BOOK_ENTITIES;
]>
-<chapter id="management">
+<chapter
+ id="management">
<title>Management</title>
- <para>mgmgmgmgm</para>
-
-
+ <para>&THIS.PLATFORM; &THIS.APPLICATION;
+ provides Shell client to manage configuration. This chapter describes
available commands.
+ </para>
+ <para>Shell client can be started with following command:</para>
+ <programlisting>
+[$] ./bin/ss7-run.sh
+ </programlisting>
+ <para>Once console starts, it will print following information:</para>
+ <screen>
+=========================================================================
+
+Mobicents SS7: release.version=1.0.0-SNAPSHOT
+This is free software, with components licensed under the GNU General
Public License
+version 2 and other licenses. For further details visit
http://mobicents.org
+=========================================================================
+
+mobicents>
+ </screen>
+ <section
+ id="management_command_connect">
+ <title>Connect</title>
+ <para>Shell needs to connect to managed instance. Command to connect has
following structure:</para>
+ <programlisting>
+ss7 connect <IP> <PORT> </programlisting>
+ <example>
+ <title>Connec to remote machine</title>
+ <screen>
+mobicents>ss7 connect 10.65.208.215 3435
+
+mobicents(10.65.208.215:3435)>
+ </screen>
+ </example>
+ </section>
+ <section
+ id="management_linkset">
+ <title>Linkset</title>
+ <para>
+ Linksets are managed by
+ <literal>linkset</literal>
+ command. It allows to perform following:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>create linkset</para>
+ </listitem>
+ <listitem>
+ <para>delete linkset</para>
+ </listitem>
+ <listitem>
+ <para>activate linkset</para>
+ </listitem>
+ <listitem>
+ <para>deactivate linkset</para>
+ </listitem>
+ <listitem>
+ <para>create link</para>
+ </listitem>
+ <listitem>
+ <para>delete link</para>
+ </listitem>
+ <listitem>
+ <para>activate link</para>
+ </listitem>
+ <listitem>
+ <para>deactivate link</para>
+ </listitem>
+ </itemizedlist>
+
+ <section
+ id="management_linkset_create">
+ <title>Create Linkset</title>
+ <para>Linkset can be create by issuing command with following
structure:</para>
+ <programlisting>
+linkset create <linkset-type> opc <point-code> apc
<point-code> ni <network-id> <linkset-name>
+ </programlisting>
+ <para>or in case of dialogic:</para>
+ <programlisting>
+linkset create dialogic opc <point-code> apc <point-code> ni
<network-id> srcmod <src-mode> destmod <dest-mode>
<linkset-name>
+
+ </programlisting>
+ <para>Where:</para>
+ <variablelist>
+ <varlistentry>
+ <term>linkset-type</term>
+ <listitem>
+ <para>
+ refers to type of
linkset to be created, ie.
+ <literal>dahdi</literal>
+ ,
+
<literal>dialogic</literal>
+ or
+ <literal>m3ua</literal>
+ . Correct values depend on which linkset factories have been
deployed. <!-- AMIT: add reference to linkset section/chapter -->
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>point-code</term>
+ <listitem>
+ <para>
+ is simply
+ <literal>MTP</literal>
+ point - either local(
+ <literal>opc</literal>
+ ) or remote(
+ <literal>dpc</literal>
+ )
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ni</term>
+ <listitem>
+ <para>is simply network identifier. It can have following
values:</para>
+ <variablelist>
+ <varlistentry>
+ <term>0</term>
+ <listitem>
+
<para>International network</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>1</term>
+ <listitem>
+ <para>Spare
(for international use only)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>2</term>
+ <listitem>
+
<para>National network</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>3</term>
+ <listitem>
+
<para>Reserved for national use</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>simple string name, which
identifies linkset</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Linkset creation</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset create dahdi opc 1 apc 2 ni 0
linkset1
+LinkSet successfully added
+mobicents(10.65.208.215:3435)>linkset create dialogic opc 3 apc 4 ni 3
srcmod 1 destmod 2 linkset2
+LinkSet successfully added
+ </screen>
+ </example>
+ </section>
+
+
+ <section
+ id="management_linkset_delete">
+ <title>Remove Linkset</title>
+ <para>Linkset can be deleted by issuing command with following
structure:</para>
+ <programlisting>
+linkset delete <linkset-name> </programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Linkset Removal</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset delete linkset1
+LinkSet successfully deleted
+ </screen>
+ </example>
+ </section>
+
+ <section
+ id="management_linkset_activate">
+ <title>Activate Linkset</title>
+ <para>Linkset can be deleted by issuing command with following
structure:</para>
+ <programlisting>
+linkset activate <linkset-name> </programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Linkset Activation</title>
+ <screen>
+mobicents(10.65.208.215)>linkset activate linkset1
+LinkSet activated successfully
+ </screen>
+ </example>
+ </section>
+
+ <section
+ id="management_linkset_deactivate">
+ <title>Deactivate Linkset</title>
+ <para>Linkset can be deactivated by issuing command with following
structure:</para>
+ <programlisting>
+linkset deactivate <linkset-name> </programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Linkset Deactivateion</title>
+ <screen>
+mobicents(10.65.208.215)>linkset deactivate linkset1
+LinkSet deactivated successfully
+ </screen>
+ </example>
+ </section>
+
+ <section
+ id="management_linkset_link_create">
+ <title>Create Link</title>
+ <para>
+ <literal>Link</literal>
+ can be created in
+ <literal>Linkset</literal>
+ by issuing command with following structure:
+ </para>
+ <programlisting>
+linkset link create span <span-num> code <code-num> channel
<channel-num> <linkset-name> <link-name>
+ </programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>span-num</term>
+ <listitem>
+ <para>integer number. It represents port number in card(indexed from
0).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>code-num</term>
+ <listitem>
+ <para>link code(sls assigned to this
link).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>channel-num</term>
+ <listitem>
+ <para>integer number indicating time slot number(TDM time slot).
</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>link-name</term>
+ <listitem>
+ <para>name which identifies link in
linkset.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title></title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset link create span 1 code 1 channel 1
linkset1 link1
+Link successfully added
+ </screen>
+ </example>
+ </section>
+ <section
+ id="management_linkset_link_delete">
+ <title>Remove Link</title>
+ <para>
+ <literal>Link</literal>
+ can be removed from in
+ <literal>Linkset</literal>
+ by issuing command with following structure:
+ </para>
+ <programlisting>
+linkset link delete <linkset-name> <link-name>
</programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>link-name</term>
+ <listitem>
+ <para>name which identifies link in
linkset</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Link Removal</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset link delete linkset1 link1
+Link successfully deleted
+ </screen>
+ </example>
+ </section>
+ <section
+ id="management_linkset_link_activate">
+ <title>Activate Link</title>
+ <para>Link can be activated by issuing command with following
structure:</para>
+ <programlisting>
+linkset link activate <linkset-name> <link-name>
</programlisting>
+ <para>Where:</para>
+ <variablelist>
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>link-name</term>
+ <listitem>
+ <para>name which identifies link in
linkset</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Link Activation</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset link activate linkset1 link1
+Link activated successfully
+ </screen>
+ </example>
+ </section>
+ <section
+ id="management_linkset_link_deactivate">
+ <title>Deactivate Link</title>
+ <para>Link can be deactivated by issuing command with following
structure:</para>
+ <programlisting>
+linkset link deactivate <linkset-name> <link-name>
</programlisting>
+ <para>Where:</para>
+ <variablelist>
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>link-name</term>
+ <listitem>
+ <para>name which identifies link in
linkset</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Link Deactivateion</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset link deactivate linkset1 link1
+Link deactivated successfully
+ </screen>
+ </example>
+ </section>
+
+ </section>
+
</chapter>
=======================================
---
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Setup_Configure.xml
Sun Jan 2 06:27:22 2011
+++
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Setup_Configure.xml
Mon Jan 3 03:31:49 2011
@@ -505,9 +505,22 @@
<varlistentry>
<term>pattern</term>
<listitem>
- <para>is simply <literal>SCCP</literal> like regular expresion.
Destination address of message is matched against this to check which rule
should be triggered.
- </para>
- <para>Fields of <literal>pattern</literal> separated by
<literal>#</literal>, empty value is indicated by single
<literal>space</literal>. <literal>pattern</literal> has following
fields:</para>
+ <para>
+ is simply
+ <literal>SCCP</literal>
+ like regular expresion. Destination address of message is matched
against this to check which rule should be triggered.
+ </para>
+ <para>
+ Fields of
+
<literal>pattern</literal>
+ separated by
+ <literal>#</literal>
+ , empty value is
indicated by single
+ <literal>space</literal>
+ .
+
<literal>pattern</literal>
+ has following fields:
+ </para>
<table
frame="all"
pgwide="1">
@@ -540,14 +553,14 @@
<row>
<entry>numbering plan</entry>
<entry>enum</entry>
- <entry>Determines which numbering plan is used for global title.
It can have one of following values:
- UNKNOWN, ISDN_TELEPHONY, DATA, TELEX, MERITIME_MOBILE,
LAND_MOBILE, ISDN_MOBILE</entry>
+ <entry>Determines which numbering plan is used for global title.
It can have one of following values:
+ UNKNOWN, ISDN_TELEPHONY, DATA, TELEX, MERITIME_MOBILE,
LAND_MOBILE, ISDN_MOBILE</entry>
</row>
<row>
<entry>nature of address</entry>
<entry>enum</entry>
- <entry>Determines type of address. It can have one of following
values:
-
SPARE, SUBSCRIBER, UNKNOWN, NATIONAL, INTERNATIONAL</entry>
+ <entry>Determines type of address. It can have one of following
values:
+
SPARE, SUBSCRIBER, UNKNOWN, NATIONAL, INTERNATIONAL</entry>
</row>
<row>
<entry>digits</entry>
@@ -581,7 +594,10 @@
<varlistentry>
<term>mtpinfo</term>
<listitem>
- <para><literal>mtpinfo</literal> indicates which link should be
chosen when routing to remote location. In case routing is performed
localy, its not present. </para>
+ <para>
+
<literal>mtpinfo</literal>
+ indicates which link should be chosen when routing to remote
location. In case routing is performed localy, its not present.
+ </para>
<table
frame="all"
pgwide="1">
@@ -635,12 +651,90 @@
</varlistentry>
</variablelist>
+ </section>
+ <section
+ id="setup_configure_application">
+ <title>Application protocols</title>
+ <para>
+ Applications which use
+ <literal>SCCP</literal>
+ do not have to configure it. Only step required to enable application
to use
+ <literal>SCCP</literal>
+ is to look up
+ <literal>SCCP</literal>
+ provider and register as listener.
+ It can be done with following code:
+ </para>
+ <programlisting>
+import org.jboss.jmx.adaptor.rmi.RMIAdaptor;
+import java.util.*;
+import javax.management.MBeanServerConnection;
+import javax.naming.Context;
+import javax.naming.InitialContext;
+import javax.naming.NamingException;
+import org.mobicents.protocols.ss7.*;
+import org.mobicents.protocols.ss7.sccp.*;
+import org.mobicents.protocols.ss7.indicator.*;
+
+public class Test implements SccpListener
+{
+
+ private SccpProvider sccpProvider;
+ private MBeanServerConnection createMBeanServerConnection()
+ throws NamingException
+ {
+ //no arg is ok, if we run in JBoss
+ InitialContext ctx = new InitialContext();
+
+
+ String adapterName = "jmx/invoker/RMIAdaptor";
+
+ Object obj = ctx.lookup(adapterName);
+ ctx.close();
+
+ if (!(obj instanceof RMIAdaptor))
+ {
+ throw new ClassCastException
+ ("Object not of type: RMIAdaptorImpl, but: " +
+ (obj == null ? "not found" : obj.getClass().getName()));
+ }
+
+ return (MBeanServerConnection) obj;
+ }
+
+ public void start() throws Excetpion
+ {
+ //SS7Service is JMX bean, lets use it to get
+ MBeanServerConnection con = createMBeanServerConnection();
+ ObjectName on = new ObjectName("org.mobicents.ss7:service=SS7Service");
+
+ String providerJndiName = con.invoke(on,"getJndiName",null,null);
+ InitialContext ctx = new InitialContext();
+
+ this.sccpProvider = (SccpProvider) ctx.lookup(providerJndiName);
+ ctx.close();
+
+ SccpAddress localAddress = ....;
+
+ sccProvider.registerSccpListener(localAddress,this);
+ }
+
+ public void stop()
+ {
+ SccpAddress localAddress = ....;
+ this.sccpProvider.deregisterSccpListener(localAddress);
+
+ }
+
+ public void onMessage(SccpMessage message)
+ {
+ //our listener.
+ }
+
+}
+ </programlisting>
</section>
</section>
- <section
- id="setup_configure_application">
- <title>Application protocols</title>
- <para></para>
- </section>
+
</chapter>
