Look what Java and SIP can do
 (SIP)Java = ∞
Home     News     Projects     Downloads     Support     Contact

Jiplet Container Home

Jiplet Configuration Howto

Jiplet Developer Guide

Installation Howto

In order to understand how to install the Jiplet Container, you must read the entire howto sequentially, not just the topics you need to know more about. This is because one topic may refer to a previous topic.

Topics:
What kind of conventions are followed by this howto documentation?
  1. We have used the term "directory" to specify a file location. This is a common Unix convention. In the Windows environment, the term "folder" is used to mean the same thing.
  2. We have used the Unix directory naming convention in this document. In the Unix environment, a directory hierarchy is specified by the "/" separator. In the Windows environment, the "\" separator is used. In addition, Unix systems do not use drive letters as in Windows. If you are using Windows, you will need to modify the commands accordingly. For example, if we stated $JIPLET_HOME/bin and you are using Windows, it may translate to C:\jiplet-standalone\bin.
  3. We have used $JIPLET_HOME or similar names to specify variables. While installing/configuring, you will need to replace these variables with the actual value. For example, in this document, the variable $JIPLET_HOME has been used to specify the directory where the jiplet container code binary is installed. We have commonly used the following variables:
    1. $JAVA_HOME - directory where the Java Runtime Environment (JRE) is installed.
    2. $JIPLET_HOME - directory where the Jiplet Container software is installed.
    3. $JBOSS_HOME - directory where Jboss is installed.
    4. $TOMCAT_HOME - directory where Tomcat is installed.
    5. $HOST - host name/IP address of the system where the jiplet container is installed.
    6. $RUN - the Jboss run mode (default, minimal, all, etc.)
  4. Commands are specified using bold. You need to enter the command by typing/pasting the command and pressing the Enter/Return key. Although in the Unix world this may seem natural, in the Windows environment, lots of users are lost when it comes to entering a command. Also, the prompts "#" or "C:\>" are shown, do not enter them.
Top

What kind of hardware and software do I need on my computer in order to run the Jiplet Container?
Our system has been tested on Windows and Linux x86. It is possible to run it on other systems including other flavors of UNIX, MAC, VMS. In that case, you may have to modify some of the shell scripts provided with the package. If you are trying it out, you can use any PC with 100MB Hard disk and at least 256MB RAM. If you want to deploy it in a production environment, we recommend the following configuration:
  1. x86 2GB or higher speed CPU
  2. 512MB RAM - the more the better
  3. 200MB free disk space
  4. Fast Ethernet adapter.
For an operating system, you may choose the following:
  1. Microsoft Windows NT, 2000, XP or higher.
  2. Linux x86 distribution from Redhat, Suse, Fedora, Debian, etc.
We recommend the Linux platform for production deployment.


What additional software must be installed in order to run this application?
You will need the following:
  1. Java Run-time Environment (JRE): You can obtain the JRE from http://www.javasoft.com. We use JRE 1.5.0. You must at least use JRE 1.5.0 or higher. You will find installation instructions for the JRE from the javasoft web site.
  2. If you want to run the application as a Jboss service, you also need to have Jboss installed. We have tested the software with Jboss 4.0.5.GA Since the jiplet container extends some of the Jboss classes, we strongly recommend that you use the same version of Jboss as we use especially if you want to use advanced features like including a SIP archive inside an EAR. You can find downloadable binary packages and installation instructions from http://www.jboss.org. 
  3. If you are running the jiplet container in the standalone mode and would like to install the Jiplet Console system web-based system administration interface, you need to have a servlet container installed. We use Tomcat 5.5 from the Apache Foundation. You can download the binaries from http://jakarta.apache.org.
The rest of the software is included with the jiplet container package. If you are using Jboss or Tomcat, you need to make sure that it is installed as a Windows or Linux/Unix service. When running as a service, the operating system starts and stops the application when the system is started/stopped as well as for other reasons.

Top

