Legacy Communication Made Easy
[ start | index | login ]
start > Configuring Plugins

Configuring Plugins

Created by leo. Last edited by leo, 11 years and 109 days ago. Viewed 50,980 times. #1
[edit] [rdf]
We use a pugin scheme to allow easy addition of software modules to the framework. These plugins may either be used to work on the data streams (Plugin Telnet), display additional information (Plugin Status) to the user or be bywork (Plugin URLFilter).

Standard plugins are provided with the package. These plugins are desribed here.

How the plugins work:

It is important that you understand how the plugins work to configure them correctly. You cannot simply put the plugins in the configuration file in any order; order is important. Imagine the data flowing through the plugins from left to right (from remote computer to user).


WRONG: (Telnet must be between Socket and Terminal)

All plugins that work with the data stream (like Plugin Script) must be between Plugin Socket and Plugin Terminal.

standard plugins:

Plugin SocketA most basic plugin used for low level communication with remote hosts. It almost always needed.
Plugin TelnetThis is the actual handler for telnet type communications. It filters the data streams and handles all telnet options.
Plugin SSHFor more secure communication you would rather use SSH instead of the Telnet plugin as it provides a way for secure communication over insecure networks.
Plugin TerminalThis is a very important plugin as it is the actual terminal so you can see what you do. It implements an ANSI/VT320 compatible terminal emulation.
Plugin ShellA shell plugin for use with local command shells. Not really useful right now.

add-on plugins:

Plugin StatusAn example how to write a listener plugin and display information.
Plugin TimeoutA useful plugin for Applet users. It will allow you to define an idle timeout to close the connection.
Plugin ButtonBarThe new implemenation of our well known button bar module. With new configuration options and better look than ever.
Plugin ScriptThe script plugin may be used to automate login procedures for guest accounts.
Plugin SinkThe Sink plugin is a replacement of the Terminal plugin, which just reads and discard data. Useful if you do not want output.
Plugin URLFilterFilters URLs out of the incoming data and displays a list to open them in a web browser (Applet)
Plugin MudConnectorA special plugin for www.mudconnector.com to display a list of muds to connect to.
Plugin BSXA third party plugin for use with BSX enabled MUDs. It is contained in the contributed package (see download).

More than one plugin with the same name:

To accomplish that we have introduced identifier for the plugins. A normal plugin list would look like:

plugins = Socket,Telnet,ButtonBar,Terminal

If you wanted to set up another button bar you are in trouble because it would read the same options twice. So when setting up two plugins of the same name you do as follows:

plugins = Socket,Telnet,ButtonBar(one),ButtonBar(two),Terminal

You give both plugins a unique name (one and two) and use this name in any following configuration properties:

layout.ButtonBar(one) = North
layout.ButtonBar(two) = South
ButtonBar(one).setup = >>http://server/one.conf
ButtonBar(two).setup = >>http://server/two.conf

And that is it! If you define properties without the unique name they will be used as fallback values in case a needed property is not set for a specific plugin.

Have a look at the applet.conf.

no comments | post comment
legacy communication tools for JAVA(tm)

javassh.org | Copyright 1996-2009 Matthias L. Jugel and Marcus Meißner

JAVA is a trademark or registered trademark of Sun Microsystems, Inc. in the United States and other countries.
The JTA - Telnet/SSH Authors (Matthias L. Jugel and Marcus Meißner) are independent of Sun Microsystems, Inc.