Preface

Document Conventions

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.

Typographic Conventions

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:

To see the contents of the file my_next_bestselling_novel in your current working directory, enter the cat my_next_bestselling_novel command at the shell prompt and press Enter to execute the command.

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:

Press Enter to execute the command.

Press to switch to the first virtual terminal. Press to return to your X-Windows session.

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:

File-related classes include filesystem for file systems, file for files, and dir for directories. Each class has its own associated set of permissions.

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:

Choose System > Preferences > Mouse from the main menu bar to launch Mouse Preferences. In the Buttons tab, click the Left-handed mouse check box and click Close to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand).

To insert a special character into a gedit file, choose Applications > Accessories > Character Map from the main menu bar. Next, choose Search > Find from the Character Map menu bar, type the name of the character in the Search field and click Next. The character you sought will be highlighted in the Character Table. Double-click this highlighted character to place it in the Text to copy field and then click the Copy button. Now switch back to your document and choose Edit > Paste from the gedit menu bar.

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 menu:>[] shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow 'Select from the Preferences ▸ ] sub-menu in the menu: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:

To connect to a remote machine using ssh, type ssh username@domain.name at a shell prompt. If the remote machine is example.com and your username on that machine is john, type ssh john@example.com.

The mount -o remount file-system command remounts the named file system. For example, to remount the /home file system, the command is mount -o remount /home.

To see the version of a currently installed package, use the rpm -q package command. It will return a result as follows: package-version-release.

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:

When the Apache HTTP Server accepts requests, it dispatches child processes or threads to handle them. This group of child processes or threads is known as a server-pool. Under Apache HTTP Server 2.0, the responsibility for creating and maintaining these server-pools has been abstracted to a group of modules called Multi-Processing Modules (MPMs). Unlike other modules, only one module from the MPM group can be loaded by the Apache HTTP Server.

Pull-quote Conventions

Two, commonly multi-line, data types are set off visually from the surrounding text.

Output sent to a terminal is set in Mono-spaced Roman and presented thus:

books        Desktop   documentation  drafts  mss    photos   stuff  svn
books_tests  Desktop1  downloads      images  notes  scripts  svgs

Source-code listings are also set in Mono-spaced Roman but are presented and highlighted as follows:

package org.jboss.book.jca.ex1;

import javax.naming.InitialContext;

public class ExClient
{
   public static void main(String args[])
       throws Exception
   {
      InitialContext iniCtx = new InitialContext();
      Object         ref    = iniCtx.lookup("EchoBean");
      EchoHome       home   = (EchoHome) ref;
      Echo           echo   = home.create();

      System.out.println("Created Echo");

      System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
   }

}

Notes and Warnings

Finally, we use three visual styles to draw attention to information that might otherwise be overlooked.

Note

A note is a tip or shortcut or alternative approach to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a trick that makes your life easier.

Important

Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring Important boxes won’t cause data loss but may cause irritation and frustration.

Warning

A Warning should not be ignored. Ignoring warnings will most likely cause data loss.

Provide feedback to the authors!

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 {this-issue.tracker.ur}, against the product Restcomm jSS7` `, or contact the authors.

When submitting a bug report, be sure to mention the manual’s identifier: Restcomm jSS7

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.

1. Introduction to Restcomm JAIN SLEE MAP Resource Adaptor

Mobile application part (MAP) is the protocol that is used to allow the GSM network nodes within the Network Switching Subsystem to communicate with each other to provide services, such as roaming capability, text messaging (SMS), Unstructured Supplementary Service Data (USSD) and subscriber authentication. MAP provides an application layer on which to build the services that support a GSM network. This application layer provides a standardized set of operations. MAP is transported and encapsulated with the SS7 protocols MTP, SCCP, and TCAP.

For further details please look at specs link:http://www.3gpp.org/ftp/Specs/html-info/29002.htm

This resource adaptor provides a MAP API for JAIN SLEE applications, adapting the MAP specification for USSD.

2. Resource Adaptor Type

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