What kind of security measures do I need to take in order to prevent unauthorized access?
If you are installing this software for in-house use, you may not have to worry about any security measures. However, if this system is visible to a wider world like the Internet, you need to take a number of security measures. Namely:
  1. Make sure that you have the latest security patches for the operating system on the system you are installing the jiplet container application.
  2. Install a firewall software on your system. If you are using Linux, it already comes with a firewall.
  3. Identify the networks that need to be secured (untrusted) and well as trusted networks. For example, if the system has two Ethernet interfaces and one is connected to your company's internal network and the other one to the Internet, the interface connecting to the Internet needs to be secured and the internal network is trusted. Block all ports on the  untrusted network except the ones that are being used by the Jiplet Container application.
  4. Discuss your settings with a system administrator/computer security expert.
  5. Check the CafeSip.org web site regularly. If the jiplet container has any security updates, please install them immediately.

Top

What ports do I need to open on the firewall for the jiplet container to work?
It will depend on your configuration.

If you have a trusted network, you can unblock all ports for that network. For a more strict configuration, you can unblock the following ports on the trusted network.
  1. SIP ports: by default the jiplet container uses TCP port 5060 and UDP port 5060. You can change them. See the configuration howto for details.
  2. Jiplet Console HTTP ports: TCP/8080 and TCP/8443.
  3. If you are using Linux/Unix, you should also consider opening the SSH port for transferring files and shell access.
  4. If you are using Windows, you may want to consider installing something like a VNC server for remotely accessing the system. In that case, you need to open up the VNC port.
  5. Opening up TELNET, FTP or other insecure access is NOT recommended.
For the untrusted network (Internet), you need to unblock the following:
  1. SIP ports used by the jiplet container.
  2. If you need to access the Jiplet Console from the untrusted network, you need to unblock ports TCP/8080 and TCP/8443. However, this approach is inherently insecure.
  3. If you need to access the system SSH/SFTP/SCP, you need to turn on the SSH port. Again, do this only if you need to.

Top

How do I install the standalone Jiplet Container?
Here are the steps for Windows and Linux systems. If you are using some other operating systems, you may have to improvise:
  1. Make sure that you have installed the pre-requisite software. For more details on what you need to have installed on your system, click here.
  2. Remove any previous installation of the jiplet container application. Remove the jiplet-standalone directory as well as the jiplet-console webapp (if you installed it). To remove the webapp, you will need to remove the jiplet-console.war file and the jiplet-console directory (created by Tomcat) from the $TOMCAT_HOME/webapps directory where $TOMCAT_HOME is the directory under which Tomcat was installed.
  3. Download the packages jiplet-standalone-$VERSION.zip and jiplet-console-$VERSION.zip from the CafeSip.org download site to the system where you want to install the software. Note: $VERSION in the file names indicate the version number of the jiplet applications.
  4. Login to the system as the super-user (root) on Linux/Unix systems and as a user with admin privileges on a Windows system.
  5.  First unpack the file jiplet-standalone-$VERSION.zip into a directory. How you unpack it will depend on the operating system you are using. On Windows, you can use utilities that come with some versions of the operating system or you can use third-part utilities like WINZIP or jar (a part of the Java 2 SDK). On Linux, you can use the unzip command line tool or jar. The package can be unpacked in any directory but we recommend that on Windows system you unpack it in the C:\ directory and on Linux/Unix system, you unpack it under /usr/local directory. When you unpack, it will create a directory called jiplet-standalone under which all the binaries, documentation, etc. are located. If you have not unpacked the software in the recommended directory, you will have to modify the startup shell scripts as directed below.
  6. On Unix/Linux systems, change the permission of the file jiplet-standalone/bin/jiplet as follows:

    # chmod +x jiplet-standalone/bin/jiplet

  7. On Linux/Unix systems, create a group called jiplet and an user id called jiplet and assign ownership of the jiplet-standalone directory tree to this user.

    # groupadd jiplet
    # useradd -g jiplet jiplet
    # chown -R jiplet.jiplet jiplet-standalone

    At this point, the installation of the jiplet-standalone package is completed.

  Please refer to the post-installation section for further configuration.

Top

