org.opennms.netmgt.config
Interface LinkdConfig

All Known Implementing Classes:

LinkdConfigFactory, LinkdConfigManager

public interface LinkdConfig

Author:

Mathew Brozowski TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Method Summary

boolean	autoDiscovery()
void	createPackageIpListMap()
boolean	enableDiscoveryDownload()
boolean	enableVlanDiscovery()
Enumeration	enumeratePackage()
List	getAllPackageMatches(String ipAddr) Returns true if the ip is part of atleast one package.
String	getClassName(String sysoid)
LinkdConfiguration	getConfiguration()
DiscoveryLink	getDiscoveryLink(String pkgName)
long	getDiscoveryLinkInterval()
Package	getFirstPackageMatch(String ipaddr) Returns the first package that the ip belongs to, null if none.
long	getInitialSleepTime()
List	getIpList(Package pkg) Determine the list of IPs the filter rule for this package allows
Package	getPackage(String pkgName)
SnmpCollection	getSnmpCollection(String ipaddr, String sysoid, String pkgName)
List<SnmpCollection>	getSnmpCollections(String ipaddr, String sysoid)
long	getSnmpPollInterval()
int	getThreads()
boolean	hasClassName(String sysoid)
boolean	interfaceInPackage(String iface, Package pkg) This method is used to determine if the named interface is included in the passed package definition.
boolean	interfaceInPackageRange(String iface, Package pkg) This method is used to determine if the named interface is included in the passed package definition.
void	save()
boolean	saveRouteTable()
boolean	saveStpInterfaceTable()
boolean	saveStpNodeTable()
void	update()
boolean	useBridgeDiscovery()
boolean	useCdpDiscovery()
boolean	useIpRouteDiscovery()

Method Detail

getIpList

List getIpList(Package pkg)

Determine the list of IPs the filter rule for this package allows

Parameters:

pkg -

Returns:

interfaceInPackage

boolean interfaceInPackage(String iface,
                           Package pkg)

This method is used to determine if the named interface is included in the passed package definition. If the interface belongs to the package then a value of true is returned. If the interface does not belong to the package a false value is returned. Note: Evaluation of the interface against a package filter will only work if the IP is already in the database.

Parameters:

iface - The interface to test against the package.

pkg - The package to check for the inclusion of the interface.

Returns:

True if the interface is included in the package, false otherwise.

interfaceInPackageRange

boolean interfaceInPackageRange(String iface,
                                Package pkg)

This method is used to determine if the named interface is included in the passed package definition. If the interface belongs to the package then a value of true is returned. If the interface does not belong to the package a false value is returned. Note: Evaluation of the interface against a package filter will only work if the IP is already in the database.

Parameters:

iface - The interface to test against the package.

pkg - The package to check for the inclusion of the interface.

Returns:

True if the interface is included in the package, false otherwise.

getFirstPackageMatch

Package getFirstPackageMatch(String ipaddr)

Returns the first package that the ip belongs to, null if none. Note: Evaluation of the interface against a package filter will only work if the IP is alrady in the database.

Parameters:

ipaddr - the interface to check

Returns:

the first package that the ip belongs to, null if none

getAllPackageMatches

List getAllPackageMatches(String ipAddr)

Returns true if the ip is part of atleast one package. Note: Evaluation of the interface against a package filter will only work if the IP is alrady in the database.

Parameters:

ipaddr - the interface to check

Returns:

true if the ip is part of atleast one package, false otherwise

enumeratePackage

Enumeration enumeratePackage()

getPackage

Package getPackage(String pkgName)

getThreads

int getThreads()

enableDiscoveryDownload

boolean enableDiscoveryDownload()

useIpRouteDiscovery

boolean useIpRouteDiscovery()

saveRouteTable

boolean saveRouteTable()

useCdpDiscovery

boolean useCdpDiscovery()

useBridgeDiscovery

boolean useBridgeDiscovery()

saveStpNodeTable

boolean saveStpNodeTable()

saveStpInterfaceTable

boolean saveStpInterfaceTable()

getInitialSleepTime

long getInitialSleepTime()

getSnmpPollInterval

long getSnmpPollInterval()

getDiscoveryLinkInterval

long getDiscoveryLinkInterval()

autoDiscovery

boolean autoDiscovery()

enableVlanDiscovery

boolean enableVlanDiscovery()

update

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

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

save

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

Throws:

org.exolab.castor.xml.MarshalException

IOException

org.exolab.castor.xml.ValidationException

getConfiguration

LinkdConfiguration getConfiguration()

getSnmpCollections

List<SnmpCollection> getSnmpCollections(String ipaddr,
                                        String sysoid)

getSnmpCollection

SnmpCollection getSnmpCollection(String ipaddr,
                                 String sysoid,
                                 String pkgName)

getDiscoveryLink

DiscoveryLink getDiscoveryLink(String pkgName)

createPackageIpListMap

void createPackageIpListMap()

getClassName

String getClassName(String sysoid)

hasClassName

boolean hasClassName(String sysoid)