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 smpp-extensions` `, or contact the authors.

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

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

Restcomm smpp-extensions is extensions to cloudhopper smpp stack with adding of management for ESMEs and ESME clusters with CLI and GUI access.

Restcomm smpp-extensions comes with JSLEE SMPP Resource Adaptors (RA) that enable developers to build SMPP applications with ease. Developers only require an understanding of Resource Adaptors and can focus on building applications quickly and efficiently rather than worry about the SMPP stack.

If you wish to use JSLEE Resource Adapters, the Command Line Interface (CLI - Shell Management tool) or the GUI for run-time configuration, then you must have JBoss Application Server installed and running. However if you do not wish to use the Resource Adaptors or CLI then Restcomm smpp-extensions can work as a standalone library. In this case you need to make your own implementation of classes that was implemented at SMPP RA level.

The Open Source Software gives you the flexibility to understand the readily available source code and customise the product for your Enterprise needs.

This guide will assist you in installing Restcomm smpp-extensions . For more details on configuring and using the platform or for information regarding the supported protocols and compliant standards, please refer to the Restcomm smpp-extensions User Guide.

2. Pre-Requisites

Restcomm smpp-extensions 's core requirement is Java. The following table details the Hardware, Operating System and Software requirements for a clean installation of Restcomm smpp-extensions .

Table 1. Installation Pre-Requisites
Component Requirement Notes

System Requirements

Intel Pentium 1 GHz or faster for simple applications. Hard disk space of at least 20MB. RAM of at least 1.5 GB

Higher the RAM and processing power, better is the throughput

Operating System

The platform can be installed on any OS that supports Java.

Java

You must have a working Java Runtime Environment (JRE) or Java Development Kit (JDK) installed on your system and it must be version 7 or higher.

For usage of JBOSS 5.1 you may use JAVA 7 only, For usage of WildFly 10.1 you may use JAVA 8 or higher

JBoss Application Server

Restcomm SMPP Extensions can work as a standalone library if you do not require JSLEE Resource Adaptors and the Shell Management Tool (Command Line Interface) for run-time configuration of the platform. But if you wish to avail of these, then you must have JBoss Application Server (version 5.1.0.GA) or WildFly server (version 10) installed on your machine.

Refer to the appendix section for more details.

You must ensure that the JAVA_HOME and JBOSS_HOME Environment variables are set properly for the user account(s) that will run the server. For more details on setting these variables, please refer to the sections Java Development Kit (): Installing, Configuring and Running and Setting the JBOSS_HOME Environment Variable.

3. Downloading

Installing Restcomm smpp-extensions is easy and quick with the binary download. You can either download the binary release or download the source code and set up from source.

3.1. Binary Download

The binary release is available for download at the following link: https://github.com/RestComm/smpp-extensions/releases/latest

Procedure: Binary Download
  1. Download the zip file restcomm-smpp-extensions-7.1.0-SNAPSHOT.zip to any folder of your choice.

  2. Extract the contents of the zip file.

    Downloads]$ unzip restcomm-smpp-extensions-7.1.0-SNAPSHOT.zip
  3. Verify the contents of the newly created directory.

When you download the binary release, you will notice that the top level directory is named restcomm-smpp-extensions-7.1.0-SNAPSHOT and immediately below this are several sub-directories named docs, oam, shell, jboss5, and wildfly encompassing the major services and libraries that make up Restcomm smpp-extensions . For details on what is included in the sub-directories, please refer to the Restcomm smpp-extensions User Guide.

The major functional modules of the smpp-extensions are:

  1. SMPP Service fo JBOSS server [dir: jboss5]

  2. SMPP Service fo WildFly server [dir: wildfly]

  3. Shell [dir: shell]

|- restcomm-smpp-extensions-7.1.0-SNAPSHOT
		|- _docs

		|- oam

		|- shell

		|- jboss5
				|+ restcomm-smpp-server

		|- wildfly
				|+ commons
				|+ restcomm-smpp-server
				|+ template

