de.mud.jta

Class Plugin

Known Direct Subclasses:
ButtonBar, Capture, MudConnector, Script, Shell, Sink, Socket, SSH, Status, Telnet, Terminal, Timeout, URLFilter

public class Plugin
extends java.lang.Object

Plugin base class for the JTA. A plugin is a component for the PluginBus and may occur several times. If we have more than one plugin of the same type the protected value id contains the unique plugin id as configured in the configuration.

Maintainer: Matthias L. Jugel

Version:
$Id: Plugin.java 499 2005-09-29 08:24:54Z leo $
Author:
Matthias L. Jugel, Marcus Mei???ner

Field Summary

protected PluginBus
bus
holds the plugin bus used for communication between plugins
protected String
id
in case we have several plugins of the same type this contains their unique id

Constructor Summary

Plugin(PluginBus bus, String id)
Create a new plugin and set the plugin bus used by this plugin and the unique id.

Method Summary

void
error(String msg)
Print an error message to stderr prepending the plugin name.
String
getId()
Return identifier for this plugin.

Field Details

bus

protected PluginBus bus
holds the plugin bus used for communication between plugins

id

protected String id
in case we have several plugins of the same type this contains their unique id

Constructor Details

Plugin

public Plugin(PluginBus bus,
              String id)
Create a new plugin and set the plugin bus used by this plugin and the unique id. The unique id may be null if there is only one plugin used by the system.
Parameters:
bus - the plugin bus
id - the unique plugin id

Method Details

error

public void error(String msg)
Print an error message to stderr prepending the plugin name. This method is public due to compatibility with Java 1.1
Parameters:
msg - the error message

getId

public String getId()
Return identifier for this plugin.
Returns:
id string