org.opennms.netmgt.config

Class SnmpInterfacePollerConfigManager

java.lang.Object

org.opennms.netmgt.config.SnmpInterfacePollerConfigManager

All Implemented Interfaces:

SnmpInterfacePollerConfig

Direct Known Subclasses:

SnmpInterfacePollerConfigFactory

public abstract class SnmpInterfacePollerConfigManager
extends Object
implements SnmpInterfacePollerConfig

Abstract SnmpInterfacePollerConfigManager class.

Version:

$Id: $

Author:

Mathew Brozowski, David Hustace, Mathew Brozowski, David Hustace

Constructor Summary

Constructors

Constructor and Description
SnmpInterfacePollerConfigManager(InputStream stream, String localServer, boolean verifyServer) Constructor for SnmpInterfacePollerConfigManager.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPackage(Package pkg) addPackage
Enumeration<Package>	enumeratePackage() enumeratePackage
List<String>	getAllPackageMatches(String ipaddr) getAllPackageMatches
SnmpInterfacePollerConfiguration	getConfiguration() Return the poller configuration object.
String	getCriteria(String pkgName, String pkgInterfaceName) getCriteria
String[]	getCriticalServiceIds() This method returns the configured critical service name.
Set<String>	getInterfaceOnPackage(String pkgName) getInterfaceOnPackage
long	getInterval() getThreads
long	getInterval(String pkgName, String pkgInterfaceName) getInterval
List<InetAddress>	getIpList(Package pkg) getIpList
int	getMaxVarsPerPdu(String pkgName, String pkgInterfaceName) getMaxVarsPerPdu
Package	getPackage(String name) getPackage
Package	getPackageForAddress(String ipaddr) Returns the first package that the ip belongs to, null if none.
String	getPackageName(String ipaddr) getPackageName
int	getPort(String pkgName, String pkgInterfaceName) getPort
int	getRetries(String pkgName, String pkgInterfaceName) getRetries
String	getService() getService
boolean	getStatus(String pkgName, String pkgInterfaceName) getStatus
int	getThreads() getThreads
int	getTimeout(String pkgName, String pkgInterfaceName) getTimeout
boolean	hasMaxVarsPerPdu(String pkgName, String pkgInterfaceName) hasMaxVarsPerPdu
boolean	hasPort(String pkgName, String pkgInterfaceName) hasPort
boolean	hasRetries(String pkgName, String pkgInterfaceName) hasRetries
boolean	hasTimeout(String pkgName, String pkgInterfaceName) hasTimeout
Iterable<String>	includeURLs(Package pkg) includeURLs
boolean	interfaceInPackage(String iface, Package pkg) This method is used to determine if the named interface is included in the passed package definition.
Iterable<Package>	packages() packages
void	rebuildPackageIpListMap() This method is used to rebuild the package against IP list mapping when needed.
protected void	reloadXML(InputStream stream) reloadXML
void	save() Saves the current in-memory configuration to disk and reloads
protected abstract void	saveXml(String xml) saveXml
abstract void	update() update
boolean	useCriteriaFilters() useCriteriaFilters

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpInterfacePollerConfigManager

public SnmpInterfacePollerConfigManager(InputStream stream,
                                String localServer,
                                boolean verifyServer)
                                 throws org.exolab.castor.xml.MarshalException,
                                        org.exolab.castor.xml.ValidationException,
                                        IOException

Constructor for SnmpInterfacePollerConfigManager.

Parameters:

stream - a InputStream object.

localServer - a String object.

verifyServer - a boolean.

Throws:

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

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

IOException - if any.

Method Detail

update

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

update

Specified by:

update in interface SnmpInterfacePollerConfig

Throws:

IOException - if any.

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

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

saveXml

protected abstract void saveXml(String xml)
                         throws IOException

saveXml

Parameters:

xml - a String object.

Throws:

IOException - if any.

reloadXML

protected void reloadXML(InputStream stream)
                  throws org.exolab.castor.xml.MarshalException,
                         org.exolab.castor.xml.ValidationException,
                         IOException

reloadXML

Parameters:

stream - a InputStream object.

Throws:

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

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

IOException - if any.

save

public 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

public SnmpInterfacePollerConfiguration getConfiguration()

Return the poller configuration object.

Returns:

a SnmpInterfacePollerConfiguration object.

getPackage

public Package getPackage(String name)

getPackage

Parameters:

name - a String object.

Returns:

a Package object.

addPackage