3.2. Setup from Source

Restcomm smpp-extensions is an open source project and you have the freedom to build from source. Building from source means you can stay on top with the latest features. Whilst aspects of Restcomm smpp-extensions are quite complicated, you may find ways to become contributors.

Restcomm smpp-extensions works with JDK1.7 or above. In addition you must have the following tools installed.

Pre-Requisites for Building from Source

3.2.1. Release Source Code Building

  1. Downloading the source code

    Checkout a specific release source using GIT. The base URL to clone from is https://github.com/Restcomm/smpp-extensions. Then add the specific release version, in the below example we are downloading the version 7.1.0-SNAPSHOT.

    [usr]$ git clone https://github.com/Restcomm/smpp-extensions smpp-extensions
    [usr]$ cd smpp-extensions
    [usr]$ git checkout 
  2. Building the source code

    Now that we have the source code, the next step is to build and install the source. Restcomm smpp-extensions uses Maven 3 to build the system.

There are two extra build profiles namely deploy-module-jboss5 and deploy-module-wildfly needed for deploying of built binaries into a local jboss ot WildFly server. Usage of such profiles demands of JBOSS_HOME environment variable is set properly. There is also a special all profile that allows to build a manual in a PDF form as addition to a web form.

  • Building using "default" Build profile

    To build Restcomm smpp-extensions without depoying and PDF manual use the default profile as shown below.

    [usr]$ cd smpp-extensions
    [usr]$ mvn install
  • Building using additional profiles. An example is for depoying to a WildFly server and compiling of a PDF manual.

    [usr]$ cd smpp-extensions
    [usr]$ mvn install -Pdeploy-module-wildfly -Pall
    1. Use Ant to build the binary.

      [usr]$ cd smpp-extensions/release
      [usr]$ ant

3.2.2. Development Trunk Source Building

To build from development trunk source, follow the same procedure as above but at the time of checkout do not switch to the specific release tag.

[usr]$ git clone https://github.com/Restcomm/smpp-extensions smpp-extensions
[usr]$ cd smpp-extensions
[usr]$ git checkout

The rest of the steps are as outlined in the above section Release Source Code Building

4. Installing Restcomm smpp-extensions

4.1. Installation Options

Restcomm smpp-extensions can be installed to function as a standalone component if you do not wish to use JBoss Application Server.

In this case you need to make your own implementation of classes that was implemented at SMPP RA level and this way is not recommneted. For this case you need to implement org.restcomm.smpp.SmppSessionHandlerInterface (it is implemented at SMPP RA), set it to SmppManagement before starting of SmppManagement stack.

However if you intend to use JSLEE Resource Adaptors or Shell (CLI) and GUI, then you must deploy it as a JBoss AS Service. The sections below provide instructions for installing the Stack for use with JBoss AS or as a standalone component.

4.1.1. Restcomm smpp-extensions as a JBoss AS Service

Restcomm smpp-extensions can be deployed in any container that supports JMX and exposes JNDI. By using the Restcomm smpp-extensions you will be able to configure the smpp-extensions using CLI (Command Line Interface) commands and WEB GUI interface.

Procedure: Installing Restcomm smpp-extensions to JBoss 5.1.0.GA
  1. Pre-Requisites:

  2. Deploying the smpp-extensions:

    • You can now deploy the service using the ant deploy command as shown below:

      [usr1]$ cd restcomm-smpp-extensions-7.1.0-SNAPSHOT/jboss5
      [usr1]$ ant deploy
  3. Result:

    • If the service has been deployed successfully, you will find the below message appear on screen:

      Buildfile: ../restcomm-smpp-extensions-7.1.0-SNAPSHOT/jboss5/build.xml
      
      deploy:
           [copy] Copying 13 files to JBOSS_HOME\server\default\deploy\restco
      mm-smpp-server
           [copy] Copying 2 files to JBOSS_HOME\bin
           [copy] Copying 6 files to JBOSS_HOME\lib
           [copy] Copying 2 files to JBOSS_HOME\server\default\deploy
      
      BUILD SUCCESSFUL
    • You have now deployed Restcomm smpp-extensions successfully. Note that this procedure will also install the Shell Components (shell scripts and libraries) on this machine.