2.1. Activities

An MAP activity object represents a set of related events in an MAP resource. This RA Type defines only one activity object:

MAPDialog

All the events related to MAP Dialog and events related to Service are fired on this activity. This activity ends implicitly when MAP stack sends P-Abort or explicitly when user aborts the Dialog or end’s the Dialog. Class name is org.mobicents.protocols.ss7.map.api.MAPDialog New MAPDialog activity objects are created via specific MAP Service interface. Check Resource Adaptor Interface section for available services. Depending on service used, activity object provides additional set of methods. For instance USSD dialog: org.mobicents.protocols.ss7.map.api.service.supplementary.MAPDialogSupplementary exposes methods specific for exchange of USSD messages.

2.2. Events

Events represent’s MAP’s common services as well as services related to USSD Events are fired on MAPDialog. Below sections detail different type of events, depending on cause of it beeing fired into SLEE.

2.2.1. Component

Below events are fired into SLEE when something happens with components passed in MAP messages.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.

Event Class

org.mobicents.slee.resource.map.events

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 1. Component events
Name Event Class Comments

INVOKE_TIMEOUT

InvokeTimeout

Fired when localy initiated Invoke does not receive any answer for extended period of time.

ERROR_COMPONENT

ErrorComponent

Fired when remote peer indicates abnormal component. It indicates some protocol error in component sent from local peer.

REJECT_COMPONENT

RejectComponent

Fired when remote end rejects component for some reason.

2.2.2. Dialog

Dialog events are fired into SLEE to indicate basic occurrence of dialog related data.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.

Event Class

org.mobicents.slee.resource.map.events

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 2. Dialog events
Name Event Class Comments

DIALOG_DELIMITER

DialogDelimiter

Indicates end of MAP commands that triggered other events to be fired.

DIALOG_REQUEST

DialogRequest

Generic event representing ANY map request. This event is fired for ALL incoming requests.

DIALOG_ACCEPT

DialogAccept

Indicates that remote peer acknowledged dialog. This event is fired prior to any other event in such case.

DIALOG_REJECT

DialogReject

Opposite to DIALOG_ACCEPT. Indicates that remote peer rejected dialog for some reason. This event is fired prior to one indicating reason.

DIALOG_USERABORT

DialogUserAbort

Fired when remote MAP user aborts dialog.

DIALOG_PROVIDERABORT

DialogProviderAbort

Fired when when dialog is aborted due to transport level error.

DIALOG_CLOSE

DialogClose

Fired when dialog is closed via TCAP-END primitive.

DIALOG_NOTICE

DialogNotice

Fired when abnormal message is received within dialog. For instance when when duplicated InvokeID or wrong operation is received(for running MAP service).

DIALOG_TIMEOUT

DialogTimeout

Fired when dialog is about to timeout. Depending on configuration RA may sustain dialog or let it timeout. This event is fired when there is no activity on dialog for extended period of time.

DIALOG_RELEASE

DialogRelease

Fired when Dialog and all the resources related to dialog are released. This is last event on this activity after which activity will end.

2.2.3. Mobility - Location Management Service

Below events are fired when dialog receives callbacks for mobility location management service.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.service.mobility.locationManagement.

Event Class

org.mobicents.protocols.ss7.map.api.service.mobility.locationManagement.

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 3. Mobility - Location Management Service events
Name Event Class Comments

UPDATE_LOCATION_ REQUEST

UpdateLocationRequest

This service is used by the VLR to update the location information stored in the HLR.

UPDATE_LOCATION_ RESPONSE

UpdateLocationResponse

Response to UpdateLocationRequest

CANCEL_LOCATION_ REQUEST

CancelLocationRequest

This service is used between HLR and VLR to delete a subscriber record from the VLR.

CANCEL_LOCATION_ RESPONSE

CancelLocationResponse

Response to CancelLocationRequest

2.2.4. Mobility - Authentication Management Service

Below events are fired when dialog receives callbacks for mobility authentication management service.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.service.mobility.authentication.

