JBoss.orgCommunity Documentation

Mobicents JAIN SLEE MAP Resource Adaptor User Guide


This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.

In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default.

Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows.

Mono-spaced Bold

Used to highlight system input, including shell commands, file names and paths. Also used to highlight key caps and key-combinations. For example:

The above includes a file name, a shell command and a key cap, all presented in Mono-spaced Bold and all distinguishable thanks to context.

Key-combinations can be distinguished from key caps by the hyphen connecting each part of a key-combination. For example:

The first sentence highlights the particular key cap to press. The second highlights two sets of three key caps, each set pressed simultaneously.

If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in Mono-spaced Bold. For example:

Proportional Bold

This denotes words or phrases encountered on a system, including application names; dialogue box text; labelled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:

The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in Proportional Bold and all distinguishable by context.

Note the > shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow 'Select Mouse from the Preferences sub-menu in the System menu of the main menu bar' approach.

Mono-spaced Bold Italic or Proportional Bold Italic

Whether Mono-spaced Bold or Proportional Bold, the addition of Italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example:

Note the words in bold italics above username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system.

Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example:

If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in the the Issue Tracker, against the product Mobicents JAIN SLEE MAP Resource Adaptor, or contact the authors.

When submitting a bug report, be sure to mention the manual's identifier: JAIN_SLEE_MAP_RA_User_Guide

If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.

MAP Resource Adaptor Type is defined by Mobicents team as part of effort to standardize RA Types.

The MAP Resource Adaptor SBB Interface provides SBBs with access to the MAP objects required for creating a new, aborting, ending a MAPdialog and sending USSD Request/Response. It is defined as follows:

package org.mobicents.protocols.ss7.map.api;

import org.mobicents.protocols.ss7.map.api.dialog.AddressString;
import org.mobicents.protocols.ss7.sccp.parameter.SccpAddress;

/**
 * 
 * @author amit bhayani
 * 
 */
public interface MAPProvider {

	public static final int NETWORK_UNSTRUCTURED_SS_CONTEXT_V2 = 1;

	/**
	 * Creates a new Dialog. This is equivalent to issuing MAP_OPEN Service
	 * Request to MAP Provider.
	 * 
	 * @param applicationCntx
	 *            This parameter identifies the type of application context
	 *            being established. If the dialogue is accepted the received
	 *            application context name shall be echoed. In case of refusal
	 *            of dialogue this parameter shall indicate the highest version
	 *            supported.
	 * 
	 * @param destAddress
	 *            A valid SCCP address identifying the destination peer entity.
	 *            As an implementation option, this parameter may also, in the
	 *            indication, be implicitly associated with the service access
	 *            point at which the primitive is issued.
	 * 
	 * @param destReference
	 *            This parameter is a reference which refines the identification
	 *            of the called process. It may be identical to Destination
	 *            address but its value is to be carried at MAP level.
	 * 
	 * @param origAddress
	 *            A valid SCCP address identifying the requestor of a MAP
	 *            dialogue. As an implementation option, this parameter may
	 *            also, in the request, be implicitly associated with the
	 *            service access point at which the primitive is issued.
	 * 
	 * @param origReference
	 *            This parameter is a reference which refines the identification
	 *            of the calling process. It may be identical to the Originating
	 *            address but its value is to be carried at MAP level.
	 *            Processing of the Originating-reference shall be performed
	 *            according to the supplementary service descriptions and other
	 *            service descriptions, e.g. operator determined barring.
	 * @return
	 */
	public MAPDialog createNewDialog(MAPApplicationContext appCntx,			
			SccpAddress origAddress, AddressString origReference,
			SccpAddress destAddress, AddressString destReference ) throws MAPException;

	/**
	 * 
	 * @param mapDialogListener
	 */
	public void addMAPDialogListener(MAPDialogListener mapDialogListener);

	/**
	 * 
	 * @param mapDialogListener
	 */
	public void removeMAPDialogListener(MAPDialogListener mapDialogListener);

	/**
	 * 
	 * @param mapServiceListener
	 */
	public void addMAPServiceListener(MAPServiceListener mapServiceListener);

