JBoss.orgCommunity Documentation

Mobicents JAIN SLEE Management Console User Guide


Preface
1. Document Conventions
1.1. Typographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. Provide feedback to the authors!
1. Introduction to Mobicents JAIN SLEE Management Console
2. Installing Mobicents JAIN SLEE Management Console
2.1. Pre-Install Requirements and Prerequisites
2.1.1. Hardware Requirements
2.1.2. Software Prerequisites
2.2. Install Mobicents JAIN SLEE Management Console
2.3. Uninstalling Mobicents JAIN SLEE Management Console
2.4. Building Mobicents JAIN SLEE Management Console from source
3. Configuring and Running Mobicents JAIN SLEE Management Console
3.1. Running Mobicents JAIN SLEE Management Console
3.2. Configuring Mobicents JAIN SLEE Management Console
4. Managing Mobicents JAIN SLEE with Mobicents JAIN SLEE Management Console
4.1. "SLEE" View
4.2. "Deployable Units" View
4.2.1. View Deployable Units Details
4.2.2. Search Deployable Units
4.2.3. Install Deployable Units
4.2.4. Uninstall Deployable Units
4.3. "Components" View
4.3.1. View Components Details
4.3.2. Search Components
4.4. "Services" View
4.4.1. View Service Details
4.4.2. View and Change Service State
4.4.3. Service Usage Parameters
4.5. "Resources" View
4.5.1. View Resource Adaptor Details
4.5.2. View and Change Resource Adaptor Entities State
4.5.3. Create a Resource Adaptor Entity
4.5.4. Remove a Resource Adaptor Entity
4.5.5. View Resource Adaptor Entity Details
4.5.6. View and Change Resource Adaptor Entity Configuration Properties
4.5.7. View and Change Resource Adaptor Entity Links
4.5.8. Resource Adaptor Usage Parameters
5. Monitoring Mobicents JAIN SLEE with Mobicents JAIN SLEE Management Console
5.1. "Activities" View
5.1.1. View Activities Details
5.1.2. Query Activity Context Liveness
5.2. "Alarms" View
5.2.1. View Alarms Details
5.2.2. Clear an Alarm
A. Java Development Kit (JDK): Installing, Configuring and Running
B. Setting the JBOSS_HOME Environment Variable
C. Revision History
Index

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 Bugzilla: http://bugzilla.redhat.com/bugzilla/ against the product ${product.name}, or contact the authors.

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

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.

Mobicents JAIN SLEE Management Console can be built from source by using Maven build tool, following these steps:

  1. Downloading the source code

    Use SVN to checkout a specific release source, the base URL is , then add the specific release version, eg: 2.0.0.BETA1.

    [usr]$ svn co http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/tools/slee-management-console/2.0.0.BETA1/ slee-management-console-2.0.0.BETA1

    If desired, it could be downloaded from the SVN trunk, but this is not always stable or even guaranteed to build correctly. To do so, use:

    [usr]$ svn co http://mobicents.googlecode.com/svn/trunk/servers/jain-slee/tools/slee-management-console/ slee-management-console
  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

    Important

    Make sure to have the JBOSS_HOME environment variable set and pointing to the desired Mobicents installation.

    Use Maven to build the binaries.

    [usr]$ cd slee-management-console-2.0.0.BETA1
    [usr]$ mvn clean install

    Once the process finishes you should have the slee-management-console.war file in the JBOSS_HOME/server/<node>/deploy/ directory.

In this view, it is possible to view the ID of the server, such as name, vendor, version and codename and also the SLEE state.

Figure 4.1. SLEE Main View