Event Class

org.mobicents.protocols.ss7.map.api.service.mobility.authentication.

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 4. Mobility - Authentication Management Service events
Name Event Class Comments

SEND_AUTHENTICATION_ INFO_REQUEST

SendAuthentication InfoRequest

This service is used between the VLR and the HLR for the VLR to retrieve authentication information from the HLR

SEND_AUTHENTICATION_ INFO_RESPONSE

SendAuthentication InfoResponse

Response to SendAuthenticationInfoRequest

2.2.5. Mobility - IMEI Management Service

Below events are fired when dialog receives callbacks for mobility IMEI management service.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.service.mobility.imei.

Event Class

org.mobicents.protocols.ss7.map.api.service.mobility.imei.

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 5. Mobility - Authentication Management Service events
Name Event Class Comments

CHECK_IMEI_REQUEST

CheckImeiRequest

This service is used between the VLR and the MSC and between the MSC and the EIR and between the SGSN and EIR to request check of IMEI. If the IMEI is not available in the MSC or in the SGSN, it is requested from the MS and transferred to the EIR in the service request.

CHECK_IMEI_RESPONSE

CheckImeiResponse

Response to CheckImeiRequest

2.2.6. Mobility - Subscriber Management Service

Below events are fired when dialog receives callbacks for mobility subscriber management service.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.service.mobility.subscribermanagement.

Event Class

org.mobicents.protocols.ss7.map.api.service.mobility.subscriberManagement.

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 6. Mobility - Authentication Management Service events
Name Event Class Comments

INSERT_SUBSCRIBER_ DATA_REQUEST

InsertSubscriber DataRequest

This service is used by an HLR to update a VLR with certain subscriber data

INSERT_SUBSCRIBER_ DATA_RESPONSE

InsertSubscriber DataResponse

Response to InsertSubscriberDataRequest

2.2.7. Mobility - Subscriber Information Service

Below events are fired when dialog receives callbacks for mobility subscriber information service.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.service.mobility.subscriberinfo.

Event Class

org.mobicents.protocols.ss7.map.api.service.mobility.subscriberInformation.

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 7. Mobility - Authentication Management Service events
Name Event Class Comments

ANY_TIME_ INTERROGATION_REQUEST

AnyTimeInterrogation Request

This service is used by the gsmSCF, to request information (e.g. subscriber state and location) from the HLR or the GMLC at any time. This service may also be used by the gsmSCF to request the Mobile Number Portability (MNP) information from the NPLR. This service is also used by the Presence Network Agent to request information, (e.g. subscriber state and location) about the subscriber (associated with a presentity) from the HLR at any time (see 3GPP TS 23.141 [128]).

ANY_TIME_ INTERROGATION_RESPONSE

AnyTimeInterrogation Response

Response to AnyTimeInterrogationRequest

2.2.8. Call Handling Service

Below events are fired when dialog receives callbacks for call handling service.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.service.callhandling.

Event Class

org.mobicents.protocols.ss7.map.api.service.callhandling.

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 8. Mobility - Authentication Management Service events
Name Event Class Comments

SEND_ROUTING_ INFORMATION_REQUEST

SendRoutingInformation Request

This service is used between the Gateway MSC and the HLR. The service is invoked by the Gateway MSC to perform the interrogation of the HLR in order to route a call towards the called MS

SEND_ROUTING_ INFORMATION_RESPONSE

SendRoutingInformation Response

Response to SendRoutingInformationRequest

PROVIDE_ROAMING_ NUMBER_REQUEST

ProvideRoamingNumber Request

This service is used between the HLR and VLR. The service is invoked by the HLR to request a VLR to send back a roaming number to enable the HLR to instruct the GMSC to route an incoming call to the called MS.

PROVIDE_ROAMING_ NUMBER_RESPONSE

ProvideRoamingNumber Response

Response to ProvideRoamingNumberRequest

2.2.9. Suplementary service

Below events are fired when dialog receives callbacks for suplementary service.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.service.suplementary.

