JBoss.orgCommunity Documentation

Mobicents JAIN SLEE SMPP5 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 SMPP5 Resource Adaptor, or contact the authors.

When submitting a bug report, be sure to mention the manual's identifier: JAIN_SLEE_SMPP5_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.

This resource adaptor provides a SMPP API for JAIN SLEE applications, adapting the SMPP specification version 5.0.

The Short Message Peer to Peer (SMPP) protocol is an open, industry standard protocol designed to provide a flexible data communications interface for transfer of short message data between a Message Center, such as a Short Message Service Centre (SMSC), GSM Unstructured Supplementary Services Data (USSD) Server or other type of Message Center and a SMS application system, such as a WAP Proxy Server, EMail Gateway or other Messaging Gateway.

Using the SMPP protocol, an SMS application system called the External Short Message Entity (ESME) may initiate an application layer connection with an SMSC over a TCP/IP network connection and may then send short messages and receive short messages to and from the SMSC respectively. The ESME may also query, cancel or replace short messages using SMPP.

Events represent SMPP messages, or failure use cases such as timeouts.

The Activities are the SMPP Transaction, which applications in the SLEE may use to send SMPP message's and message responses, and to receive the events related with incoming message or message response.

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

Events represent SMPP message or response to message and Timer expiry. Each SMPP message and response is fired as different event types. Events are fired on SmppTransaction activity. Following is the table that describes event-type (name, vendor and version), event-class.

Table 2.1.  Events fired by SMPP5

NameEvent ClassComments
ALERT_ NOTIFICATIONAlertNotification This message is sent by the SMSC to the ESME, when the SMSC has detected that a particular mobile subscriber has become available and a delivery pending flag had been set for that subscriber from a previous data_sm operation.
GENERIC_NACKGenericNack This is a generic negative acknowledgement to an SMPP PDU submitted with an invalid message header.
DELIVER_SMDeliverSM The deliver_sm is issued by the SMSC to send a message to an ESME. Using this command, the SMSC may route a short message to the ESME for delivery.
DELIVERY_REPORTDeliverSM SMSC Delivery Receipt. A delivery receipt relating to a a message which had been previously submitted with the submit_sm operation and the ESME had requested a delivery receipt via the registered_delivery parameter. The delivery receipt data relating to the original short message will be included in the short_message field of the deliver_sm.
DELIVER_SM _RESPDeliverSMResp The SMPP PDU response sent from an ESME that received DELIVER_SM message
SUBMIT_SMSubmitSM This operation is used by an ESME to submit a short message to the SMSC for onward transmission to a specified short message entity (SME).
SUBMIT_SM _RESPSubmitSMResp This is the response to the submit_sm PDU
DATA_SMDataSM This command is used to transfer data between the SMSC and the ESME. It may be used by both the ESME and SMSC. This command is an alternative to the submit_sm and deliver_sm commands. It is introduced as a new command to be used by interactive applications such as those provided via a WAP framework.
DATA_SM _RESPDataSMResp This is the response to the data_sm PDU
SUBMIT_MULTISubmitMulti The submit_multi operation may be used to submit an SMPP message for delivery to multiple recipients or to one or more Distribution Lists
SUBMIT_MULTI _RESPSubmitMultiResp This is the response to the submit_multi PDU
QUERY_SMQuerySM This command is issued by the ESME to query the status of a previously submitted short message.
QUERY_SM _RESPQuerySMResp This is the response to the query_sm PDU
CANCEL_SMCancelSM This command is issued by the ESME to cancel one or more previously submitted short messages that are still pending delivery.
CANCEL_SM _RESPCancelSMResp This is the response to the cancel_sm PDU
REPLACE_SMReplaceSM This command is issued by the ESME to replace a previously submitted short message that is still pending delivery.
REPLACE_SM _RESPReplaceSMResp This is the response to the replace_sm PDU
BROADCAST_SMBroadcastSM This operation is issued by the ESME to submit a message to the Message Centre for broadcast to a specified geographical area or set of geographical areas.
BROADCAST_ SM_RESPBroadcastSMResp This is the response to the broadcast_sm PDU
QUERY_BROAD CAST_SMQueryBroadcastSM This command is issued by the ESME to query the status of a previously submitted broadcast message
QUERY_BROADCAST _SM_RESPQueryBroadcastSMResp This is the response to the query_broadcast_sm PDU
CANCEL_BROAD CAST_SMCancelBroadcastSM This command is issued by the ESME to cancel a broadcast message which has been previously submitted to the Message Centre for broadcast via broadcast_sm and which is still pending delivery.
CANCEL_BROAD CAST_SM_RESPCancelBroadcastSMResp This is the response to the cancel_broadcast_sm PDU
SMPP_TIMEOUT_ RESPONSE_SENTSmppError This is issued when ESME receives SMPP PDU and doesn't send the corresponding response in configured time limit
SMPP_TIMEOUT_ RESPONSE_RECEIVEDSmppError This is issued when ESME has sent SMPP PDU but there is no corresponding response from SMSC in configured time limit