How do I install the Jiplet Container as a Jboss service?
You need to execute the following steps:
  1. Make sure that you have installed and started Jboss.
  2. Remove any previous installation of the jiplet container application. Remove the directory jiplet-service.sar and the file jiplet-console.war file from the Jboss deployment directory (the directory where you copied the previous version of the jiplet application).
  3. Download the packages jiplet-jboss-$VERSION.zip and jiplet-console-$VERSION.zip from the CafeSip.org download site to the system where you want to install the software. Note: $VERSION in the file names indicate the version number of the jiplet applications.
  4. Identify the Jboss deployment directory. The location of the deployment directory will depend on your Jboss run configuration. The Jboss server can be deployed in various configurations. Depending on the configuration, specific J2EE services are started. You can even create your own custom run configuration. When you start Jboss, you specify your configuration using the "-c" command line option. For more details, refer to the Jboss documentation. The Jboss deployment directory is $JBOSS_HOME/server/$RUN/deploy where $JBOSS_HOME is the directory where Jboss is installed and $RUN is the run configuration. For example, if you have Jboss installed in C:\jboss and you have selected "all" as the run configuration, the deployment directory is C:\jboss\server\all\deploy.
  5. Unpack the jiplet-jboss-$VERSION.zip into a temporary directory. It will create a directory named jiplet-jboss. Under this directory, you will find a file named jiplet-service.sar. Copy this file into the Jboss deployment directory. We recommend that you do not have the Jboss server running while the file is being unpacked, until the post-installation configuration is completed. If you are installing on a Linux/Unix system, please ensure that the file ownership of this directory is set correctly so that the Jboss process can access files under this directory. At this point, the installation of the jiplet-jboss package is completed.
Please refer to the post-installation section for further configuration.
Top

What is a Jiplet Console and how does it get installed?

The jiplet console is an optional management application. It provides a web-based user interface for managing jiplet contexts and realm databases. Although, this is not absolutely necessary, we recommend that you use this tool for deploying and undeploying since it provides a number of features that may not be available to you if you are manually installing realms or contexts.

Step 1: Copying the package

On Jboss:
If you are running the jiplet container as a Jboss service, please follow the instructions outlined next. First unpack the file jiplet-console-$VERSION.zip to any directory. It will create a directory called the jiplet-console. You will find a sub-directory call "jboss". Inside this sub-directory, there is a file named jiplet-console.war as well as other documentation. Copy the file jiplet-console.war into the Jboss deployment directory.

On Tomcat (for the standalone jiplet container):
If you are running the jiplet container as a standalone application, please follow the instructions outlined next. Make sure you have installed a servlet container like Tomcat. Please see the pre-requisite software section above for details. To install the jiplet-console application, first unpack the file jiplet-console-$VERSION.zip to any directory. It will create a directory named jiplet-console. You will find a sub-directory call "standalone".  Inside this sub-directory, there is a file named jiplet-console.war as well as other documentation. Copy the file jiplet-console.war into the $TOMCAT/webapps directory of your Tomcat installation. Re-start Tomcat to start the jiplet-console application. If you are not using Tomcat but want to use some other servlet container, you will have to follow the similar procedures to install the war.

Step 2: Configuring SSL:
The jiplet console (stating with release 0.0.8b) runs on a secure (SSL) connection. This means that all the communication between your browser running the Jiplet Console and the server is secure and cannot be deciphered. However, you will have to configure the Jboss web container or Tomcat for setting up SSL as this is not configured by default when you install Jboss/Tomcat.

On Jboss:
  1. Copy the file cafesip.keystore that is located in the jiplet-console directory of the unpacked archive (see above) to $JBOSS_HOME/server/$RUN/conf directory.
  2. Open the file $JBOSS_HOME/server/$RUN/deploy/jbossweb-tomcat55.war/server.xml using a text editor of your choice.  Search for a XML code segment which looks like the following:

    <!-- SSL/TLS Connector configuration using the admin devl guide keystore
          <Connector port="8443" address="${jboss.bind.address}"
               maxThreads="100" strategy="ms" maxHttpHeaderSize="8192"
               emptySessionPath="true"
               scheme="https" secure="true" clientAuth="false"
               keystoreFile="${jboss.server.home.dir}/conf/chap8.keystore"
               keystorePass="rmi+ssl" sslProtocol = "TLS" />
          -->
  3. Make sure that the code segment is commented out as shown above. The start of the comment and the end of the comment are shown in bold characters above. If the segment is not commented out, comment out the segment by placing the start and end of the comments as shown above.
  4. Just above the code segment add the following code segment:

    <!-- SSL/TLS Connector configuration using the cafesip keystore -->
          <Connector port="8443" address="${jboss.bind.address}"
               maxThreads="100" minSpareThreads="5" maxSpareThreads="15"
               scheme="https" secure="true" clientAuth="false"
               keystoreFile="${jboss.server.home.dir}/conf/cafesip.keystore"
               keystorePass="a1b2c3d4" sslProtocol = "TLS" />

  5. This is the last step for setting up SSL. If you like to use your own SSL keystore instead of the cafesip.keystore file supplied with the package, then you can replace this file with your own SSL keystore and make sure that you have changed the parameters in server.xml (see previous step) accordingly.