Event Class

org.mobicents.protocols.ss7.map.api.service.supplementary.

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 9. Suplementary service events
Name Event Class Comments

UNSTRUCTURED_ SS_REQUEST

ProcessUnstructuredSS Request

Indicates either initial or subsequent USSD message(all non final messages exchanged are of this type). Its exchanged between user device and USSD application.

UNSTRUCTURED_ SS_RESPONSE

ProcessUnstructuredSS Response

Final message exchanged in USSD dialog.

PROCESS_ UNSTRUCTURED_ SS_REQUEST

ProcessUnstructuredSS Request

As UNSTRUCTURED _SS_REQUEST, however this message is exchanged between SS7 equipment/nodes, like HLR and VLR

PROCESS_ UNSTRUCTURED_ SS_RESPONSE

ProcessUnstructuredSS Response

This event is equivalent of UNSTRUCTURED _SS_RESPONSE.

UNSTRUCTURED_SS_ NOTIFY_REQUEST

UnstructuredSSNotify Request

This event represents will of entity to notify user device.

UNSTRUCTURED_SS_ NOTIFY_RESPONSE

UnstructuredSSNotify Response

This is response to Notify Request sent from application/nework to device.

2.2.10. Local service management

Below events are fired when dialog receives callbacks for local service management.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.service.lsm.

Event Class

org.mobicents.protocols.ss7.map.api.service.lsm.

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 10. Local service management events
Name Event Class Comments

PROVIDE_SUBSCRIBER_ LOCATION_REQUEST

ProvideSubscriberLocation Request

This event indicates that GLMC requests location of user device(subscriber).

PROVIDE_SUBSCRIBER_ LOCATION_RESPONSE

ProvideSubscriberLocation Response

SEND_ROUTING_INFO_ FOR_LCS_REQUEST

SendRoutingInfoForLCS Request

This event indicates that SS7 entity requests routing information from HLR. Provided information is used to route SMS

SEND_ROUTING_INFO_ FOR_LCS_RESPONSE

SendRoutingInfoForLCS Response

SUBSCRIBER_LOCATION_ REPORT_REQUEST

SubscriberLocationReport Request

This event indicates change in location of user device. It provides SS7 equipment with update on subscriber location.

SUBSCRIBER_LOCATION_ REPORT_RESPONSE

SubscriberLocationReport Response

2.2.11. Short message service

Below events are fired when dialog receives callbacks for short message service.

For proper render of this table prefixes, for entries on some columns are omitted. For prefix values, for each column, please see list below:

Name

ss7.map.service.sms.

Event Class

org.mobicents.protocols.ss7.map.api.service.sms.

Version for all defined events is 1.0

Vendor for all defined events is org.mobicents

Spaces where introduced in Name column values, to correctly render the table. Please remove them when using copy/paste.

Table 11. Short message service events
Name Event Class Comments

FORWARD_SHORT_ MESSAGE_REQUEST

ForwardShortMessage Request

This event indicates that SMS must be forwarded to another SS7 node. This is MAP Phase 1 event, hence no distinction between MO and MT.

FORWARD_SHORT_ MESSAGE_RESPONSE

ForwardShortMessage Response

MO_FORWARD_SHORT_ MESSAGE_REQUEST

MoForwardShortMessage Request

This event indicates that mobile originated SMS must be forwarded to another SS7 node.

MO_FORWARD_SHORT_ MESSAGE_RESPONSE

MoForwardShortMessage Response

MT_FORWARD_SHORT_ MESSAGE_REQUEST

MtForwardShortMessage Request

This event indicates that mobile terminated SMS must be forwarded to another SS7 node.

MT_FORWARD_SHORT_ MESSAGE_RESPONSE

MtForwardShortMessage Response

SEND_ROUTING_INFO_ FOR_SM_REQUEST

SendRoutingInfoForSM Request

This event indicates that HLR is being queried for routing inforamtion.

SEND_ROUTING_INFO_ FOR_SM_RESPONSE

