The Mobicents Platform is written in Java; therefore, before running any Mobicents server, you must have a working Java Runtime Environment (JRE) or Java Development Kit (JDK) installed on your system. In addition, the JRE or JDK you are using to run Mobicents must be version 5 or higher[1].
Should I Install the JRE or JDK? Although you can run Mobicents servers using the Java Runtime Environment, we assume that most users are developers interested in developing Java-based, Mobicents-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.
You can download the Sun JDK 5.0 (Java 2 Development Kit) from Sun’s website:http://java.sun.com/javase/downloads/index_jdk5.jsp. Click on the Download link next to “JDK 5.0 Update <x>” (where <x>is the latest minor version 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 Java Development Kit 5.0 License Agreement, and proceed to the download page.
The Sun website will present two download alternatives to you: one is an RPM inside a self-extracting file (for example,jdk-1_5_0_16-linux-i586-rpm.bin), and the other is merely a self-extracting file (e.g. jdk-1_5_0_16-linux-i586.bin). 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 Mobicents in a production environment.
Installing. The following procedures detail how to install the Java Development Kit on both Linux and Windows.
Procedure 10.1. Installing the JDK on Linux
- 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-1_5_0_<minor_version>-linux-<architecture>-rpm.bin" ~]$ ./"jdk-1_5_0_<minor_version>-linux-<architecture>-rpm.bin"
Moving from Non-RPM Installer to 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 -compatpackage which corresponds correctly to the minor release number of the JDK you installed. The compat packages are available fromftp://jpackage.hmdc.harvard.edu/JPackage/1.7/generic/RPMS.non-free/.
Important
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.
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.5.0 in alternatives, but we will set them all just to be safe and consistent.
- Setting the
JAVA_HOMEEnvironment Variable on Generic Linux - After installing the JDK, you must ensure that the
JAVA_HOMEenvironment variable exists and points to the location of your JDK installation.Setting theJAVA_HOMEEnvironment Variable on Linux. You can determine whetherJAVA_HOMEis set on your system by echoing it on the command line:
<a id="setting-ENV-linux"></a>~]$ echo $JAVA_HOME
IfJAVA_HOMEis not set already, then you must set its value to the location of the JDK installation on your system. You can do this by adding two lines to your personal~/.bashrcconfiguration file. Open~/.bashrc(or create it if it doesn’t exist) and add a line similar to the following one anywhere inside the file:
<a id="setting-ENV-linux"></a>export JAVA_HOME="/usr/lib/jvm/jdk1.5.0_<version>"
You should also set this environment variable for any other users who will be running Mobicents (any environment variables exported from~/.bashrcfiles are local to that user).
Setting java, javac and java_sdk_1.5.0 Using the alternatives commandSelecting the Correct System JVM on Linux using alternatives . On systems with the alternatives command, including Red Hat Enterprise Linux and Fedora, you can easily choose which JDK (or JRE) installation you wish to use, as well as which java and javac executables should be run when called.
As the root user, call /usr/sbin/alternatives with the --config java option to select between JDKs and JREs installed on your system:
<a id="setting-correct-java-version"></a>root@localhost ~]$ /usr/sbin/alternatives --config java There are 3 programs which provide 'java'. Selection Command ----------------------------------------------- 1 /usr/lib/jvm/jre-1.5.0-gcj/bin/java 2 /usr/lib/jvm/jre-1.6.0-sun/bin/java *+ 3 /usr/lib/jvm/jre-1.5.0-sun/bin/java Enter to keep the current selection[+], or type selection number:
In our case, we want to use the Sun JDK, version 5, that we downloaded and installed, to run the java executable. In the alternatives information printout above, a plus (+) next to a number indicates the one currently being used. As peralternatives‘ instructions, pressing Enter will simply keep the current JVM, or you can enter the number corresponding to the JVM you would prefer to use.
Repeat the procedure above for the javac command and the java_sdk_1.5.0 environment variable, as the root user:
<a id="setting-correct-java-version"></a>~]$ /usr/sbin/alternatives --config javac
<a id="setting-correct-java-version"></a>~]$ /usr/sbin/alternatives --config java_sdk_1.5.0
- Setting the
JAVA_HOMEEnvironment Variable on Windows - For information on how to set environment variables in Windows, refer to http://support.microsoft.com/kb/931715.
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 yumremove <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.
The Mobicents Platform (Mobicents) is built on top of the JBoss Application Server (JBoss AS). You do not need to set theJBOSS_HOME environment variable to run any of the Mobicents 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:
<a id="setting-jboss-ENV-variable-windows-unix"></a>~]$ echo $JBOSS_HOME
The Mobicents Platform and most Mobicents servers are built on top of the JBoss Application Server (JBoss AS). When theMobicents Platform or Mobicents servers are built from source, then JBOSS_HOME must be set, because the Mobicents files are installed into (or “over top of” if you prefer) a clean JBoss AS 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 AS installation into which you want it to install the Mobicents files.
This guide does not detail building the Mobicents Platform or any Mobicents servers from source. It is nevertheless useful to understand the role played by JBoss AS and JBOSS_HOME in the Mobicents 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
Important
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 setJBOSS_HOME, it is good practice nonetheless to check and make sure that JBOSS_HOME actuallyisn’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 MUST set JBOSS_HOME if…
Naturally, if you installed the Mobicents Platform or one of the Mobicents server binary releases which do not bundle JBoss AS, yet requires it to run, then you should install JBoss AS 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 Mobicents Platform or individual Mobicents 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 10.2. To Set JBOSS_HOME on Unix…
- Open the
~/.bashrcstartup 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>"
- Save and close the
.bashrcstartup script.
- You should source the
.bashrcscript to force your change to take effect, so thatJBOSS_HOMEbecomes set for the current session[2].
~]$ source ~/.bashrc
- Finally, ensure that
JBOSS_HOMEis set in the current session, and actually points to the correct location:Note
The command line usage below is based upon a binary installation of the Mobicents Platform. In this sample output,
JBOSS_HOMEhas been set correctly to thetopmost_directoryof the Mobicents installation. Note that if you are installing one of the standalone Mobicents servers (with JBoss AS bundled!), thenJBOSS_HOMEwould point to thetopmost_directoryof your server installation.~]$ echo $JBOSS_HOME /home/silas/mobicents-all-1.2.1.GA-jboss-4.2.3.GA/jboss/
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 Mobicents Platform or individual Mobicents 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 tohttp://support.microsoft.com/kb/931715.
Procedure 10.3. Setting the CATALINA_HOME Environment Variable on Linux
- The
CATALINA_HOMEenvironment variable must point to the location of your Tomcat installation. Any Mobicents server which runs on top of the Tomcat servlet container has a topmost directory, i.e. the directory in which you unzipped the zip file to install the server, and underneath that directory, abindirectory.CATALINA_HOMEmust be set to the topmost directory of your Mobicents server installation.Setting this variable in your personal~/.bashrcfile has the advantage that it will always be set (for you, as a user) each time you log in or reboot the system. To do so, open~/.bashrcin a text editor (or create the file if it doesn’t already exist) and insert the following line anywhere in the file, taking care to substitute<sip_server>for the topmost directory of the Mobicents server you installed:
export CATALINA_HOME="/home/<username>/<path>/<to>/<sip_server>"
Save and close.bashrc. - You can—and should—source your
.bashrcfile to make your change take effect (so thatCATALINA_HOMEis set) for the current session:
~]$ source ~/.bashrc
- Finally, make sure that
CATALINA_HOMEhas been set correctly (that it leads to the right directory), and has taken effect in the current session.The following command will show the path to the directory pointed to byCATALINA_HOME:
~]$ echo $CATALINA_HOME
To be absolutely sure, change your directory to the one pointed to byCATALINA_HOME:
~]$ cd $CATALINA_HOME && pwd
Procedure 10.4. Setting the CATALINA_HOME Environment Variable on Windows
- The
CATALINA_HOMEenvironment variable must point to the location of your Tomcat installation. Any Mobicents server which runs on top of the Tomcat servlet container has a topmost directory, i.e. the directory in which you unzipped the zip file to install the server, and underneath that directory, abindirectory.CATALINA_HOMEmust be set to the topmost directory of your Mobicents server installation.If you are planning on running the Tomcat container as the Administrator, then you should, of course, set theCATALINA_HOMEenvironment variable as the administrator, and if you planning to run Tomcat as a normal user, then setCATALINA_HOMEas a user environment variable.For information on how to set environment variables in Windows, refer to http://support.microsoft.com/kb/931715.
[1]At this point in time, it is possible to run most Mobicents servers, such as the JAIN SLEE Server, using a Java 6 JRE or JDK. Be aware, however, that presently the XML Document Management Server does not run on Java 6. We suggest checking the Mobicents web site, forums or discussion pages if you need to inquire about the status of running the XML Document Management Server with Java 6.
[2]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.
The post Sip Servlets – 10. Java Development Kit (JDK) appeared first on Telestax Docs Online.