On Tomcat:
  1. Copy the file cafesip.keystore that is located in the jiplet-console directory of the unpacked archive (see above) to $TOMCAT_HOME/conf directory.
  2. Open the file $TOMCAT_HOME/conf/server.xml using a text editor of your choice.  Search for a XML code segment which looks like the following:

    <!--
    <Connector
    port="8443" minProcessors="5" maxProcessors="75"
    enableLookups="true" disableUploadTimeout="true"
    acceptCount="100" debug="0" scheme="https" secure="true"
    clientAuth="false" sslProtocol="TLS"/>
    -->

  3. Make sure that the code segment is commented out as shown above. The start of the comment and the end of the comment are shown in bold characters above. If the segment is not commented out, comment out the segment by placing the start and end of the comments as shown above.
  4. Just above the code segment add the following code segment:

         <!-- SSL/TLS Connector configuration using the cafesip keystore -->
         <Connector
              port="8443" minProcessors="5" maxProcessors="75"
              enableLookups="true" disableUploadTimeout="true"
              acceptCount="100" debug="0" scheme="https" secure="true"
              clientAuth="false" sslProtocol="TLS"
              keystoreFile="$TOMCAT_HOME/conf/cafesip.keystore"
              keystorePass="a1b2c3d4"/>

    Replace the $TOMCAT_HOME in the above code segment with the full path name of the directory where the Tomcat server is installed.

  5. This is the last step for setting up SSL. If you like to use your own SSL keystore instead of the cafesip.keystore file supplied with the package, then you can replace this file with your own SSL keystore and make sure that you have changed the parameters in server.xml (see previous step) accordingly.

Step 3: Bring up the console - see how here.


What kind of post-installation configuration do I need to perform?
After completing the unpacking as described above, you need to perform the following steps.
  1. If you are using the standalone jiplet container on Linux systems, you may need to modify the startup shell scripts in order to specify the location of the JAVA runtime environment and also in case you have installed the software in a directory location other than the location recommended above. Open the file $JIPLET_HOME/bin/jiplet using vi or a text editor of your choice where $JIPLET_HOME is the location where the jiplet container package was unpacked. For Unix/Linux systems modify the code segment shown below to modify the java_home and jiplet_home variables:

    if [ -z $JIPLET_HOME ]; then
        jiplet_home=/usr/local/jiplet-standalone         # modify the location shown in bold
    else
        jiplet_home=$JIPLET_HOME
    fi

    if [ -z $JAVA_HOME ]; then
        java_home=/usr/java/jre                                # modify the location shown in bold
    else
        java_home=$JAVA_HOME
    fi
    ....

    Modify java_home to enter the location where Java is installed and jiplet_home to point to the location where the jiplet container is installed. If you are running the jiplet container as a Jboss service, you do not need to perform this step as Jboss starts up the Jiplet Container and therefore these scripts are not used.
  2. This step is optional and is not recommended. If you are using a standalone jiplet container, you may want to modify the location of where the logs generated by the jiplet container are stored. The logs provide you a way to view what is happening inside the system and are very helpful while trouble-shooting a problem. If you are using the jiplet container as a Jboss service, you do NOT need to perform this step because in that configuration, the logging is integrated with Jboss logging services (and therefore already configured using the Jboss log configuration file). For logging in the standalone setup, the jiplet container uses LOG4J and the default location where the log files are stored is $JIPLET_HOME/logs. If you need to change this, modify the LOG4J configuration file. The LOG4J configuration file is $JIPLET_HOME/conf/log4j.xml. Open this file with a text editor and modify the following code segment to specify the log directory.

    <appender name="rollingAppender"
                 class="org.apache.log4j.DailyRollingFileAppender">
                 <param name="datePattern" value=".yyyy-MM-dd"/>
                  <param name="file" value="c:\mydirectory"/>
                 <layout class="org.apache.log4j.PatternLayout">
                    <param name="ConversionPattern" value="%d [%t] %p - %m%n"/>
                </layout>    
       </appender> 

    You may also want to turn off console logging by removing the following section from the config file.

    <root>
        <priority value ="info"/>
        <appender-ref ref="consoleAppender"/>
      </root>

    For more cool things you can do with log4j, please refer to the LOG4J documentation.
  3. The next step is to configure the connectors. Connectors are SIP ports that the jiplet container uses to send and receive SIP messages. The default settings use the TCP/5060 and UDP/5060 ports associated with the host IP address of the machine running the Jiplet Container. These port numbers are SIP standards and you may not have to change them. However, it is possible to use different or additional ports and/or IP address(es) for your system. For more details on how to configure the connectors, please click here.
  4. The final step is to configure realms. Realms are authenitcation and authorization databases used for authenticating incoming SIP request message before delivering the messages to the jiplets. Not all jiplet applications require setting up of realms. But if the application you are planning to deploy uses this feature, you need to configure the realms. For more details on how to configure the realms, please click here.