SendRoutingInfoForSM Response

REPORT_SM_DELIVERY_ STATUS_REQUEST

ReportSMDeliveryStatus Request

This event is used to inform HLR about SMS delivery status.

REPORT_SM_DELIVERY_ STATUS_RESPONSE

ReportSMDeliveryStatus Response

INFORM_SERVICE_ CENTER_REQUEST

InformServiceCentre Request

This event is used by HLR to inform message center about subscriber status.

ALERT_SERVICE_ CENTER_REQUEST

AlertServiceCentre Request

This event is used by HLR to inform message center about change in subscirber status.

ALERT_SERVICE_ CENTER_RESPONSE

AlertServiceCentre Response

2.3. Activity Context Interface Factory

The interface of the MAP resource adaptor type specific Activity Context Interface Factory is defined as follows:

package org.mobicents.slee.resource.map;

import org.mobicents.protocols.ss7.map.api.MAPDialog;

import javax.slee.ActivityContextInterface;
import javax.slee.FactoryException;
import javax.slee.UnrecognizedActivityException;

public interface MAPContextInterfaceFactory {

	public ActivityContextInterface getActivityContextInterface(MAPDialog dialog) throws NullPointerException,
			UnrecognizedActivityException, FactoryException;

}

2.4. Resource Adaptor Interface

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;


public interface MAPProvider {

	 public abstract void addMAPDialogListener(MAPDialogListener mapdialoglistener);

    public abstract void removeMAPDialogListener(MAPDialogListener mapdialoglistener);

    public abstract MAPParameterFactory getMAPParameterFactory();

    public abstract MAPErrorMessageFactory getMAPErrorMessageFactory();

    public abstract MAPDialog getMAPDialog(Long long1);

	public MAPSmsTpduParameterFactory getMAPSmsTpduParameterFactory();

	public MAPServiceMobility getMAPServiceMobility();

	public MAPServiceCallHandling getMAPServiceCallHandling();

	public MAPServiceOam getMAPServiceOam();

	public MAPServicePdpContextActivation getMAPServicePdpContextActivation();

	public MAPServiceSupplementary getMAPServiceSupplementary();

	public MAPServiceSms getMAPServiceSms();

	public MAPServiceLsm getMAPServiceLsm();

}
public abstract void addMAPDialogListener(MAPDialogListener mapdialoglistener);

this method is not supported. Call to it causes NotSupportedException to be thrown.

public abstract void removeMAPDialogListener(MAPDialogListener mapdialoglistener);

this method is not supported. Call to it causes NotSupportedException to be thrown.

public abstract MAPParameterFactory getMAPParameterFactory();

retrieves factory for generic MAP components

public abstract MAPErrorMessageFactory getMAPErrorMessageFactory();

retrieves implementation of MAP error message factory. Error messages are used to indicate erroneous conditions.

public abstract MAPDialog getMAPDialog(Long dialogId);

retrieves active dialog by its ID.

public abstract MAPDialog getMAPSmsTpduParameterFactory();

retrieves factory for SMS transaction protocol data unit. This is useful for services that are based on SMS.

public abstract MAPServiceMobility getMAPServiceMobility();

retrieves MAP mobility service. It is used to create mobility dialogs.

public abstract MAPServiceCallHandling getMAPServiceCallHandling();

retrieves MAP call handling service. It is used to create call handling dialogs.

public abstract MAPServiceOam getMAPServiceOam();

retrieves MAP operations and managemenet service. It is used to create OAM dialogs.

NOTE: This service is not yet implemented
public abstract MAPServicePdpContextActivation getMAPServicePdpContextActivation()

retrieves MAP Network-Requested PDP Context Activation services.

NOTE: This service is not yet implemented
public abstract MAPServiceSupplementary getMAPServiceSupplementary();

retrieves MAP sumplementary service. It is used to create USSD dialogs.

public abstract MAPServiceSms getMAPServiceSms();