The following states can be observed:

  • STOPPED

    The SLEE environment is configured and initialized, ready to be started. This means resource adaptor objects for resource adaptor entities in the ACTIVE state are loaded and initialized, and SBBs corresponding to Services in the ACTIVE state are loaded and ready to be instantiated. However the entire event-driven subsystem is idle. Resource adaptor entities and the SLEE are not actively producing events, and the event router is not operating. SBB entities are not created in this state.

  • STARTING

    Any vendor-specific starting state tasks may be performed here. Services in the ACTIVE state are made ready to receive events, but SBB entities are still not created in this state. The SLEE spontaneously moves out of this state when (a) startup tasks are complete, which causes transition to the RUNNING state; (b) some startup task fails, which causes transition to the STOPPING state.

  • RUNNING

    Resource adaptor objects that are in the ACTIVE (or STOPPING) state are actively firing events as conditions dictate. The SLEE may also be firing events. The event router is instantiating SBB entities and delivering events to them as required.

  • STOPPING

    This state is identical to the RUNNING state except no new Activity objects are accepted by the SLEE from resource adaptor objects, and no new Activity objects are created by the SLEE. If this state is reached from the STARTING state, there will be no Activity objects and transition to the STOPPED state should immediately occur. If this state is reached from the RUNNING state, any existing Activity objects are allowed to end (subject to an arbitrary vendor-specified timeout). Once all Activity objects generated by a particular resource adaptor entity have ended, resource adaptor objects of that resource adaptor entity transition to the INACTIVE state. The SLEE transitions out of the STOPPING state once all Activity objects have ended and all resource adaptor objects have transitioned to the INACTIVE state.

It is also possible to manage the SLEE state from this view, by using the following buttons:

  • Start

    In order to use this button the SLEE must be in the STOPPED state. It will move the SLEE to the STARTING state and once the start operations complete, switch to the RUNNING state.

  • Stop

    In order to use this button the SLEE must be in the STARTED state. It will move the SLEE to the STOPING state and once the stop operations complete, switch to the STOPPED state.

  • Shutdown

    In order to use this button the SLEE must be in the STOPPED state. It will shutdown completely the SLEE container as well as the JBoss Application Server.

In this view, it is possible to view, search, install and uninstall Deployable Units in the SLEE. A list showing the deployable units, identified by their filename, is shown.

Figure 4.2. Deployable Units Main View


It is possible to see detailed information about the deployable units by clicking on it's name.

Figure 4.3. Deployable Units Details


The following fields are shown:

  • Name

    The Deployable Unit name, extracted from it's filename.

  • ID

    The SLEE identifier for this Deployable Unit.

  • Date

    The deployment date for this Deployable Unit.

  • URL

    The URL from where this deployable unit was deployed from.

  • Components

    The SLEE components included and deployed with this deployable unit.

In order to find specific deployable units, use the Search tab, where it is possible to specify a string to search for and click the Search button to list the DUs for which the name matches the given string.

Figure 4.4. Deployable Units Search View


Regular Expression not supported in Deployable Unit Search

When searching for deployable units, it is not possible to use regular expressions. So using "diam*" may not return anything, while "diameter" may return something.

A deployable unit can be installed to SLEE by going to the Install tab, clicking the Choose File button, browsing to the desired deployable unit file and clicking the Install button.

Figure 4.5. Deployable Units Install View


Deployable Unit Installation

Please note that only the deployable unit will be installed, no further operations will be performed. If you need to, you will need to activate services, create Resource Adaptor Entities and Links, etc.

In this view, the components installed in SLEE are shown, grouped by their types. It is possible to view the components, their details and search for specific components.

Figure 4.6. Components Main View


In the Browse Components tab a list of components is shown, grouped by their type. When clicking on one of the Component Types, a list of the available components of that type is shown, identified by their Name, Vendor and Version.

Figure 4.7. Selected Component Type View


If one of this components is clicked, it's details are shown. The following component types and details are available:

The following details are common to all component types:

  • Name

    The SLEE component Name identifier.

  • ID

    The SLEE component identifier, built from the component type, name, vendor and version.

  • Vendor

    The SLEE component Vendor identifier.

  • Version

    The SLEE component Version identifier.

  • Source

    The path to the jar containing this component, inside the deployable unit jar.

  • Deployable Unit

    The deployable unit used to deploy this component.

  • Library References

    The libraries this component refers, if any.