Top

What are SIP connectors and how are they configured?
The jiplet container uses a concept called connectors. Connectors are basically SIP ports that the jiplet container listens to for SIP messages from other network elements (SIP Phones and other SIP servers). The jiplet container can be configured to have one or more such connectors. One of the connectors is the "default" connector.  The jiplet container package is configured with a single connector (the default connector) that uses ports TCP/5060 and UDP/5060 and the IP address of the server running the jiplet container. It is possible to change the default connector properties/ports or add additional connectors. One or more jiplet applications can be configured to attach to a connector. SIP messages are routed to a jiplet context based on a selection criteria specified by the application configuration. (For more details, refer to the jiplet developer guide).

For the standalone jiplet container, the connectors configured for the system are defined in the file $JIPLET_HOME/conf/server.xml. For the jiplet container running as a Jboss sevice, you can find the same file under $JBOSS_HOME/server/$RUN/conf/jiplet directory and the file is called server.xml. If you have just installed the jiplet container under Jboss, start up Jboss - this will create the conf/jiplet directory with the server.xml in it. Detailed documentation is provided as XML comments inside the file. Please read them if you want to change the settings. Here is a sample server.xml file. You can also view the properties of the connectors from the jiplet console. In addition to setting the ports and IP addresses for SIP communication, it is also possible to set the characteristics of the SIP stack as well as tune the processing capabilities for the connector.

Top

What are realms and how do I configure the realms?
The jiplet container supports Container Managed Authentication and Authorization (CMAA). When a SIP request message is received by the container, it selects the jiplets to which the message has to be delivered based on the jiplet mapping (see the jiplet deployment descriptor for details). If a jiplet specifies a security constraint (specified in the jiplet deployment descriptor) that states that user agent must be authenticated prior to the delivery of the message, the jiplet container authenticates the user agent by using authentication procedures specified by the SIP/HTTP specification (RFC 2617). Only if the authentication is successful and only if the user agent is authorized, is the SIP request delivered to the selected jiplets. The authentication and authorization information is stored in a database or realm. The jiplet container supports multiple realms to be defined and a jiplet can specify a security constraint parameter in which it can specify the realm to use. The authentication and authorization information consists of a list of user name, password and a series of roles that the user has been authorized. Each role is an arbitrary string that must match with that specified in the jiplet deployment descriptor for a SIP request message to be delivered to the jiplet.

For the standalone jiplet container, the realms configured for the system are defined in the $JIPLET_HOME/conf/server.xml configuration file. For the jiplet container running as a Jboss sevice, you can find the same file under $JBOSS_HOME/server/$RUN/conf/jiplet directory and the file is called server.xml. If you have just installed the jiplet container under Jboss, start up Jboss - this will create the conf/jiplet directory with the server.xml in it. Detailed documentation is provided as XML comments inside the file. Please read them if you want to change the settings. Here is a sample server.xml file.