Procedure: Installing Restcomm smpp-extensions to WildFly 10.1.0.Final
  1. Pre-Requisites:

  2. Deploying the smpp-extensions:

    • You can now deploy the service using the ant deploy command as shown below:

      [usr1]$ cd restcomm-smpp-extensions-7.1.0-SNAPSHOT/wildfly
      [usr1]$ ant deploy
  3. Result:

    • If the service has been deployed successfully, you will find the below message appear on screen:

      Buildfile: ../restcomm-smpp-extensions-7.1.0-SNAPSHOT/wildfly/build.xml
      
      deploy:
           [copy] Copying 8 files to JBOSS_HOME\modules\system\layers\base\org
      \restcomm\smpp\bootstrap
           [copy] Copying 2 files to JBOSS_HOME\bin
           [copy] Copying 6 files to JBOSS_HOME\lib
           [copy] Copying 2 files to JBOSS_HOME\standalone\deployments
           [copy] Copying 6 files to JBOSS_HOME\modules\system\layers\base\org
      \mobicents\ss7\commons
      
      BUILD SUCCESSFUL
    • You have now deployed Restcomm smpp-extensions successfully. Note that this procedure will also install the Shell Components (shell scripts and libraries) on this machine.

4.1.2. Shell - Command Line Interface (CLI)

Once you have installed Restcomm smpp-extensions , you can configure and manage it using Shell commands. Restcomm smpp-extensions comes with a Shell Management Interface that enables easy run-time configuration. You can install the Shell (CLI) Component on any machine (usually remote) and easily connect to and manage the Stack on a remote machine with simple commands. For more details on using the Shell and the commands available, please refer to the Restcomm smpp-extensions User Guide.

Installation of a CLI client part is the same procedure as installation of SMPP extensions into a JBOSS or WildFly server. We will not run the server itself but will run only a CLI client part.

4.2. Post Installation Configuration

Now that you have installed Restcomm smpp-extensions to suit your needs, you can go ahead and configure the Stack to meet your requirements. The User Guide (available along with this Installation Guide) in the Restcomm-smpp-extensions-7.1.0-SNAPSHOT/docs folder will assist you in configuring and managing the Stack. The Shell Management module will enable you to easily configure the Stack using the Command Line Interface (CLI) tool.

4.2.1. Memory Settings

You should fine tune the JVM memory settings based on your needs but we recommend you allocate a minimum of 3 GB for initial and maximum heap size.

-Xms3072m

Initial heap size, set in megabytes

-Xmx3072m

Maximum heap size, set in megabytes

5. Uninstalling

If you wish to remove Restcomm smpp-extensions you can do so by deleting the installation directory. If you installed it as a JBoss Service then you must remember to clean up the SS7 Service files within the JBoss directory by undeploying the service as shown below. The procedure below can be ignored if you installed the Stack as a standalone component.

Procedure: Uninstalling Restcomm smpp-extensions from JBoss 5.1.0.GA

Undeploy:

[usr1]$ cd restcomm-smpp-extensions-7.1.0-SNAPSHOT/jboss5
[usr1]$ ant undeploy

Result:

Buildfile: ../restcomm-smpp-extensions-7.1.0-SNAPSHOT/jboss5/build.xml

undeploy:
   [delete] Deleting directory JBOSS_HOME\server\default\deploy\restcom
m-smpp-server
   [delete] Deleting: JBOSS_HOME\server\default\deploy\smpp-management.