The following are specific to each component type:

  • Event Type

    • Event Class Name

      The class name for this event type.

  • Profile Specification

    • CMP Interface Name

      The interface name for the Profile CMP.

  • SBB

    • Address Profile Specification

      The profile specification to be used as the Address Profile Specification for this SBB.

    • Event Types

      The event types referenced by this SBB, either for Fire and/or Receive.

    • Profile Specifications

      The profile specs referenced by this SBB.

    • Resource Adaptor Entity Links

      The resource adaptor links required by this SBB.

    • Resource Adaptor Types

      The resource adaptor types referenced by this SBB, either for Fire and/or Receive.

    • SBBs

      The child SBBs this SBB has.

  • Resource Adaptor Type

    • Event Types

      The event types referenced by this Resource Adaptor Type, that it can fire.

  • Resource Adaptor

    • Event Types

      The Resource Adaptor Type implemented by this Resource Adaptor.

  • Service

    • Address Profile Table

      The Address Profile Table name to be used by this service, if any.

    • Resource Info Profile Table

      The Resource Info Profile Table name to be used by this service, if any.

    • Root SBB

      The SBB to be used as the Root SBB for this service.

  • Library

    • Library Jars

      The JARs exposed by this Library component.

In order to find specific components, use the Search tab, where it is possible to specify a string to search for and click the Search button to list the components for which the name matches the given string.

Figure 4.8. Components Search View


Regular Expression not supported in Component Search

When searching for components, it is not possible to use regular expressions. So using "diam*" may not return anything, while "diameter" may return something.

Figure 4.9. Services Main View


In this view, the services present in SLEE are shown, along with their state. It is possible to view the services, their details, view and change the service state.

In the Usage Parameters tab is possible to view and manage the service SBBs Usage Parameters. In this screen, select a Service and an SBB and if a SBB Usage Parameter Interface is defined, this view will present the default and other available Usage Parameter Sets.

Figure 4.10. Services Usage Parameters View


In this view, the resource adaptors present in SLEE are shown, identified by their name, vendor, version and RA Type implemented. It is possible to view the resources, their details, view and manage Resource Adaptor Entities and Links.

Figure 4.11. Resources Main View


When the existing Resource Adaptor Entities list is shown, the Resource Adaptor Entities state is presented in the State column, it can be:

In the Usage Parameters tab is possible to view and manage the Resource Adaptors' Entities Usage Parameters. In this screen, select a Resource Adaptor and a Resource Adaptor Entity and if a Resource Adaptor Usage Parameter Interface is defined, this view will present the default and other available Usage Parameter Sets.

Figure 4.12. Resource Adaptor Usage Parameters View


In order to view the Usage Parameters for a given set click it's name.

Figure 4.13. Resource Adaptor Usage Parameters Details View


The following types are displayed:

  • Counter Type

    A counter-type usage parameter can be incremented or decremented. The current (approximate) value of the counter-type usage parameter is displayed under the Value column is shown.

  • Sample Type

    A sample-type usage parameter accumulates sample data, when a SLEE Component submit samples to the usage parameter. The current (approximate) minimum, maximum, mean, and the number of sample values added to the sample-type usage parameter are shown.

No automatic refresh

In order to keep a low impact on the SLEE no real-time update is performed with regards to the Usage Parameters. To update the displayed values, please click the refresh link.

Figure 5.1. Activities Main View


In this view, it's possible to monitor the existing activities in the SLEE. The Activity Contexts are listed by their ID, TTL (maximum time in seconds without being accessed) and their Java Class Name.

Figure 5.2. Activities Details View


