Multimedia Messaging Value Added Service Provider (VASP) MM7 SDK for MMC Release 2.5.2

The purpose of the document is to give a general description of the features and benefits available for Release 2.5.2 of the Multimedia Messaging Center (MMC) Value Added Service Provider (VASP) SDK. The VASP interface for the MMC is based upon the MM7 interface that is defined by 3GPP 23.140 v. 5.3 standard and compliant to the v.5.5 XML schema.

The white paper does not focus on the detailed deployment of the MM7 interface that Ericsson has implemented with the MMC 2.5.2 release. Instead, it provides an overview of the MM7 VASP SDK that is available for the Ericsson MMC 2.5.2 release.)

The MM7 SDK zip file contains the following items:

• MM7 API (also include a MM7 VASP Listerner package i.e. Java Servlets in a Jar file)                        
• MMS-C Emulator (WAR file application for deployment on JavaEE web container)                        
• Sample code                        
• API specification - Javadoc

MM7 SDK Compatibility Aspects

From an application developer’s perspective, an SDK is used to avoid compatibility issues between releases. Please use the complementary information on the getting started page for more information.

MMS MM7 SDK 2.5.2

To start server-side application development or integration with the MM7 application program interfaces (API), you need to do the following:

1. Download the "Developer's guide" document for this MM7 software developer kit (SDK).              
2. Download the MM7 SDK 2.5.2.              
3. Read the developer's guide. You should also use the complementary information that you can find below.              
4. For development, import the included MM7 jar lib to your environment and read the API specification (Javadoc) for the MM7 API.             
5. Use the Ericsson MMC emulator included in the MM7 SDK. This will make it easy for you to test your server-side application without a real Ericsson MMC.

Important information for getting started with the MM7 SDK version 2.5.2

Sun XML Summer pack, Apache SOAP 2.3.1 and Tomcat 4.0.3 are old versions of the Java software used by the MM7 SDK. Since these are older versions, they can be difficult to find and download from the Internet. We recommend replacement software that can be used together with the MM7 VASP SDK. The VASP interface for the MMC is based upon the MM7 interface that is defined by 3GPP 23.140 v. 5.3 standard and compliant to the v.5.5 XML schema.

Replacement tips:
Sun XML Summer pack is compatible with Java Web Services Developer Pack 1.4 (JWSDP 1.4). Apache SOAP 2.2 is compatible with the last version of Apache SOAP 2.3.1 before it was replaced. Tomcat 4.0.3 can be replaced by Tomcat 5.0.28.

Quick guide for setting up and testing the MM7 SDK with JWSDP 1.4 and Apache SOAP 2.3.1

Instructions:

1. Download JWSDP 1.4 from http://java.sun.com/webservices/downloads/previous/index.jsp             
2. Download Apache SOAP 2.3.1 SDK from http://ws.apache.org/mirrors.cgi Direct download link here: http://apache.archive.sunet.se/dist/ws/soap/version-2.3.1/soap-bin-2.3.1.zip             
3. Download Tomcat 5.0.28 from http://jakarta.apache.org/site/binindex.cgi             
4. Install Tomcat 5.0.28 to "c:\tomcat" for example             
5. Set TOMCAT_HOME = "c:\tomcat" as environment variable             
6. Install JWSDP 1.4 to a JWSDP home directory of such as "c:\jwsdp"             
7. Set JWSDP_HOME = "c:\jwsdp" as environment variable             
8. Unzip the Apache SOAP 2.3.1 and copy and the following files:  
   copy soap.jar C:\apache-soap\lib\
   copy soap.war C:\tomcat\webapps\             
9. Unzip the MM7 VASP SDK zip package to "c:\Ericsson-vasp-mm7"             
10. Copy the MMC emulator to the TOMCAT directory, for example
    copy C:\Ericsson-vasp-mm7\webapps\vasp.war C:\tomcat\webapps             