war
   [delete] Deleting: JBOSS_HOME\server\default\deploy\jolokia.war
   [delete] Deleting: JBOSS_HOME\bin\ss7-cli.sh
   [delete] Deleting: JBOSS_HOME\bin\ss7-cli.bat

BUILD SUCCESSFUL
Total time: 0 seconds
Procedure: Uninstalling Restcomm smpp-extensions from WildFly 10.1.0.Final

Undeploy:

[usr1]$ cd restcomm-smpp-extensions-7.1.0-SNAPSHOT/wildfly
[usr1]$ ant undeploy

Result:

Buildfile: ../restcomm-smpp-extensions-7.1.0-SNAPSHOT/wildfly/build.xml

undeploy:
   [delete] Deleting directory JBOSS_HOME\modules\system\layers\base\org
\restcomm\smpp\bootstrap
   [delete] Deleting: JBOSS_HOME\standalone\deployments\smpp-management.
war
   [delete] Deleting: JBOSS_HOME\standalone\deployments\jolokia.war
   [delete] Deleting: JBOSS_HOME\bin\ss7-cli.sh
   [delete] Deleting: JBOSS_HOME\bin\ss7-cli.bat
   [delete] Deleting JBOSS_HOME\lib\jansi-1.8.jar
   [delete] Deleting JBOSS_HOME\lib\javolution-5.5.1.jar
   [delete] Deleting JBOSS_HOME\lib\jreadline-0.17.jar
   [delete] Deleting JBOSS_HOME\lib\shell-transport-7.4.0-65.jar
   [delete] Deleting JBOSS_HOME\lib\shell-transport-8.0.0-SNAPSHOT.jar
   [delete] Deleting: JBOSS_HOME\lib\restcomm-ss7-shell.jar

BUILD SUCCESSFUL
Total time: 0 seconds

Appendix A: Java Development Kit (): Installing, Configuring and Running

The [app]` Platform` is written in Java; therefore, before running any server, you must have a working Java Runtime Environment () or Java Development Kit () installed on your system. In addition, the JRE or JDK you are using to run [app] must be version 7 (version 8 is not supported now, Oracle JDK 64-bit is recommended).

Should I Install the JRE or JDK?

Although you can run servers using the Java Runtime Environment, we assume that most users are developers interested in developing Java-based, [app]-driven solutions. Therefore, in this guide we take the tact of showing how to install the full Java Development Kit.

Should I Install the 32-Bit or the 64-Bit JDK, and Does It Matter?

Briefly stated: if you are running on a 64-Bit Linux or Windows platform, you should consider installing and running the 64-bit JDK over the 32-bit one. Here are some heuristics for determining whether you would rather run the 64-bit Java Virtual Machine (JVM) over its 32-bit cousin for your application:

  • Wider datapath: the pipe between RAM and CPU is doubled, which improves the performance of memory-bound applications when using a 64-bit JVM.

  • 64-bit memory addressing gives virtually unlimited (1 exabyte) heap allocation. However large heaps affect garbage collection.

  • Applications that run with more than 1.5 GB of RAM (including free space for garbage collection optimization) should utilize the 64-bit JVM.

  • Applications that run on a 32-bit JVM and do not require more than minimal heap sizes will gain nothing from a 64-bit JVM. Barring memory issues, 64-bit hardware with the same relative clock speed and architecture is not likely to run Java applications faster than their 32-bit cousin.

Note that the following instructions detail how to download and install the 32-bit JDK, although the steps are nearly identical for installing the 64-bit version.

Downloading

