Open Source Toolkit Documentation:

The Hub Visualization Server

License / Documentation home / Help and feedback

This tool supports the API for remote Hub displays (see the -gui argument of the Hub executable). This tool is under active development.

Status
Usage
Message set
Messages issued
Known bugs

Status

History and plans

This tool was originally developed as part of a demonstration of the capabilities of the Galaxy Communicator infrastructure.

Version history

0.1 on 1/25/02
0.2 on 4/19/02
1.0 on 8/23/02

Usage

Unix

% <OSTK_ROOT>/bin/hub_gui ...

Windows

This server requires JDK 1.4 on Windows.

GC_HOME must be set in your environment.

To compile, make sure that JDK_HOME (a directory above bin\javac and bin\jar) is also set in your environment and run build.bat in utilities\hub_gui\src.

To run, this command line assumes that OSTK is also set, and that Java is in your path.

C:\> java.exe -classpath %GC_HOME%\contrib\MITRE\bindings\java\lib\galaxy.jar;%OSTK%\utilities\hub_gui\src\visualizer.jar org.mitre.galaxycommunicator.visualizer.VisualizerMainServer ...

Default port

1201

Command line arguments

-hub <Hub executable>            The path to the Hub to use.
-pgm_file <file name>            Hub program file to use.
-locations <server info>         The Hub -locations argument.
-init <init info>                The Hub -init argument.
-debug                           Start the Hub in debug mode.
-hub_verbosity <verbosity level> The Hub verbosity level.
-props <file name>               Custom properties file to use. See the default properties for an example.
-use_hub_output_dialog           Indicates that a separate dialog window should be used to display normal Hub output.
-use_hub_status_dialog           Indicates that a separate dialog window should be used to display Hub status output.

This server also accepts the standard server arguments. See the Galaxy Communicator Java binding documentation for details on the standard command-line arguments.

Runtime notes

You can run the visualizer in two modes.

If you provide the -hub argument, the visualizer will be able to start up the Hub for you, and ensure that the Hub contacts the visualizer. If you use this argument, the Hub will also capture whatever Hub output isn't routed to the GUI. You should use the -pgm_file argument and the other optional arguments which are relayed to the Hub to control the Hub's behavior, or you can use the File and Controls menus to control the Hub's behavior.

If you don't provide the -hub argument (or if you do and choose not to start the Hub that way), you'll need to pass the location of the visualizer to the Hub, wherever you start it, using the -gui argument to the Hub. The Hub's extra output will not be captured in this case.

When you start up the visualizer, you get a window which, by default, is organized as follows:

The menu bar at the top has three menus, File, Control and Graphics. The first two control the arguments to the Hub executable, while the third controls the graphic display of the visualizer. The Hub can add menus to this menu bar by using the Builtin.hub_gui_notify message to relay an add_menu_items message to the visualizer.
The pane immediately below the menu bar is the Hub graphics pane. It has a large red circle entitled Hub (red indicates that it's not running).
The pane immediately below the Hub display is entitled "Hub Output". This pane shows the Hub output captured by the visualizer when it's used to start up the Hub. There are buttons immediately below to close and clear this pane.
The pane immediately below the Hub output pane is entitled "Hub Status". This pane describes the messages which the visualizer receives which aren't displayed in the graphical display.

When the Hub starts up and contacts the visualizer, the Hub notifies the visualizer of all the known service providers, and the visualizer illustrates these servers in the Hub graphics pane. When the Hub node is green, it's running; when it's red, it's not. When a provider node is connected to the Hub node via a line, the provider is connected; when the line vanishes, the provider is not connected. If providers contact the Hub, they'll appear in the Hub graphics pane, and vanish when the provider vanishes. When messages are sent between the Hub and servers, arrows appear parallel to the line joining the two.

Message set

See the sample Hub GUI documentation in the Galaxy Communicator core distribution.

Messages issued