In the Browse Activities tab the list of activities is shown. When clicking on one of the Activity Context ID, it's details are shown. The following details are displayed:

  • ID

    The internal identifier for this Activity Context.

  • Activity Class

    The Java class representing this activity.

  • Last Access Timestamp

    The timestamp of when this Activity Context was last accessed.

  • Timers

    The SLEE Timers attached to this Activity Context, if any.

  • Data Attributes

    The CMP attributes set in this Activity Context, if any.

  • Name Bindings

    The set of names given to this Activity Context, if any.

  • RA Entity

    The Resource Adaptor Entity responsible for creating this Activity Context, if any.

  • SBB Attachments

    The SBBs attached to this Activity Context, if any.

It is also possible to view the details of the SBB Entities attached to the activities by clicking on it's ID.

Figure 5.3. Activities SBB Entity Details View


The following details are shown:

  • Entity ID

    The internal identifier for this SBB Entity.

  • Parent SBB Entity

    The internal identifier for the parent SBB Entity for this SBB Entity, if any.

  • Root SBB Entity

    The internal identifier of the root SBB Entity for this SBB Entity, which may be itself.

  • SBB

    The SBB component this SBB Entity represents.

  • Priority

    The priority for this SBB Entity in it's child relation, if any.

  • Service Convergence Name

    A name used to uniquely identify a root SBB entity belonging to a Service.

  • Service

    The SLEE Service to which this SBB Entity belongs.

Figure 5.4. Alarms Main View


In this view, it's possible to monitor the alarms which occured in the SLEE. The alarms are listed by their Timestamp, ID, Level and Message.

No automatic refresh

In order to keep a low impact on the SLEE no real-time update is performed with regards to the Usage Parameters. To update the displayed values, please click the refresh link.

Figure 5.5. Alarms Details View


In the Active Alarms tab the list of alarms is shown. When clicking on one of the alarms ID, it's details are shown. The following details are displayed:

  • ID

    The internal identifier for this alarm.

  • Timestamp

    The Java class representing this activity.

  • Level

    The alarm level of the alarm represented by the alarm notification. In order of severity, from highest to least, they are: CLEAR, CRITICAL, MAJOR, WARNING, INDETERMINATE, MINOR.

  • Type

    The alarm type of the generated alarm, set by the alarm source.

  • Instance

    The instance of the generated alarm, set by the alarm source.

  • Message

    The message of the alarm notification.

  • Cause

    The Throwable which caused this alarm to be raised, if any, typically used to propagate an exception in the alarm notification.

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.

Downloading

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.

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_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 the JAVA_HOME Environment Variable on Linux

You can determine whether JAVA_HOME is set on your system by echoing it on the command line:

~]$ echo $JAVA_HOME

If JAVA_HOME is 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 ~/.bashrc configuration file. Open ~/.bashrc (or create it if it doesn't exist) and add a line similar to the following one anywhere inside the file:

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 ~/.bashrc files are local to that user).

Setting java, javac and java_sdk_1.5.0 Using the alternatives command
Selecting 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:

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 per alternatives' 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:

~]$ /usr/sbin/alternatives --config javac
~]$ /usr/sbin/alternatives --config java_sdk_1.5.0
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 (5 or higher), 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.5.0_16"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_16-b03)
Java HotSpot(TM) Client VM (build 1.5.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.



[1] At this point in time, it is possible to run most Mobicents servers, such as the JAIN SLEE, 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.

The Mobicents Platform (Mobicents) 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 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:

~]$ echo $JBOSS_HOME

The Mobicents Platform and most Mobicents servers are built on top of the JBoss Application Server (JBoss Application Server). When the Mobicents 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 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 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

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 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 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 B.1. 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[2].

    ~]$ source ~/.bashrc
  4. Finally, ensure that JBOSS_HOME is 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_HOME has been set correctly to the topmost_directory of the Mobicents installation. Note that if you are installing one of the standalone Mobicents servers (with JBoss AS bundled!), then JBOSS_HOME would point to the topmost_directory of your server installation.

    ~]$ echo $JBOSS_HOME
    /home/silas/
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 to http://support.microsoft.com/kb/931715.



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

Revision History
Revision 1.0Mon Jan 09 2012Alexandre Mendonça
Creation of the Mobicents JAIN SLEE Management Console User Guide.