	/**
	 * 
	 * @param mapServiceListener
	 */
	public void removeMAPServiceListener(MAPServiceListener mapServiceListener);

	public MapServiceFactory getMapServiceFactory();
	
	public MAPDialog getMAPDialog(Long dialogId);

}
	
	

The following code shows complete flow of application receiving the MAP Dialog request and then USSD Request. Application sends back Unstructured SS Response and finally on receiving Unstructured SS Request, application closes the MAPDialog

public abstract class SipSbb implements Sbb {

	private SbbContext sbbContext;


	private MAPContextInterfaceFactory mapAcif;
	private MAPProvider mapProvider;
	private MapServiceFactory mapServiceFactory;
	
	private static byte ussdDataCodingScheme = 0x0F;


	private Tracer logger;

	/** Creates a new instance of CallSbb */
	public SipSbb() {
	}

	/**
	 * MAP USSD Event Handlers
	 */

	public void onProcessUnstructuredSSRequest(
			ProcessUnstructuredSSIndication evt, ActivityContextInterface aci) {

		try {

			long invokeId = evt.getInvokeId();
			this.setInvokeId(invokeId);

			String ussdString = evt.getUSSDString().getString();
			this.setUssdString(ussdString);

			int codingScheme = evt.getUSSDDataCodingScheme() & 0xFF;
			String msisdn = evt.getMSISDNAddressString().getAddress();

			if (this.logger.isFineEnabled()) {
				this.logger
						.fine("Received PROCESS_UNSTRUCTURED_
						SS_REQUEST_INDICATION for MAP Dialog Id "
								+ evt.getMAPDialog().getDialogId()+ 
								" ussdString = "+ussdString);
			}
			
			USSDString ussdStringObj = this.mapServiceFactory
				.createUSSDString("1. Movies 2. Songs 3. End");
			
			evt.getMAPDialog().addUnstructuredSSResponse(invokeId, false,
					ussdDataCodingScheme, ussdStringObj);
			
			evt.getMAPDialog().send();


		} catch (Exception e) {
			logger.severe("Error while sending MAP USSD message", e);
		}

	}

	public void onUnstructuredSSRequest(UnstructuredSSIndication evt,
			ActivityContextInterface aci) {

		if (this.logger.isFineEnabled()) {
			this.logger
					.fine("Received UNSTRUCTURED_SS_REQUEST_INDICATION for MAP Dialog Id "
							+ evt.getMAPDialog().getDialogId());
		}
		
		try{

		MAPDialog mapDialog = evt.getMAPDialog();
		USSDString ussdStrObj = evt.getUSSDString();
		
		long invokeId = evt.getInvokeId();
		
		
		USSDString ussdStringObj = this.mapServiceFactory.createUSSDString("Thank you");
		
		evt.getMAPDialog().addUnstructuredSSResponse(invokeId, false,
				ussdDataCodingScheme, ussdStringObj);
		
		//End MAPDialog
		evt.getMAPDialog().close(false);
		
		}catch(Exception e){
			logger.severe("Error while sending MAP USSD ", e);
		}
	}

	/**
	 * MAP Dialog Event Handlers
	 */

	public void onCloseInfo(MAPCloseInfo evt, ActivityContextInterface aci) {
		if (this.logger.isFineEnabled()) {
			this.logger.fine("Received MAP CLOSE_INFO event for MAP Dialog Id "
					+ evt.getMAPDialog().getDialogId());
		}

	}

	public void onRefuseInfo(MAPRefuseInfo evt, ActivityContextInterface aci) {
		if (this.logger.isFineEnabled()) {
			this.logger
					.fine("Received MAP REFUSE_INFO event for MAP Dialog Id "
							+ evt.getMAPDialog().getDialogId());
		}
		
		
	}

	public void onUserAbortInfo(MAPUserAbortInfo evt,
			ActivityContextInterface aci) {
		if (this.logger.isFineEnabled()) {
			this.logger
					.fine("Received MAP USER_ABORT_INFO event for MAP Dialog Id "
							+ evt.getMAPDialog().getDialogId());
		}
		
		
	}

