diff --git a/mbuni/ChangeLog b/mbuni/ChangeLog index 5632840..6009f6e 100644 --- a/mbuni/ChangeLog +++ b/mbuni/ChangeLog @@ -1,3 +1,5 @@ +2011-03-28 P. A. Bagyenda + * Updated doc to include mmsbox admin interface info 2011-03-24 P. A. Bagyenda * Rolled MM1 MM7 module into main MMSBox code 2011-01-28 P. A. Bagyenda diff --git a/mbuni/doc/userguide.shtml b/mbuni/doc/userguide.shtml index 690e18c..4e99f80 100644 --- a/mbuni/doc/userguide.shtml +++ b/mbuni/doc/userguide.shtml @@ -67,13 +67,15 @@ This document describes the installation and usage of the MMS Gateway. -
  • MMS VAS Gateway-specific Configuration
  • Chapter 4: Gateway Architecture
    • MMSC Architecture
        @@ -1921,8 +1923,225 @@ Boolean     + + + mmsbox-admin-port +     + + Integer +     + + + VAS GW +     + + + + Optional port where mmsbox listens for administrative + commands (see below). +     + + + + + admin-port-ssl +     + + Boolean +     + + + VAS GW +     + + + + Whether admin port (above) is SSLed. +     + + + + + + admin-allow-ip +     + + string +     + + + VAS GW +     + + + + If set, admin requests will only be allowed if originated by one of + the IP addresses listed here (semi-colon separated list). +     + + + + + admin-deny-ip +     + + string +     + + + VAS GW +     + + + + If set, admin requests will not be allowed if originated by one of + the IP addresses listed here (semi-colon separated list). +     + + + + + admin-password +     + + string +     + + + VAS GW +     + + + + Authentication password for admin port +     + +
        + +

        Using the VAS Gateway Administration + Interface

        + + Mbuni VAS Gateway provides an administration interface (HTTP-based) + to view the status of MMSC connections, start or stop all or a + specific MMSC connection. (This is especially useful if the + configurations are being loaded dynamically using a configurations module.) To use the interface, you load a + URL of the form: + +

        +http://server_ip:server_admin_port/command_uri?password=admin_password?mmsc-id=mmsc +

        + +If admin-port-ssl was set to yes then you must +use https://. The server_admin_port and admin_password should be given +as specified in the configuration file. Supported command_uri +values are: +
        +
        stop
        To stop a specific MMSC link, specified using + the mmsc-id CGI parameter.This means no MT MMS will be + routed out via this connection until it is started again. The provided ID must match + the ID of one of the mmsc groups defined in the + configuration file. If mmsc-id is not provided, all + defined MMSC connections are stopped.
        + +
        start
        To start a specific MMSC link, specified using + the mmsc-id CGI parameter. The provided ID must match + the ID of one of the mmsc groups defined in the + configuration file. If mmsc-id is not provided, all + defined MMSC connections are started.
        + +
        status
        To retrieve the status of a specific MMSC link, specified using + the mmsc-id CGI parameter. The provided ID must match + the ID of one of the mmsc groups defined in the + configuration file. If mmsc-id is not provided, all + defined MMSC connections' status is reported.
        + +
        + + The response in each case is XML-formatted. For the status + command, the result is the following form: +
        +
+<mmsbox>
+<mmsc id="eaif" type="EAIF">
+ <port>8190</port>
+<group>eaif</group>
+<throughput>0.0000</throughput>
+<re-route>false</re-route>
+<reroute-mmsc>N/A</reroute-mmsc>
+<stats>
+<uptime>23 secs</uptime>
+<last-pdu>n/a</last-pdu>
+<mt><pdus>0</pdus><errors>0</errors></mt>
+<mo><pdus>0</pdus><errors>0</errors></mo>
+</stats>
+</mmsc>
+<mmsc id="mail" type="MM4">
+ <port>n/a</port>
+<group>mail</group>
+<throughput>0.0000</throughput>
+<re-route>false</re-route>
+<reroute-mmsc>N/A</reroute-mmsc>
+<stats>
+<uptime>23 secs</uptime>
+<last-pdu>n/a</last-pdu>
+<mt><pdus>0</pdus><errors>0</errors></mt>
+<mo><pdus>0</pdus><errors>0</errors></mo>
+</stats>
+</mmsc>
+<mmsc id="http" type="HTTP">
+ <port>9001</port>
+<group>http</group>
+<throughput>0.0000</throughput>
+<re-route>true</re-route>
+<reroute-mmsc>local</reroute-mmsc>
+<stats>
+<uptime>23 secs</uptime>
+<last-pdu>n/a</last-pdu>
+<mt><pdus>0</pdus><errors>0</errors></mt>
+<mo><pdus>0</pdus><errors>0</errors></mo>
+</stats>
+</mmsc>
+<mmsc id="local" type="SOAP">
+ <port>12345</port>
+<group>local</group>
+<throughput>0.0000</throughput>
+<re-route>false</re-route>
+<reroute-mmsc>N/A</reroute-mmsc>
+<stats>
+<uptime>23 secs</uptime>
+<last-pdu>n/a</last-pdu>
+<mt><pdus>0</pdus><errors>0</errors></mt>
+<mo><pdus>0</pdus><errors>0</errors></mo>
+</stats>
+</mmsc>
+</mmsbox>
+
        + The information includes basic MMSC configuration data, connection + uptime, time of last received PDU, received and sent PDUs, errors. + + For the start + command, the response is the same as that for status if the + command succeeds, otherwise the result is of the form: + +
        +<Start-Mmsc><Error>error message</Error></Start-Mmsc>
+
        + +For the stop command the result is of the form: +
        +<Stop-Mmsc><Success/></Stop-Mmsc>
+
        + +or +
        +<Stop-Mmsc><Failed/></Stop-Mmsc>
+
        +depending on whether the command succeeded or failed. + + +

        Built-in billing, resolver and detokenizer modules

        Mbuni supports one type of built-in modules: Shell script diff --git a/mbuni/mmsbox/mmsbox_cfg.c b/mbuni/mmsbox/mmsbox_cfg.c index 2dafe56..ed6eea0 100644 --- a/mbuni/mmsbox/mmsbox_cfg.c +++ b/mbuni/mmsbox/mmsbox_cfg.c @@ -1108,7 +1108,9 @@ static void append_mmsc_status(Octstr *rbody, MmscGrp *m, List *warnings) typ = "MM1"; else if (m->type == CUSTOM_MMSC) typ = "CUSTOM"; - else + else if (m->type == HTTP_MMSC) + typ = "HTTP"; + else typ = "none"; if (m->last_pdu > 0) {