Installing the Classes


Installing the provided classes is different for UNIX and Windows platforms. The following sections detail how to install the TIBCO Enterprise Message Service management classes into the TIBCO Hawk agent for each platform.

These instructions are specific to TIBCO Hawk Release 4.1.0 or later. Earlier versions of TIBCO Hawk have a different mechanism for adding plugins. Refer to your TIBCO Hawk documentation for details on installing plugins, if you are using an earlier version of TIBCO Hawk.

Windows Installation

To install the provided classes for use in a TIBCO Hawk agent running on a Windows platform, perform the following:

  1. Locate the tibemsadmin.hma file in the TIBCO Enterprise Message Service installation directory under the samples\admin\hawk subdirectory and copy it into your TIBCO Hawk plugins directory.
  2. Usually, a TIBCO Hawk plugins directory is located in c:\tibco\hawk\plugins.

  3. When using Hawk earlier than 4.5, locate jms.jar and tibjms.jar in the clients\java subdirectory, and copy them into the TIBCO Hawk plugins directory.
  4. For all Hawk versions, locate tibjmsadmin.jar in the clients\java subdirectory, and copy it into the TIBCO Hawk plugins directory.
  5. Open the TIBCO Hawk Configuration Utility and make certain the plugins directory is set to the location where you have installed TIBCO Hawk plugins. To set the plugins directory, click the Agent tab, then set the Plugins Directory field to the location where the plugins are located.
  6. For more information about using the TIBCO Hawk Configuration Utility, see TIBCO Hawk Installation and Configuration.

  7. Navigate to your plugins directory and open the tibemsadmin.hma file in a text editor.
  8. Specify the TIBCO Hawk microagent class you wish to use in the <classname> element. You can use either the HawkListener class if you only want to monitor the server, or you can specify the HawkController class if you want to monitor and manage the server.
  9. Specify the username and password and server URL to use to connect to the TIBCO Enterprise Message Service server in the appropriate <arg> elements. See Table 49.
  10. For example:

          <arguments> 
             <arg>-user</arg> 
             <arg>admin</arg> 
             <arg>-password</arg> 
             <arg>admin_pass</arg> 
             <arg>-server</arg> 
             <arg>tcp://server1.yourcompany.com:7222</arg> 
             <arg>-timeout</arg> 
             <arg>5</arg> 
          </arguments> 
     

    You should use specify the predefined admin user or a user that is a member of the $admin group.

  11. Restart the TIBCO Hawk agent service. See the TIBCO Hawk documentation for more information about restarting the service.

UNIX Installation

To install these classes for use in a TIBCO Hawk Agent running on a UNIX platform, perform the following procedure:

  1. Locate the tibemsadmin.hma file in the TIBCO Enterprise Message Service installation directory under the samples/hawk subdirectory and copy it into your TIBCO Hawk plugins directory.
  2. Usually, a TIBCO Hawk plugins directory is located in /usr/tibco/hawk/plugins.

  3. When using Hawk earlier than 4.5, locate jms.jar and tibjms.jar in the clients/java subdirectory, and copy them into the TIBCO Hawk plugins directory.
  4. For all Hawk versions, locate tibjmsadmin.jar in the clients/java subdirectory, and copy it into the TIBCO Hawk plugins directory.
  5. Edit the TIBCO Hawk hawkagent.cfg file and specify the -hma_plugin_dir option to include the directory where your TIBCO Hawk plugins are located.
  6. For more information about editing TIBCO Hawk configuration files on UNIX, see TIBCO Hawk Installation and Configuration.

  7. Navigate to your plugins directory and open the tibemsadmin.hma file in a text editor.
  8. Specify the TIBCO Hawk microagent class you wish to use in the <classname> element. You can use either the HawkListener class if you only want to monitor the server, or you can specify the HawkController class if you want to monitor and manage the server.
  9. Specify the username and password and server URL to use to connect to the TIBCO Enterprise Message Service server in the appropriate <arg> elements. See Table 49.
  10. For example:

          <arguments> 
             <arg>-user</arg> 
             <arg>admin</arg> 
             <arg>-password</arg> 
             <arg>admin_pass</arg> 
             <arg>-server</arg> 
             <arg>tcp://server1.yourcompany.com:7222</arg> 
             <arg>-timeout</arg> 
             <arg>5</arg> 
          </arguments> 
     

    You should use specify the predefined admin user or a user that is a member of the $admin group.

Parameters

Table 49 TIBCO Hawk MicroAgent Parameters (Sheet 1 of 2)
Parameter
Description
-user
-password
The MicroAgent identifies itself with this user name and password when it connects to the EMS server.
When absent, the default user name is admin. When absent, the default password is the empty string.
-user
-encryptedPassword
To use an encrypted password, specify this pair. As the value for -encryptedPassword, supply the output you obtain by running the Hawk utility program tibhawkpassword (which encrypts your password).
-server
The MicroAgent connects to the EMS server at this URL (host computer and port). When absent, the default is tcp://localhost:7222.
-timeout
Limits the time (in seconds) that the MicroAgent waits for the EMS server to respond to queries.
Acceptable values are in the range [5, 3600]. When absent, the default is 60.


TIBCO Enterprise Message Service™ User’s Guide
Software Release 4.3, February 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com