	public void onProviderAbortInfo(MAPProviderAbortInfo evt,
			ActivityContextInterface aci) {
		
		
	}



	public void setSbbContext(SbbContext sbbContext) {
		this.sbbContext = sbbContext;
		this.logger = sbbContext.getTracer("USSD-SIP");

		try {
			Context ctx = (Context) new InitialContext()
					.lookup("java:comp/env");

			

			mapAcif = (MAPContextInterfaceFactory) ctx
					.lookup("slee/resources/map/2.0/acifactory");

			mapProvider = (MAPProvider) ctx
					.lookup("slee/resources/map/2.0/provider");

			this.mapServiceFactory = this.mapProvider.getMapServiceFactory();

			
		} catch (Exception ne) {
			logger.severe("Could not set SBB context:", ne);
		}
	}

	public void unsetSbbContext() {
		this.sbbContext = null;
		this.logger = null;
	}

	public void sbbCreate() throws CreateException {
	}

	public void sbbPostCreate() throws CreateException {
	}

	public void sbbActivate() {
	}

	public void sbbPassivate() {
	}

	public void sbbLoad() {
	}

	public void sbbStore() {
	}

	public void sbbRemove() {
	}

	public void sbbExceptionThrown(Exception exception, Object object,
			ActivityContextInterface activityContextInterface) {
	}

	public void sbbRolledBack(RolledBackContext rolledBackContext) {
	}
}
		
		

The RA implementation uses the Mobicents MAP stack. The stack is the result of the work done by Mobicents Media Server development teams, and source code is provided in all releases.

There is a single Resource Adaptor Entity created when deploying the Resource Adaptor, named MAPRA. The MAPRA entity uses the default Resource Adaptor configuration, specified in Section 3.1, “Configuration”.

The MAPRA entity is also bound to Resource Adaptor Link Name MAPRA, to use it in an Sbb add the following XML to its descriptor:




        <resource-adaptor-type-binding>
            <resource-adaptor-type-ref>
                <resource-adaptor-type-name>
                    MAPResourceAdaptorType
                </resource-adaptor-type-name>
                <resource-adaptor-type-vendor>
                    org.mobicents
                </resource-adaptor-type-vendor>
                <resource-adaptor-type-version>
                    2.0
                </resource-adaptor-type-version>
            </resource-adaptor-type-ref>
            <activity-context-interface-factory-name>
                slee/resources/map/2.0/acifactory
            </activity-context-interface-factory-name>
            <resource-adaptor-entity-binding>
                <resource-adaptor-object-name>
                    slee/resources/map/2.0/provider
                </resource-adaptor-object-name>
                <resource-adaptor-entity-link>
                    MAPRA
                </resource-adaptor-entity-link>
            </resource-adaptor-entity-binding>
        </resource-adaptor-type-binding>


    

  1. Downloading the source code

    Use SVN to checkout a specific release source, the base URL is http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/MAP, then add the specific release version, lets consider 1.0.0.BETA7.

    [usr]$ svn co http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/MAP/1.0.0.BETA7 slee-ra-MAP-1.0.0.BETA7
  2. Building the source code

    Important

    Maven 2.0.9 (or higher) is used to build the release. Instructions for using Maven2, including install, can be found at http://maven.apache.org

    Use Maven to build the deployable unit binary.

    [usr]$ cd slee-ra-MAP-1.0.0.BETA7
    [usr]$ mvn install
    				    

    Once the process finishes you should have the deployable-unit jar file in the target directory, if Mobicents JAIN SLEE is installed and environment variable JBOSS_HOME is pointing to its underlying JBoss Application Server directory, then the deployable unit jar will also be deployed in the container.

Similar process as for Section 4.2.1, “Release Source Code Building”, the only change is the SVN source code URL, which is http://mobicents.googlecode.com/svn/trunk/servers/jain-slee/resources/MAP.

Revision History
Revision 1.0Tue Dec 30 2009Amit Bhayani
Creation of the Mobicents JAIN SLEE MAP RA User Guide.