retrieves MAP SMS service. It is used to create SMS dialogs. In current release it is not supported.

public abstract MAPServiceLsm getMAPServiceLsm();

retrieves MAP LMS service. It is used to create LMS dialogs. In current release it is not supported.

As MAP stack is being completed, it will support more services, this list of getMAPServiceX will expand to support all implemented services.

2.5. Restrictions

The resource adaptor implementation should prevent SBBs from adding themselves as MAP listeners, or changing the MAP network configuration. Any attempt to do so should be rejected by throwing a SecurityException.

2.6. Sbb Code Examples

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 MAPParameterFactory mapParameterFactory;

	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);
		}
	}

	...


	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.mapParameterFactory = this.mapProvider.getMAPParameterFactory();


		} 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) {
	}
}

3. Resource Adaptor Implementation

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

3.1. Configuration

The Resource Adaptor supports configuration only at Resource Adaptor Entity creation time. It supports following properties:

Table 12. Resource Adaptor’s Configuration Properties - map-default-ra.properties
Property Name Description Property Type Default Value

mapJndi

JNDI name of MAP stack

java.lang.String

java:/mobicents/ss7/map

JAIN SLEE 1.1 Specification requires values set for properties without a default value, which means the configuration for those properties are mandatory, otherwise the Resource Adaptor Entity creation will fail!

3.2. Default Resource Adaptor Entities

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 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>

3.3. Traces and Alarms

3.3.1. Tracers

Each Resource Adaptor Entity uses a single JAIN SLEE 1.1 Tracer, named MAPResourceAdaptor. The related Log4j Logger category, which can be used to change the Tracer level from Log4j configuration, is javax.slee.RAEntityNotification[entity=MAPRA]

3.3.2. Alarms

No alarms are set by this Resource Adaptor.

4. Setup

4.1. Pre-Install Requirements and Prerequisites

Ensure that the following requirements have been met before continuing with the install.

4.1.1. Hardware Requirements

The Resource Adaptor hardware’s main concern is RAM memory and Java Heap size, the more the better.

Of course, memory is only needed to store the Resource Adaptor state, the faster the CPU more MAP Messages processing is supported, yet no particular CPU is a real requirement to use the RA.

4.1.2. Software Prerequisites

The RA requires Restcomm JAIN SLEE properly set.

4.2. Restcomm JAIN SLEE MAP Resource Adaptor Source Code

4.2.1. Release Source Code Building

  1. Downloading the source code

    Git is used to manage Restcomm JAIN SLEE source code. Instructions for downloading, installing and using Git can be found at http://git-scm.com/

    Use Git to checkout a specific release source, the Git repository URL is https://github.com/Restcomm/jain-slee.ss7, then switch to the specific release version, lets consider 8.0.0-SNAPSHOT.

    [usr]$ git clone https://github.com/Restcomm/jain-slee.ss7/
    [usr]$ cd jain-slee.ss7
    [usr]$ git checkout tags/{project-version}
  2. Building the source code

    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 resources/MAP
    [usr]$ mvn install

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

4.2.2. Development Master Source Building

Similar process as for Release Source Code Building, the only change is the Git reference should be the master. The git checkout tags/8.0.0-SNAPSHOT command should not be performed. If already performed, the following should be used in order to switch back to the master:

[usr]$ git checkout master

4.3. Installing Restcomm JAIN SLEE MAP Resource Adaptor

To install the Resource Adaptor simply execute provided ant script build.xml default target:

[usr]$ ant

The script will copy the RA deployable unit jar to the default Restcomm JAIN SLEE server profile deploy directory, to deploy to another server profile use the argument -Dnode=.

4.4. Uninstalling Restcomm JAIN SLEE MAP Resource Adaptor

To uninstall the Resource Adaptor simply execute provided ant script build.xml undeploy target:

[usr]$ ant undeploy

The script will delete the RA deployable unit jar from the default Restcomm JAIN SLEE server profile deploy directory, to undeploy from another server profile use the argument -Dnode=.

Appendix A: Revision History