public void addPackage(Package pkg)

addPackage

Parameters:

pkg - a Package object.

getCriticalServiceIds

public String[] getCriticalServiceIds()

This method returns the configured critical service name.

Specified by:

getCriticalServiceIds in interface SnmpInterfacePollerConfig

Returns:

the name of the configured critical service, or null if none is present

getIpList

public List<InetAddress> getIpList(Package pkg)

getIpList

Parameters:

pkg - a Package object.

Returns:

a List object.

rebuildPackageIpListMap

public void rebuildPackageIpListMap()

This method is used to rebuild the package against IP list mapping when needed. When a node gained service event occurs, poller has to determine which package the IP/service combination is in, but if the interface is a newly added one, the package IP list should be rebuilt so that poller could know which package this IP/service pair is in.

Specified by:

rebuildPackageIpListMap in interface SnmpInterfacePollerConfig

interfaceInPackage

public 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.

getPackageForAddress

public Package getPackageForAddress(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

public List<String> getAllPackageMatches(String ipaddr)

getAllPackageMatches

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

Specified by:

getAllPackageMatches in interface SnmpInterfacePollerConfig

Parameters:

ipaddr - a String object.

Returns:

a List object.

getPackageName

public String getPackageName(String ipaddr)

getPackageName

Specified by:

getPackageName in interface SnmpInterfacePollerConfig

Parameters:

ipaddr - a String object.

Returns:

a String object.

getInterfaceOnPackage

public Set<String> getInterfaceOnPackage(String pkgName)

getInterfaceOnPackage

Specified by:

getInterfaceOnPackage in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

Returns:

a Set object.

getStatus

public boolean getStatus(String pkgName,
                String pkgInterfaceName)

getStatus

Specified by:

getStatus in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a boolean.

getInterval

public long getInterval(String pkgName,
               String pkgInterfaceName)

getInterval

Specified by:

getInterval in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a long.

getCriteria

public String getCriteria(String pkgName,
                 String pkgInterfaceName)

getCriteria

Specified by:

getCriteria in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a String object.

hasPort

public boolean hasPort(String pkgName,
              String pkgInterfaceName)

hasPort

Specified by:

hasPort in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a boolean.

getPort

public int getPort(String pkgName,
          String pkgInterfaceName)

getPort

Specified by:

getPort in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a int.

hasTimeout

public boolean hasTimeout(String pkgName,
                 String pkgInterfaceName)

hasTimeout

Specified by:

hasTimeout in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a boolean.

getTimeout

public int getTimeout(String pkgName,
             String pkgInterfaceName)

getTimeout

Specified by:

getTimeout in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a int.

hasRetries

public boolean hasRetries(String pkgName,
                 String pkgInterfaceName)

hasRetries

Specified by:

hasRetries in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a boolean.

getRetries

public int getRetries(String pkgName,
             String pkgInterfaceName)

getRetries

Specified by:

getRetries in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a int.

hasMaxVarsPerPdu

public boolean hasMaxVarsPerPdu(String pkgName,
                       String pkgInterfaceName)

hasMaxVarsPerPdu

Specified by:

hasMaxVarsPerPdu in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a boolean.

getMaxVarsPerPdu

public int getMaxVarsPerPdu(String pkgName,
                   String pkgInterfaceName)

getMaxVarsPerPdu

Specified by:

getMaxVarsPerPdu in interface SnmpInterfacePollerConfig

Parameters:

pkgName - a String object.

pkgInterfaceName - a String object.

Returns:

a int.

enumeratePackage

public Enumeration<Package> enumeratePackage()

enumeratePackage

Returns:

a Enumeration object.

packages

public Iterable<Package> packages()

packages

Returns:

a Iterable object.

includeURLs

public Iterable<String> includeURLs(Package pkg)

includeURLs

Parameters:

pkg - a Package object.

Returns:

a Iterable object.

getThreads

public int getThreads()

getThreads

Specified by:

getThreads in interface SnmpInterfacePollerConfig

Returns:

a int.

getInterval

public long getInterval()

getThreads

Specified by:

getInterval in interface SnmpInterfacePollerConfig

Returns:

a long.

getService

public String getService()

getService

Specified by:

getService in interface SnmpInterfacePollerConfig

Returns:

a String object.

useCriteriaFilters

public boolean useCriteriaFilters()

useCriteriaFilters

Specified by:

useCriteriaFilters in interface SnmpInterfacePollerConfig

Returns:

a boolean.