The jiplet container includes multiple types of realms. Each type specifies a different database storage and/or authentication mechanism (retrieval of data from the database). Currently two types of realms are included with the jiplet container. They are:
  1. Memory Realm: This is a memory-resident database that is read from an XML configuration file on initialization. The configuration file contains user names, password and privilege (role) information. The default settings specifies this file in the directory $JIPLET_HOME/conf. The name of the file is jiplet-users.xml. The file contains role definitions and user account information in XML format. The comments in the file explains how to add/and or modify the information in this file. As a default factory setting, one realm of this type is defined for your system. Please modify the jiplet-users.xml file to remove any default user names/passwords we have put into that file to prevent unauthorized access.
  2. JDBC Realm: The authentication information is stored in a JDBC-compliant database and is looked up using SQL queries. The default setup includes a JDBC driver for the MySQL database but you can change the parameters defined in server.xml to choose a different database. This is explained in more details in the configuration howto.
In addition, it is also possible to define your own type of realm and plugging it into the container. For more details, refer to the jiplet advanced developer guide.


How do I start the standalone Jiplet  Container?
Before you start the application for the first time, please make sure you have completed the required post-installation steps described above. Shell scripts have been provided to install the jiplet container as a system service for the Linux and the Windows environment. When run as a system service, the jiplet container application is started and stopped by the operating system on system startup and shutdown respectively. It can also be managed by service tools and utilities provided by the operating system vendor. If you are installing the jiplet console on any other operating systems, you may need to modify the scripts or write similar scripts for your operating system.  The following steps describe how to install the jiplet container as a service for Redhat Linux and Windows. If you are using other versions of the operating system, these steps may be somewhat different.

For Redhat Linux or Fedora Linux:
  1. Login to the system as the super user (root). Open a terminal and run the following commands.
  2. # cp $JIPLET_HOME/bin/jiplet /etc/init.d/
  3. # /sbin/chkconfig --add jiplet
  4. # /sbin/chkconfig --level 2345 jiplet on
    The above commands install the jiplet container as a system service.
  5. # /etc/init.d/jiplet start
          The above command starts the jiplet container.
  6. To stop the application at any time, login as the super user and enter the command:
    # /etc/init.d/jiplet stop
For Microsoft Windows:
  1. Login to the system as a user with administrator privilege.
  2. Open a DOS terminal (command prompt) and run the following commands:
  3. C:\> set JIPLET_HOME=C:\jiplet-standalone
    Please change the C:\jiplet-standalone above to wherever you installed the jiplet container.
  4. C:\> set JAVA_HOME=C:\jre1.5.0_06
    Please change the C:\jre1.5.0_06 above to point to the location where you have the Java Runtime Environment (JRE) installed. If you are using the Java SDK instead of the JRE, specify the "jre" directory located under the directory where the Java SDK is installed (example: C:\Program Files\Java\jdk1.5.0_06\jre).
  5. C:\> cd %JIPLET_HOME%\bin
  6. C:\> jiplet.bat install
    The above command installs the jiplet container as a Windows service and starts the application.
  7. If you do not want to install the jiplet container as a Windows service but want to just run it, follow steps 1 through 6 and then use the following command:
    C:\> jiplet.bat run
    To terminate the jiplet container, hit the CTRL-C key (press the Control and the C key simultaneously) and answer Y to the prompt "Terminate Batch Job?"

Top

How do I start the jiplet container as a Jboss service?
Before you start the application for the first time, please make sure you have completed the required post-installation steps described above. To start the jiplet container, just start Jboss and it will start up the jiplet service automatically.  The jiplet container is automatically stopped when the Jboss server is shut down. After the initial configuration, you can use the following method to start or stop the jiplet container service without re-starting Jboss.

Jboss also provides a JMX Console for managing services and applications that are deployed. The jiplet container is registered with the Jboss container and can be managed from the JMX console. To bring up the console, open your favorite browser and point to the following URL:

http://$HOST_NAME:8080

where $HOST_NAME is the host name/IP address of the computer. Click on the "JMX Console" hyperlink. You will see a large list of JMX-managed entities. Search for the Jiplet service by entering "org.cafesip.jiplet:*" in the search text field. You will see a list of JMX entities. Click on the "service=Jiplet" hyper-link. From this page, you will be able to invoke the start() and stop() methods by clicking on the desired "invoke" button. 

Top