11. Add the following class path to the environment variables
    set CLASSPATH = C:\apache-soap\lib\soap.jar;C:\Ericsson-vasp-mm7\lib\vasp.jar;%JWSDP_HOME%\jwsdp-shared\lib\mail.jar;%JWSDP_HOME%\jwsdp-shared\lib\activation.jar;%JWSDP_HOME%\saaj\lib\saaj-impl.jar;%JWSDP_HOME%\saaj\lib\saaj-api.jar;%JWSDP_HOME%\jaxp\lib\endorsed\dom.jar;%JWSDP_HOME%\jaxp\lib\endorsed\xercesImpl.jar;%JWSDP_HOME%\jaxp\lib\jaxp-api.jar;%JWSDP_HOME%\jaxp\lib\endorsed\sax.jar;             
12. Copy the following jar files from JWSDP to %TOMCAT_HOME%\shared\lib
    . Soap.jar
    . Mail.jar
    . Activation.jar
    . Dom.jar
    . Sax.jar
    . Jaxp-api.jar
    . XercesImpl.jar             
13. Start Tomcat and Test Apache SOAP 2.3.1 with the URL http://localhost:8080/soap/servlet/rpcrouter             
14. Configure the MMC emulator by editing the file c:\Ericsson-vasp-mm7\bin\deploy.cmd. Make sure that the file attribute is not set to "read-only".
    If TOMCAT default port number is 8080, then change the following row in the file from:
    SERVERURL=http://localhost:8888/vasp/servlet/rpcrouter
     to:
    SET SERVERURL=http://localhost:8080/vasp/servlet/rpcrouter             
15. Run the c:\Ericsson-vasp-mm7\bin\deploy.cmd file             
16. Test the MMC Emulator with URL http://localhost:8080/vasp/

How to run example code
To run the example code "testapp.java" from c:\Ericsson-vasp-mm7\samples

copy C:\Ericsson-vasp-mm7\samples\mms2.smil c:\
copy C:\Ericsson-vasp-mm7\samples\mlogo_117x49.gif c:\
copy C:\Ericsson-vasp-mm7\samples\ sound.amr c:\
copy C:\Ericsson-vasp-mm7\samples\ sound.wav c:\
Find a small gif file and rename it to "image.gif" and put it on c:\

In order to run the example code, the following code changes are required:

1. Remove code row:
   "Package com.ericsson.services.mms.sdk.vasp.samples.client;"             
2. Set http port to the Tomcat http port
   static final String mmcAddress = "http://localhost:8080/vasp/servlet/messagerouter";             
3. Compile the example code: testapp.java :
   Javac testapp.java             
4. Run the example code: testapp.java :
   java -classpath C:\apache-soap\lib\soap.jar;C:\Ericsson-vasp-mm7\lib\vasp.jar;%JWSDP_HOME%\jwsdp-shared\lib\mail.jar;%JWSDP_HOME%\jwsdp-shared\lib\activation.jar;%JWSDP_HOME%\saaj\lib\saaj-impl.jar;%JWSDP_HOME%\saaj\lib\saaj-api.jar;%JWSDP_HOME%\jaxp\lib\endorsed\dom.jar;%JWSDP_HOME%\jaxp\lib\endorsed\xercesImpl.jar;%JWSDP_HOME%\jaxp\lib\jaxp-api.jar;%JWSDP_HOME%\jaxp\lib\endorsed\sax.jar; testapp

Important note:
This MM7 SDK version has no support for sending messages from the MMC emulator to the VAS application (such as a delivery report message). This will be provided in a future release of the SDK.

If you want the application to terminate the following messages from the MMC, you need the example class VASPInterface.java together with the interface classes VASPReadReport, VASPDeliverReport, VASPDeliver from c:\Ericsson-vasp-mm7\samples\

In order to understand how to use these classes, you also need a good knowledge of the Apache SOAP messaging framework. The SDK documentation does not include a description of how to use this example code with Apache SOAP.

In order to test your code with these example classes, you need to implement you own MMC emulator.

Note: the file DeployVASPInterface.xml for deploy VASPInterface.java in Apache SOAP framework is located at c:\Ericsson-vasp-mm7\bin

Hints:
To test your application easily with a real MMC, you need to perform the following:

If MMC has defined your application with VAS ID to value 600, the same value must be written in the following method in your Java code.

MultiMediaApplication.setApplicationName("600");
MultiMediaMessage.setFrom("600")