SwiftMQ Explorer User's Guide

 
 

Online Documentation    SwiftMQ Explorer User's Guide

 
 

[General]     [Starting SwiftMQ Explorer]     [Connecting a Router Network]     [Disconnecting a Router Network]     [Management Tree]     [Creating new Entities]     [Deleting Entities]     [Showing Entity Tables]     [Usage Lists/Activity Charts]     [Changing Properties]     [Halting a Router]     [Rebooting a Router]     [Saving a Router's Configuration]     [Adding Extension Swiftlets]     [Removing Extension Swiftlets]     [Displaying the Router Environment]     [Changing the Routername]    
[Document Index]

 
     
 
  General

SwiftMQ Explorer is a graphical administration tool for SwiftMQ router networks. If offers the same functions as CLI, but is much more comfortable to operate.

In addition to CLI, changes are reported asynchronous to the SwiftMQ Explorer in the status of the respective router by so-called management messages. Therefore a current image of the router network status is always displayed.

Like CLI, SwiftMQ Explorer is based on the Property Configuration Files of the respective router.

Starting SwiftMQ Explorer

The SwiftMQ Explorer can be started by the platform specific scripts provided in the scripts directory of the SwiftMQ distribution or by the following command:


 java com.swiftmq.admin.explorer.Explorer

After starting, the SwiftMQ Explorer displays a main frame and a so-called navigator frame. The main frame is for connecting/disconnecting to/from a router network, for window arrangement and help functions. The navigator frame displays all routers of a connected router network with their management trees. All configuration task are to be performed via the navigator frame through popup menus, available on the various tree nodes on right-button mouse clicks.

Connecting a Router Network

To administer a router network, any given router of the network can be connected. After the connection setup, all routers of this network are available and are shown as a node in the navigator frame.

For the connection setup choose the entry "Connect..." in the menu "Connection" in the main frame. Now the following window is displayed:



SwiftMQ Explorer connects to a router via JMS and so, like any other JMS application, executes a JNDI-Lookup on a QueueConnectionFactory. For this, the JNDI-Provider-URL and the name of the QueueConnectionFactory needs to be given.

The indicated input fields are to be filled in as follows:

JNDI-Provider-URL:

The SMQP-URL of the respective JMS listeners by which the connection should be made. The assignment of the input field points at the JMS listener of the example configuration at router1.

The format of an SMQP-URL is the following:


 smqp://[<user>[:<password>]@]<host>:<port>[/[type=<type>][;timeout=<long>][;compress=<boolean>]

Where


 smqp ::= Specifies the SwiftMQ Protocol
 <user> ::= Username. Default is 'anonymous'
 <password> ::= User's password. Default is null.
 <host> ::= DNS hostname of the router
 <port> ::= JMS inbound listener port
 type ::= Class name of the socket factory used by this JMS inbound listener.
  In this release, com.swifmq.net.PlainSocketFactory and
  com.swiftmq.net.JSSESocketFactory are available. Default is
  com.swifmq.net.PlainSocketFactory. See JMSSwiftlet configuration for details.
 timeout ::= Specifies a timeout in milliseconds for lookups. If no JNDI object is
  received within this time, the lookup returns null. Default is no timeout;
  lookups are waiting until they receive the requested JNDI objects.
 compress ::= Specifies if the specific JMS connection has line compression. Default is
  no compression.

Name Queue Connection Factory:

Here you can specify the name of the QueueConnectionFactory on which a JNDI-Lookup should result. The field default is "QueueConnectionFactory" which is pre-configurated in the example configuration.

Username:

The user name on which the QueueConnection is established by the demanded QueueConnectionFactory. This user needs to have a send grant on the queue "swiftmqmgmt" on all routers belonging to the router network. The grants are to be determined for the router by which the connection takes place. In the example configuration the user "admin" is pre-configurated with these grants for the queues "swiftmqmgmt@router1" and "swiftmqmgmt@router2".

Password:

The password of the user. If the pre-configurated user "admin" is used, the password is "secret".

Disconnecting a Router Network

To close the connection to a router network, choose "Disconnect..." in the menu "Connection" (or "Exit", then the SwiftMQ Explorer will also be closed).

It is to be considered that changes are not saved automatically. All implemented changes are saved directly in the routers and are written in the respective Property Configuration File at execution of the respective save command. So it is quite possible to connect again and then save the changes.

Management Tree

All network routers in the navigator frame are shown as a node after a successful connection setup:



After opening the node, the management tree of the router is shown. On the upper level it contains the router environment and the swiftlets of the router. Every swiftlet contains at least the swiftlet meta data as well as possibly further swiftletspecific entities, entity lists, and properties.

Creating new Entities

It is possible to generate new entities concerning nodes representing an entity list if this entity list offers this command. To do so, select the concerning node of the entity list and call the popup-menu by clicking the right mouse button.

The following example demonstrates the generation of a new JMS listener:

First, the node "Listeners" of the JMS swiftlets is selected and the popup-menu is activated:



On execution of "Create a new Entity" an interactive window is displayed as well as the inquiry of the new entity data. Fields, highlited in orange, are to be filled in. Fields, highlited in white are optional:



After the execution, the new entity is shown in the entity list:

Deleting Entities

To delete an entity, please choose it and click the right mouse button. If a popup-menu is offered with the command "Delete Entity", the entity may be deleted, otherwise not.

Example:

Showing Entity Tables

Every entity list may be displayed alternatively as a table. This is done by the popup-menu command "Show Entity Table" of the entity list:



Thereupon the entity list is shown as an entity table:



The toolbar of the entity table makes it possible to insert or delete entities. Furthermore, properties (cells) may be edited directly by double clicking if the properties are not read-only.

Usage Lists/Activity Charts

Active resources of Swiftlets are shown under the entity list "Usage" of the Swiftlet. Usage lists are marked in the navigator frame with or .

An entity table of a usage list got an activity chart as supplement which may be switched on or off by a button.

Example:

Changing Properties

Properties are indicated in the navigator frame with or (read-only). It may be changed by double clicking on the Property if it is not read-only. Now, a window will be displayed by which the value may be changed. Boolean properties are a special case and may be switched on or off directly in the navigator frame by double clicking.

It is also possible to change properties in an entity table. In this case make a double click to the cell and edit there directly.

Halting a Router

The router stops by executing the popup-menu of the respective router node in the navigator frame:



The router waits 10 seconds after executing the command, then it shuts down. The node in the navigator frame disappears.

Rebooting a Router

A router is rebooted by the popup-menu of the respective router node in the navigator frame:



The router waits 10 seconds after executing the command, then it shuts down all swiftlets. The router process will not be closed. After the Swiftlets shutdown, they restart automatically. The node in the navigator frame disappears during the reboot temporarily, then it appears again.

If changes are made concerning the configuration which require a reboot, these changes are active now if the configuration was saved before.

Saving a Router's Configuration

All changes made concerning a router configuration are valid immediately. But they are not persistent, except they are saved explicitly. In this case, the router produces a backup of the existing Property Configuration Files and saves the current configuration in a new file.

To save a router's configuration, execute the appropriate command from the popup-menu of the respective router node in the navigator frame:

Adding Extension Swiftlets

The popup-menu of the respective router node, accessible by clicking the right mouse button, contains an entry "Add a new Extension Swiftlet". This entry is to be selected.



Thereafter, the name and the class name of the Extension Swiftlets is requested (see previous section). These are to be entered. Now, the Extension Swiftlet is active and may be used.



Please remember to save the router configuration.

Removing Extension Swiftlets

The popup-menu of the respective Extension Swiftlets, accessible by clicking the right mouse button, contains an entry "Remove Extension Swiftlet". This entry is to be selected.



Now, the Extension Swiftlet is de-installed.

Please remember to save the router configuration.

Displaying the Router Environment

The navigator frame includes a folder directly below the router node which contains informations concerning the runtime environment of the router:



All pictured properties are read-only, except the router name (see Changing the Routername).

Changing the Routername

Within the folder "Router Environment" of each router is one property "routername" which is not read only. It contains the logical name of the router. This name must be set if multiple routers are running on one host. If this property isn't set, the routername is equal to the DNS name of the host where the router is running on.

Be aware, that changing the routername is - even in a connected router network - a very heavyweight change, because all references to this router (authentication grants, static routes etc) must also be changed. For this reason it is the very best, to give each router per default a logical routername on initial configuration. In this case, there are really minimal changes if, for example, a router is transferred on another physical host or another router is started on the same host.

Example:

 
 
     
 

[General]     [Starting SwiftMQ Explorer]     [Connecting a Router Network]     [Disconnecting a Router Network]     [Management Tree]     [Creating new Entities]     [Deleting Entities]     [Showing Entity Tables]     [Usage Lists/Activity Charts]     [Changing Properties]     [Halting a Router]     [Rebooting a Router]     [Saving a Router's Configuration]     [Adding Extension Swiftlets]     [Removing Extension Swiftlets]     [Displaying the Router Environment]     [Changing the Routername]    
[Document Index]

 
 

Online Documentation    SwiftMQ Explorer User's Guide

 
 

 Copyright © 2000, IIT GmbH, Bremen/Germany. All rights reserved.
SwiftMQ and Swiftlet are registered trademarks of IIT GmbH.
All other product names mentioned herein are trademarks of their respective owners.