org.opennms.netmgt.config
Interface CapsdConfig

All Known Implementing Classes:

CapsdConfigManager, DefaultCapsdConfigManager

public interface CapsdConfig

CapsdConfig interface.

Version:

$Id: $

Author:

ranger

Field Summary

static int

LAME_SNMP_HOST_IFINDEX This integer value is used to represent the primary snmp interface ifindex in the ipinterface table for SNMP hosts that don't support the MIB2 ipAddrTable

Method Summary

void	addProtocolPlugin(ProtocolPlugin plugin) addProtocolPlugin
InetAddress	determinePrimarySnmpInterface(List<InetAddress> addressList, boolean strict) determinePrimarySnmpInterface
boolean	getAbortProtocolScansFlag() Defines Capsd's behavior when, during a protocol scan, it gets a java.net.NoRouteToHostException exception.
CapsdConfiguration	getConfiguration() Return the Capsd configuration object.
List<String>	getConfiguredProtocols() getConfiguredProtocols
boolean	getDeletePropagationEnabled() getDeletePropagationEnabled
long	getInitialSleepTime() getInitialSleepTime
int	getMaxRescanThreadPoolSize() getMaxRescanThreadPoolSize
int	getMaxSuspectThreadPoolSize() getMaxSuspectThreadPoolSize
List<Property>	getPluginProperties(ProtocolPlugin plugin) getPluginProperties
List<Property>	getProtocolConfigurationProperties(ProtocolConfiguration pluginConf) getProtocolConfigurationProperties
List<ProtocolConfiguration>	getProtocolConfigurations(ProtocolPlugin plugin) getProtocolConfigurations
ProtocolPlugin	getProtocolPlugin(String svcName) getProtocolPlugin
List<ProtocolPlugin>	getProtocolPlugins() getProtocolPlugins
List<Range>	getRanges(ProtocolConfiguration pluginConf) getRanges
long	getRescanFrequency() getRescanFrequency
SmbAuth	getSmbAuth(String target) Finds the SMB authentication object using the netbios name.
List<String>	getSpecifics(ProtocolConfiguration pluginConf) getSpecifics
String	getXmlrpc() Return the boolean xmlrpc as string to indicate if notification to external xmlrpc server is needed.
boolean	isAddressUnmanaged(InetAddress target) Checks the configuration to determine if the target is managed or unmanaged.
boolean	isXmlRpcEnabled() isXmlRpcEnabled
void	save() Saves the current in-memory configuration to disk and reloads

Field Detail

LAME_SNMP_HOST_IFINDEX

static final int LAME_SNMP_HOST_IFINDEX

This integer value is used to represent the primary snmp interface ifindex in the ipinterface table for SNMP hosts that don't support the MIB2 ipAddrTable

See Also:

Constant Field Values

Method Detail

save

void save()
          throws org.exolab.castor.xml.MarshalException,
                 IOException,
                 org.exolab.castor.xml.ValidationException

Saves the current in-memory configuration to disk and reloads

Throws:

org.exolab.castor.xml.MarshalException - if any.

IOException - if any.

org.exolab.castor.xml.ValidationException - if any.

getConfiguration

CapsdConfiguration getConfiguration()

Return the Capsd configuration object.

Returns:

a CapsdConfiguration object.

getSmbAuth

SmbAuth getSmbAuth(String target)

Finds the SMB authentication object using the netbios name. The target of the search.

Parameters:

target - a String object.

Returns:

a SmbAuth object.

isAddressUnmanaged

boolean isAddressUnmanaged(InetAddress target)

Checks the configuration to determine if the target is managed or unmanaged.

Parameters:

target - The target to check against.

Returns:

a boolean.

getRescanFrequency

long getRescanFrequency()

getRescanFrequency

Returns:

a long.

getInitialSleepTime

long getInitialSleepTime()

getInitialSleepTime

Returns:

a long.

getMaxSuspectThreadPoolSize

int getMaxSuspectThreadPoolSize()

getMaxSuspectThreadPoolSize

Returns:

a int.

getMaxRescanThreadPoolSize

int getMaxRescanThreadPoolSize()

getMaxRescanThreadPoolSize

Returns:

a int.

getAbortProtocolScansFlag

boolean getAbortProtocolScansFlag()

Defines Capsd's behavior when, during a protocol scan, it gets a java.net.NoRouteToHostException exception. If abort rescan property is set to "true" then Capsd will not perform any additional protocol scans.

Returns:

a boolean.

getDeletePropagationEnabled

boolean getDeletePropagationEnabled()

getDeletePropagationEnabled

Returns:

a boolean.

getXmlrpc

String getXmlrpc()

Return the boolean xmlrpc as string to indicate if notification to external xmlrpc server is needed.

Returns:

boolean flag as a string value

isXmlRpcEnabled

boolean isXmlRpcEnabled()

isXmlRpcEnabled

Returns:

a boolean.

getProtocolPlugin

ProtocolPlugin getProtocolPlugin(String svcName)

getProtocolPlugin

Parameters:

svcName - a String object.

Returns:

a ProtocolPlugin object.

addProtocolPlugin

void addProtocolPlugin(ProtocolPlugin plugin)

addProtocolPlugin

Parameters:

plugin - a ProtocolPlugin object.

determinePrimarySnmpInterface

InetAddress determinePrimarySnmpInterface(List<InetAddress> addressList,
                                          boolean strict)

determinePrimarySnmpInterface

Parameters:

addressList - a List object.

strict - a boolean.

Returns:

a InetAddress object.

getConfiguredProtocols

List<String> getConfiguredProtocols()

getConfiguredProtocols

Returns:

a List object.

getProtocolPlugins

List<ProtocolPlugin> getProtocolPlugins()

getProtocolPlugins

Returns:

a List object.

getProtocolConfigurations

List<ProtocolConfiguration> getProtocolConfigurations(ProtocolPlugin plugin)

getProtocolConfigurations

Parameters:

plugin - a ProtocolPlugin object.

Returns:

a List object.

getSpecifics

List<String> getSpecifics(ProtocolConfiguration pluginConf)

getSpecifics

Parameters:

pluginConf - a ProtocolConfiguration object.

Returns:

a List object.

getRanges

List<Range> getRanges(ProtocolConfiguration pluginConf)

getRanges

Parameters:

pluginConf - a ProtocolConfiguration object.

Returns:

a List object.

getPluginProperties

List<Property> getPluginProperties(ProtocolPlugin plugin)

getPluginProperties

Parameters:

plugin - a ProtocolPlugin object.

Returns:

a List object.

getProtocolConfigurationProperties

List<Property> getProtocolConfigurationProperties(ProtocolConfiguration pluginConf)

getProtocolConfigurationProperties

Parameters:

pluginConf - a ProtocolConfiguration object.

Returns:

a List object.