Extension Swiftlets

 
 

Online Documentation    Extension Swiftlets

 
 

[Introduction]     [Installation]     [Removal]    
[Document Index]

 
     
 
  Introduction

Extension Swiftlets extend the functionality of a SwiftMQ router and are hot plug-in components. The SwiftMQ kernel and the respective Extension Swiftlets are offered in separate release lines and are to be installed separately. Thus, the release-frequency of the kernels is obviously reduced. New functionalties may be added to the router simply as an Extension Swiftlet.

Installation

Extension Swiftlets are delivered as independent distributions. Generally, the distributions of the Extension Swiftlets contain CLI scripts for installation and de-installation. Please have a look at the enclosed documentation.

Extension Swiftlets may be installed manually by CLI, SwiftMQ Explorer, and by the Router Configuration File. Please make sure in advance that the jar file of the Extension Swiftlets may be referenced by the CLASSPATH of the routers in which you wish to install.

Installation with CLI

The installation is done by the add commands. The command format is the following:


 add <name> class <classname>

Concerning <name>, please fill in the name recommended within the Extension Swiftlet documentation. Extension Swiftlet names should always begin with "xt$", e. g. "xt$bridge" for the JMS Bridge. Concerning <classname>, please fill in the name of the class of the Extension Swiftlets, e. g. "com.swiftmq.extension.bridge.BridgeSwiftlet".

The Extension Swiftlet is installed after performing the commands and may now be used. Please remember to save the router configuration using the command "save", because otherwise the installation will not outlast the next reboot.

Example for the installation of the JMS Bridge Extension Swiftlets with CLI:


 > sr router1
 router1> add xt$bridge class com.swiftmq.extension.bridge.BridgeSwiftlet
 router1> save
 
 Configuration backed up to file '../../conf/smqr1.properties.20001013174821081'.
 
 Configuration saved to file '../../conf/smqr1.properties'.
 
 router1>

Installation with SwiftMQ Explorer

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 (see previous section) is requested. These are to be entered. Now, the Extension Swiftlet is active and may be used.



Please remember to save the router configuration.

Installation via the Router Configuration File

The name of the Swiftlets is to be defined as value of the property "swiftlet.names". This property contains a comma-separated list of the Extension Swiftlet names.

Example (JMS Bridge):


 swiftlet.names=xt$bridge

Furthermore, the class name of the Extension Swiftlets is to be defined by the property "swiftlet.<name>.class".


Example (JMS Bridge):


 swiftlet.xt$bridge.class=com.swiftmq.extension.bridge.BridgeSwiftlet

Removal

While operating, Extension Swiftlets may be removed manually by CLI, SwiftMQ Explorer, the Router Configuration File or by the CLI script corresponding to the respective distribution.

Remove with CLI

The removal takes place using the remove command. The format of the command is the following:


 remove <name>

On execution of the command the Extension Swiftlet is de-installed and may no longer be used. Please remember to save the router configuration by the command "save", otherwise the de-installation will not outlast the next reboot.

Examples to the de-installation of the JMS Bridge Extension Swiftlets with CLI:


 router1> remove xt$bridge
 router1> save
 
 Configuration backed up to file '../../conf/smqr1.properties.20001013184449794'.
 
 Configuration saved to file '../../conf/smqr1.properties'.
 
 router1>

Removal with SwiftMQ Explorer

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.



Subsequently, the Extension Swiftlet is de-installed.

Please remember to save the router configuration.

Removal by the router configuration file

Remove the name of the Extension Swiftlets out of the property list "swiftlet.names".

 
 
     
 

[Introduction]     [Installation]     [Removal]    
[Document Index]

 
 

Online Documentation    Extension Swiftlets

 
 

 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.