de.mud.jta

Class Plugin

java.lang.Object

de.mud.jta.Plugin

Direct Known 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

Fields

Modifier and Type	Field and Description
protected PluginBus	bus holds the plugin bus used for communication between plugins
protected java.lang.String	id in case we have several plugins of the same type this contains their unique id

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	error(java.lang.String msg) Print an error message to stderr prepending the plugin name.
java.lang.String	getId() Return identifier for this plugin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bus

protected PluginBus bus

holds the plugin bus used for communication between plugins

id

protected java.lang.String id

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

Constructor Detail

Plugin

public Plugin(PluginBus bus,
      java.lang.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 Detail

getId

public java.lang.String getId()

Return identifier for this plugin.

Returns:

id string

error

public void error(java.lang.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