You can download the Oracle JDK 7 (Java Development Kit) from Oracle’s website: http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html. Click on the Download link next to "Java SE Development Kit <version>`" (where [replaceable]<version>` is the latest release number). On the next page, select your language and platform (both architecture - whether 32- or 64-bit - and operating system), read and agree to the Oracle Binary Code License Agreement for Java , and proceed to the download page.

The Oracle website will present two download alternatives to you: one is an RPM inside a self-extracting file (for example, jdk-<version>-linux-i586.rpm), and the other is merely a self-extracting file (e.g. jdk-<version>-linux-i586.tar.gz). If you are installing the JDK on Red Hat Enterprise Linux, Fedora, or another RPM-based Linux system, we suggest that you download the self-extracting file containing the RPM package, which will set up and use the SysV service scripts in addition to installing the JDK. We also suggest installing the self-extracting RPM file if you will be running smpp-extensions in a production environment.

Installing

The following procedures detail how to install the Java Development Kit on both Linux and Windows.

Procedure: Installing the JDK on Linux
  1. Regardless of which file you downloaded, you can install it on Linux by simply making sure the file is executable and then running it:

    ~]$ chmod +x "jdk-<version>-linux-<architecture>-rpm.bin"
    ~]$ ./"jdk-<version>-linux-<architecture>-rpm.bin"
You Installed Using the Non-RPM Installer, but Want the SysV Service Scripts

If you download the non-RPM self-extracting file (and installed it), and you are running on an RPM-based system, you can still set up the SysV service scripts by downloading and installing one of the -compat packages from the JPackage project. Remember to download the -compat package which corresponds correctly to the minor release number of the JDK you installed. The compat packages are available from link:ftp://jpackage.hmdc.harvard.edu/JPackage/1.7/generic/RPMS.non-free/.

You do not need to install a -compat package in addition to the JDK if you installed the self-extracting RPM file! The -compat package merely performs the same SysV service script set up that the RPM version of the JDK installer does.
Procedure: Installing the JDK on Windows
  1. Using Explorer, simply double-click the downloaded self-extracting installer and follow the instructions to install the JDK.

Configuring

Configuring your system for the JDK consists in two tasks: setting the JAVA_HOME environment variable, and ensuring that the system is using the proper JDK (or JRE) using the alternatives command. Setting JAVA_HOME usually overrides the values for java, javac and java_sdk_1.7.0 in alternatives, but we will set them all just to be safe and consistent.

Setting the JAVA_HOME Environment Variable on Generic Linux

After installing the JDK, you must ensure that the JAVA_HOME environment variable exists and points to the location of your JDK installation.

Setting java, javac and java_sdk_1.7.0 Using the alternatives command

As the root user, call /usr/sbin/alternatives with the --config java option to select between JDKs and JREs installed on your system:

Setting the JAVA_HOME Environment Variable on Windows

For information on how to set environment variables in Windows, refer to http://support.microsoft.com/kb/931715.

Testing

Finally, to make sure that you are using the correct JDK or Java version (7), and that the java executable is in your PATH, run the java -version command in the terminal from your home directory:

~]$ java -version
java version "1.7.0_16"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.7.0_16-b03)
Java HotSpot(TM) Client VM (build 1.7.0_16-b03, mixed mode, sharing)
Uninstalling

There is usually no reason (other than space concerns) to remove a particular JDK from your system, given that you can switch between JDKs and JREs easily using alternatives, and/or by setting JAVA_HOME.

Uninstalling the JDK on Linux

On RPM-based systems, you can uninstall the JDK using the yum remove <jdk_rpm_name> command.

Uninstalling the JDK on Windows

On Windows systems, check the JDK entry in the Start menu for an uninstall command, or use Add/Remove Programs.

Appendix B: Setting the JBOSS_HOME Environment Variable

The Restcomm Platform (Restcomm) is built on top of the JBoss Application Server. You do not need to set the JBOSS_HOME environment variable to run any of the Restcomm Platform servers unless JBOSS_HOME is already set.

The best way to know for sure whether JBOSS_HOME was set previously or not is to perform a simple check which may save you time and frustration.

Checking to See If JBOSS_HOME is Set on Unix

At the command line, echo $JBOSS_HOME to see if it is currently defined in your environment:

~]$ echo $JBOSS_HOME

The Restcomm Platform or most of Restcomm servers are built on top of the JBoss Application Server (JBoss Application Server). When the Restcomm Platform or Restcomm servers are built on top of the JBoss Application Server (JBoss Application Server), then JBOSS_HOME must be set, because the Restcomm files are installed into (or “over top of” if you prefer) a clean JBoss Application Server installation, and the build process assumes that the location pointed to by the JBOSS_HOME environment variable at the time of building is the JBoss Application Server installation into which you want it to install the Restcomm files.

This guide does not detail building the Restcomm or any Restcomm servers from source. It is nevertheless useful to understand the role played by JBoss Application Server and JBOSS_HOME in the smpp-extensions ecosystem.

The immediately-following section considers whether you need to set JBOSS_HOME at all and, if so, when. The subsequent sections detail how to set JBOSS_HOME on Unix and Windows

Even if you fall into the category below of not needing to set JBOSS_HOME, you may want to for various reasons anyway. Also, even if you are instructed that you do not need to set JBOSS_HOME, it is good practice nonetheless to check and make sure that JBOSS_HOME actually isn’t set or defined on your system for some reason. This can save you both time and frustration.

You DO NOT NEED to set JBOSS_HOME if…​

  • …​you have installed the Restcomm binary distribution.

  • …​you have installed a Restcomm server binary distribution which bundles JBoss Application Server.

You MUST set JBOSS_HOME if…​

  • …​you are installing the Restcomm or any of the Restcomm servers from source.

  • …​you are installing the Restcomm binary distribution, or one of the Restcomm server binary distributions, which do not bundle JBoss Application Server.

Naturally, if you installed the Restcomm or one of the Restcomm server binary releases which do not bundle JBoss Application Server, yet requires it to run, then you should install before setting JBOSS_HOME or proceeding with anything else.

Setting the JBOSS_HOME Environment Variable on Unix

The JBOSS_HOME environment variable must point to the directory which contains all of the files for the Restcomm or individual Restcomm; server that you installed. As another hint, this topmost directory contains a bin subdirectory.

Setting JBOSS_HOME in your personal ~/.bashrc startup script carries the advantage of retaining effect over reboots. Each time you log in, the environment variable is sure to be set for you, as a user. On Unix, it is possible to set JBOSS_HOME as a system-wide environment variable, by defining it in /etc/bashrc, but this method is neither recommended nor detailed in these instructions.

Procedure: To Set JBOSS_HOME on Unix…​
  1. Open the ~/.bashrc startup script, which is a hidden file in your home directory, in a text editor, and insert the following line on its own line while substituting for the actual install location on your system:

    export JBOSS_HOME="/home/<username>/<path>/<to>/<install_directory>"
  2. Save and close the .bashrc startup script.

  3. You should source the .bashrc script to force your change to take effect, so that JBOSS_HOME becomes set for the current session[1].

    ~]$ source ~/.bashrc
  4. Finally, ensure that JBOSS_HOME is set in the current session, and actually points to the correct location:

    The command line usage below is based upon a binary installation of the Restcomm. In this sample output, JBOSS_HOME has been set correctly to the topmost_directory of the Restcomm installation. Note that if you are installing one of the standalone Restcomm servers (with JBoss Application Server bundled!), then JBOSS_HOME would point to the topmost_directory of your server installation.
    ~]$ echo $JBOSS_HOME
    /home/silas/<path>/<to>/<install_directory>
Setting the JBOSS_HOME Environment Variable on Windows

The JBOSS_HOME environment variable must point to the directory which contains all of the files for the smpp-extensions Platform or individual smpp-extensions server that you installed. As another hint, this topmost directory contains a bin subdirectory.

For information on how to set environment variables in recent versions of Windows, refer to http://support.microsoft.com/kb/931715.

Unresolved directive in SMPP_Extensions_Installation_Guide.adoc - include::Revision_History.adoc[]


1. Note that any other terminals which were opened prior to your having altered .bashrc will need to source ~/.bashrc as well should they require access to JBOSS_HOME.