org.opennms.netmgt.config

Interface LinkdConfig

All Known Implementing Classes:

LinkdConfigFactory, LinkdConfigManager, MockLinkdConfig

public interface LinkdConfig

LinkdConfig interface.

Version:

$Id: $

Author:

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

Method Summary

Modifier and Type	Method and Description
Enumeration<Package>	enumeratePackage() enumeratePackage
boolean	forceIpRouteDiscoveryOnEthernet()
List<String>	getAllPackageMatches(InetAddress ipAddr) Returns true if the IP is part of at least one package.
LinkdConfiguration	getConfiguration() getConfiguration
String	getDefaultIpRouteClassName()
long	getDiscoveryLinkInterval() getDiscoveryLinkInterval
Package	getFirstPackageMatch(InetAddress ipaddr) Returns the first package that the ip belongs to, null if none.
long	getInitialSleepTime() getInitialSleepTime
List<InetAddress>	getIpList(Package pkg) Determine the list of IPs the filter rule for this package allows
String	getIpRouteClassName(String sysoid)
Package	getPackage(String pkgName) getPackage
Lock	getReadLock()
long	getSnmpPollInterval() getSnmpPollInterval
int	getThreads() getThreads
String	getVlanClassName(String sysoid) getVlanClassName
Lock	getWriteLock()
boolean	hasClassName(String sysoid) hasClassName
boolean	hasIpRouteClassName(String sysoid)
boolean	isAutoDiscoveryEnabled()
boolean	isInterfaceInPackage(InetAddress iface, Package pkg) This method is used to determine if the named interface is included in the passed package definition.
boolean	isInterfaceInPackageRange(InetAddress iface, Package pkg) This method is used to determine if the named interface is included in the passed package definition.
boolean	isVlanDiscoveryEnabled()
void	reload() reload
void	save() save
boolean	saveRouteTable() saveRouteTable
boolean	saveStpInterfaceTable() saveStpInterfaceTable
boolean	saveStpNodeTable() saveStpNodeTable
void	update() update
boolean	useBridgeDiscovery() useBridgeDiscovery
boolean	useCdpDiscovery() useCdpDiscovery
boolean	useIpRouteDiscovery() useIpRouteDiscovery
boolean	useIsIsDiscovery() useIsIsDiscovery
boolean	useLldpDiscovery() useLldpDiscovery
boolean	useOspfDiscovery() useOspfDiscovery
boolean	useWifiDiscovery() useWifiDiscovery

Method Detail

getIpList

List<InetAddress> getIpList(Package pkg)

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

Parameters:

pkg - a Package object.

Returns:

a List object.

isInterfaceInPackage

boolean isInterfaceInPackage(InetAddress 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.

isInterfaceInPackageRange

boolean isInterfaceInPackageRange(InetAddress 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(InetAddress 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<String> getAllPackageMatches(InetAddress ipAddr)

Returns true if the IP is part of at least one package. Note: Evaluation of the interface against a package filter will only work if the IP is already in the database.

Parameters:

ipAddr - a String object.

Returns:

true if the IP is part of at least one package, false otherwise

isAutoDiscoveryEnabled

boolean isAutoDiscoveryEnabled()

isVlanDiscoveryEnabled

boolean isVlanDiscoveryEnabled()

enumeratePackage

Enumeration<Package> enumeratePackage()

enumeratePackage

Returns:

a Enumeration object.

getPackage

Package getPackage(String pkgName)

getPackage

Parameters:

pkgName - a String object.

Returns:

a Package object.

getThreads

int getThreads()

getThreads

Returns:

a int.

useIpRouteDiscovery

boolean useIpRouteDiscovery()

useIpRouteDiscovery

Returns:

a boolean.

forceIpRouteDiscoveryOnEthernet

boolean forceIpRouteDiscoveryOnEthernet()

saveRouteTable

boolean saveRouteTable()

saveRouteTable

Returns:

a boolean.

useCdpDiscovery

boolean useCdpDiscovery()

useCdpDiscovery

Returns:

a boolean.

useBridgeDiscovery

boolean useBridgeDiscovery()

useBridgeDiscovery

Returns:

a boolean.

useLldpDiscovery

boolean useLldpDiscovery()

useLldpDiscovery

Returns:

a boolean.

useOspfDiscovery

boolean useOspfDiscovery()

useOspfDiscovery

Returns:

a boolean.

useIsIsDiscovery

boolean useIsIsDiscovery()

useIsIsDiscovery

Returns:

a boolean.

useWifiDiscovery

boolean useWifiDiscovery()

useWifiDiscovery

Returns:

a boolean.

saveStpNodeTable

boolean saveStpNodeTable()

saveStpNodeTable

Returns:

a boolean.

saveStpInterfaceTable

boolean saveStpInterfaceTable()

saveStpInterfaceTable

Returns:

a boolean.

getInitialSleepTime

long getInitialSleepTime()

getInitialSleepTime

Returns:

a long.

getSnmpPollInterval

long getSnmpPollInterval()

getSnmpPollInterval

Returns:

a long.

getDiscoveryLinkInterval

long getDiscoveryLinkInterval()

getDiscoveryLinkInterval

Returns:

a long.

reload

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

reload

Reload the configuration file

Throws:

IOException - if any.

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

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

save

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

save

Throws:

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

IOException - if any.

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

update

void update()

update

update the global helper objects

this calls the update of the following maps

packageIpListMap

urlIpMap

IpRouteClassNameMap

VlanClassNameMap

getConfiguration

LinkdConfiguration getConfiguration()

getConfiguration

Returns:

a LinkdConfiguration object.

getVlanClassName

String getVlanClassName(String sysoid)

getVlanClassName

Parameters:

sysoid - a String object.

Returns:

a String object.

hasClassName

boolean hasClassName(String sysoid)

hasClassName

Parameters:

sysoid - a String object.

Returns:

a boolean.

getReadLock

Lock getReadLock()

getWriteLock

Lock getWriteLock()

hasIpRouteClassName

boolean hasIpRouteClassName(String sysoid)

getIpRouteClassName

String getIpRouteClassName(String sysoid)

getDefaultIpRouteClassName

String getDefaultIpRouteClassName()