How do I uninstall the standalone Jiplet Container?
For Redhat Linux or Fedora Linux:
  1. Login as the super-user and enter the following commands.
  2. # /sbin/chkconfig --level 2345 jiplet off
  3. # /sbin/chkconfig --del jiplet
  4. Delete the directory where you installed the jiplet container.
  5. If you installed the jiplet console, remove the application by deleting the directory and file "jiplet-console" and "jiplet-console.war" respectively from the $TOMCAT_HOME/webapps directory where $TOMCAT_HOME is the directory where Tomcat is installed. Restart Tomcat.
For Microsoft Windows:
  1. Login to the system as a user with administrator privilege.
  2. Open a DOS terminal (command prompt) and run the following commands:
  3. C:\> set JIPLET_HOME=C:\jiplet-standalone
    Please change the C:\jiplet-standalone above to wherever you installed the jiplet container.
  4. C:\> set JAVA_HOME=C:\jdk1.5.0_06
    Please change the C:\jdk1.5.0_06 above to point to the location where you have the Java Runtime Environment (JRE) installed.
  5. C:\> cd %JIPLET_HOME%\bin
  6. C:\> jiplet.bat remove
    The above command will stop the jiplet container and remove the application from being a system service.
  7. Delete the directory where you installed the jiplet container.
  8. If you installed the jiplet console, remove the application by deleting the directory and file "jiplet-console" and "jiplet-console.war" respectively from the $TOMCAT_HOME/webapps directory where $TOMCAT_HOME is the directory where Tomcat is installed. Restart Tomcat.

Top

How do I uninstall the Jboss jiplet container?
Simply remove the directory and the file jiplet-service.sar and jiplet-console.war from the Jboss deployment directory.

Top

How do I know if the jiplet container is running?
If you are running the standalone Jiplet container as a standalone application, you need to do the following:

For Microsoft Windows, login as the system administrator, and bring up the task manager (press CTRL-ALT-DEL and click on the Task Manger button).  From the Task Manager, select the  Processes tab. Scroll through the list of processes. If you started the jiplet container as a Windows service,  you should see a process called "jiplet" in the list if the jiplet container is running. If you are just running the jiplet container, you should see a process called "java".

For Unix/Linux systems, from a command line, enter the command:

# ps -ef | grep Main | grep -v grep

You should see an entry for the standalone jiplet process. If the command returns a blank response, it means that the application is not running.

If you are running the jiplet container as a Jboss service, you need to do the following:
open your favorite browser and point to the following URL:

http://$HOST_NAME:8080

where $HOST_NAME is the host name/IP address of the computer. Click on the "JMX Console" hyperlink. You will see a large list of JMX-managed entities. Search for the Jiplet service by entering "org.cafesip.jiplet:*" in the search text field. If you see an entry in the list called type=JipletContainer, the application is running.
 

How do I troubleshoot problems?
The jiplet container prints debug, informational, warning, error and fatal error messages. By default, messages with severity level informational and above are stored.

For the standalone jiplet container, you can find the logs in the directory $JIPLET_HOME/logs. If you want to see debug messages, you need to modify the $JIPLET_HOME/conf/log4j.xml file. Modify the section shown below and restart the application:

<category name="jiplet">
    <!-- The default setting is inform, modify it to debug to see debug messages -->
    <priority value ="debug"/>
    <appender-ref ref="rollingAppender"/> 
  </category>  

When running as a Jboss service, the logs are stored in your Jboss deployment log directory ($JBOSS_HOME/server/$RUN/logs). To modify the settings to view debug messages, you need to modify the Jboss logging service configuration. For details, see Jboss documentation,

Hopefully, you will be able to decipher the messages and correct the problem. If you are seeing error messages that you do not understand, please use the support resources for the jiplet container to get help.


How would I know that the jiplet container is functioning properly?
When you install the jiplet container, it does not come with a default jiplet application. CafeSip.org provides a reference jiplet application that you can download from the CafeSip.org download site and deploy to test out the functionality. Read the Reference Application Howto for description on how to deploy a jiplet application.  The reference application provides the functionality of a minimal feature SIP redirect server. You can use a standard SIP phone and connect to the server.

What else do I need to know?
You need to understand how to deploy and undeploy jiplet applications and configure the jiplet container. For more details on that topic, click here.

Search this website 


Send questions or comments about this web site to webmaster@cafesip.org.
Copyright © 2005, CafeSip.org.
Licensed under the CafeSip License.
The CafeSip.org projects, web site and web facilities have been sponsored by QUIK Computing

Top of page