org.friendlysnmp.plugin

Class FPlugin

java.lang.Object

org.friendlysnmp.plugin.FPlugin

Direct Known Subclasses:

PluginCore

public abstract class FPlugin
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected AgentWorker	agent SNMP agent.
protected BaseMib	mibBase

Constructor Summary

Constructors

Constructor and Description
FPlugin(BaseMib mib)

Method Summary

Modifier and Type	Method and Description
BaseMib	getMib()
abstract void	initPlugin() The agent calls this method to initialize plugin.
void	loadDefaultProperties() The agent calls this method to load plugin specific default properties.
protected void	loadDefaultProperty(java.lang.String key, java.lang.String value) Call this method in the derived class in the overriden method loadDefaultProperties().
void	setAgent(AgentWorker agent)

Methods inherited from class java.lang.Object

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

Field Detail

mibBase

protected BaseMib mibBase

agent

protected AgentWorker agent

SNMP agent.

Constructor Detail

FPlugin

public FPlugin(BaseMib mib)

Method Detail

getMib

public BaseMib getMib()

setAgent

public void setAgent(AgentWorker agent)

initPlugin

public abstract void initPlugin()
                         throws FException

The agent calls this method to initialize plugin.

Throws:

FException - failure to init plugin.

loadDefaultProperties

public void loadDefaultProperties()

The agent calls this method to load plugin specific default properties.

loadDefaultProperty

protected void loadDefaultProperty(java.lang.String key,
                                   java.lang.String value)

Call this method in the derived class in the overriden method loadDefaultProperties(). The method could be called multiple times (or not at all) to load multiple default properties. The convention for the property keys is "plugin.name.key", where "name" is a plugin name. This naming style eliminates potential keys collisions.

Parameters:

key - key.

value - value.