The RA implementation uses the SMPP Impl from smppapi poject.

The Resource Adaptor supports configuration only at Resource Adaptor Entity creation time, the following table enumerates the configuration properties:

Table 3.1. Resource Adaptor's Configuration Properties

Property NameDescriptionProperty TypeDefault Value
host The host address of SMSC that this RA Entity should connect to java.lang.Stringlocalhost
port The Port of SMSC that this RA Entity should connect to java.lang.Integer2775
systemId The System ID field for bind request. Used by the SMSC for authentication. java.lang.Stringsmppclient1
systemType Identifies the type of ESME system requesting to bind as a receiver/transmitter/transciever with the SMSC. java.lang.StringESME
password Password field for bind request. Used by the SMSC for authentication. java.lang.Stringpassword
addressTon The type of Address for this ESME, used in BIND request java.lang.Integer1
addressNpi The Number Plan Indicator for this ESME, used in BIND request java.lang.Integer0
addressRange A single ESME address or a range of ESME addresses served via this SMPP receiver/transciever/transmitter session. The parameter value is represented in UNIX regular expression format (see Appendix A) of SMPP Spec 3.4. Set to NULL if not known. java.lang.Integer50
enquireLinkTimeout Interval (in seconds) between the RA entity sending enquire_link requests to test the SMPP session is still live. java.lang.Integer30
smppResponseReceivedTimeout Maximum time (in ms) to wait for a response to an outgoing SMPP request. If this timer fires, a SmppErrorEvent is sent to the application, containing the SMPP request PDU that failed. java.lang.Integer5000
smppResponseSentTimeout Maximum time (in ms) to wait for the application (SBB) to respond to an incoming SMPP request. If this timer fires, a generic_nack PDU is sent to the other node, with status ESME_RSYSERR, and the activity is ended. java.lang.Integer5000

Important

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!

There is a single Resource Adaptor Entity created when deploying the Resource Adaptor, named SmppRA. The SmppRA entity uses the default Resource Adaptor configuration, specified in Section 3.1, “Configuration”. The SmppRA entity is also bound to Resource Adaptor Link Name SmppRA, 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>SMPPResourceAdaptorType</resource-adaptor-type-name>
                <resource-adaptor-type-vendor>net.java</resource-adaptor-type-vendor>
                <resource-adaptor-type-version>5.0</resource-adaptor-type-version>
            </resource-adaptor-type-ref>
            <activity-context-interface-factory-name>slee/resources/smpp/5.0/factoryprovider</activity-context-interface-factory-name>
            <resource-adaptor-entity-binding>
                <resource-adaptor-object-name>slee/resources/smpp/5.0/smppinterface</resource-adaptor-object-name>
                <resource-adaptor-entity-link>SmppRA</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/smpp5, then add the specific release version, lets consider 1.1.1.FINAL.

    [usr]$ svn co http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/resources/smpp5/1.1.1.FINAL slee-ra-smpp5-1.1.1.FINAL
  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-smpp5-1.1.1.FINAL
    [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/smpp5.

Revision History
Revision 1.0Wed Sep 22 2010Amit Bhayani
Creation of the Mobicents JAIN SLEE SMPP5 RA User Guide.