org.opennms.netmgt.capsd

Class CapsdProtocolInfo

java.lang.Object

org.opennms.netmgt.capsd.CapsdProtocolInfo

public final class CapsdProtocolInfo
extends Object

This class is used to encapsulate the basic protocol information read from the config file. The information includes the plugin, the protocol name, the merged parameters to the plugin, and the action to be taken.

Author:

Weave , OpenNMS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapsdProtocolInfo.Action

Constructor Summary

Constructors

Constructor and Description
CapsdProtocolInfo(String proto, Plugin plugin, Map<String,Object> params, CapsdProtocolInfo.Action action) Constructs a new protocol information element.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	getParameters() Returns the input parameters for the plugin
Plugin	getPlugin() Returns the plugin module
String	getProtocol() Returns the protocol name
boolean	isAutoEnabled() Returns true if the configuration has this particular module set as automatically enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

CapsdProtocolInfo

public CapsdProtocolInfo(String proto,
                 Plugin plugin,
                 Map<String,Object> params,
                 CapsdProtocolInfo.Action action)

Constructs a new protocol information element.

Parameters:

proto - The protocol supported.

plugin - The plugin module

params - The parameters for the plugin.

action - The action to take.

Method Detail

getProtocol

public String getProtocol()

Returns the protocol name

Returns:

a String object.

getPlugin

public Plugin getPlugin()

Returns the plugin module

Returns:

a Plugin object.

getParameters

public Map<String,Object> getParameters()

Returns the input parameters for the plugin

Returns:

a Map object.

isAutoEnabled

public boolean isAutoEnabled()

Returns true if the configuration has this particular module set as automatically enabled.

Returns:

a boolean.