C H A P T E R  8

Using the Collaboration Runtime

The Java Studio Enterprise software includes functionality for enterprise collaboration. To enable the collaboration functions in the IDE, install the Collaboration Runtime when you install the IDE and then start the Collaboration Runtime.



Note - The Developer Collaboration feature requires communication with the server on a specific port. If you use a firewall, be sure to allow outgoing traffic from the IDE to that port on the Instant Messaging (IM) server.

The IDE supports connection to an IM server using an HTTP proxy, but not the use of an HTTPS proxy that requires authentication. To find the port that the server expects to use for communication, see Finding and Changing the Collaboration Runtime Port.



This chapter covers the following topics:


Starting the Collaboration Runtime

Start the Collaboration Runtime from the Start Menu (Windows) or the command line (Solaris OS). The Collaboration Runtime is configured to start automatically when a Microsoft Windows system is started. You can change this configuration using the Microsoft Windows Control Panel. See Configuring the Collaboration Runtime Service (Microsoft Windows).


procedure icon  (Microsoft Windows Platform) To Start the Collaboration Runtime

single-step bulletChoose Start right arrow Programs right arrow Sun Microsystems right arrow Java Studio Enterprise 8.1 right arrow Collaboration Runtimeright arrow Start Collaboration Runtime


procedure icon  (Solaris OS and Linux Platforms) To Start the Collaboration Runtime

1. If you installed the Collaboration Runtime as root, log in as root.

2. Change to the installation directory that contains the executable.


% cd java-studio-install-dir/collab/bin 

3. Start the Collaboration Runtime process.


% ./xmppd start 


Configuring the Collaboration Runtime Service (Microsoft Windows)

The Collaboration Runtime is installed as a Microsoft Windows service. The default setting automatically starts the Collaboration Runtime when your Windows system starts.


procedure icon  To Configure the Collaboration Runtime Service

1. From the Control Panel, open Administrative Tools, and then Services.

2. Right-click the entry labeled Collaboration Runtime Service.

This is the default service name for the Collaboration Runtime. It might differ if you specified another name for the Collaboration Runtime service during the installation of the Java Studio Enterprise. See To Continue an Installation With a Preinstalled Application Server.

3. From the contextual menu, choose Properties.

4. In the Properties dialog box, on the General tab, define the type of startup for the service by selecting one of the values from the Startup type drop-down list.

The default Startup type is Automatic, which means that the service starts when Windows starts.


Changing the Collaboration Logging Options


procedure icon  To Change the Collaboration Logging Options

To assist you with troubleshooting, you can turn on debug logging for the Collaboration Runtime.

1. Locate the Collaboration Runtime configuration file at:

java-studio-install-dir/collab/config/xmppd.conf

2. To turn on debug logging, open the configuration file in a text editor and set

iim.log.iim_server.severity=DEBUG

You can find the log file (xmppd.log) in the following location:

java-studio-install-dir/collab/log/


Stopping the Collaboration Runtime


procedure icon  (Microsoft Windows Platform) To Stop the Collaboration Runtime

single-step bulletChoose Start right arrow Programs right arrow Sun Microsystems right arrow Java Studio Enterprise 8.1 right arrow Collaboration Runtimeright arrow Stop Collaboration Runtime


procedure icon  (Solaris OS and Linux Platforms) To Stop the Collaboration Runtime

1. Change to the installation directory that contains the executable.


% cd java-studio-install-dir/collab/bin 

2. Stop the Collaboration Runtime process.


% ./xmppd stop 


Finding and Changing the Collaboration Runtime Port


procedure icon  To Find and Change the Collaboration Runtime Port

1. Stop the Collaboration Runtime.

2. Open the java-studio-install-dir/collab/config/xmppd.conf file in a text editor.

The line that starts with iim_server.port= specifies the Collaboration Runtime port.

3. To change the port, enter a new value for the iim_server.port variable and save your changes.

For example:

iim_server.port=5225

4. Start the Collaboration Runtime.

The Collaboration Runtime now runs in the port you specified.