Package org.opennms.netmgt.filter.api

Interface FilterDao

All Known Implementing Classes:

ConfigTesterFilterDao, JdbcFilterDao, MockFilterDao, UnimplementedFilterDao

public interface FilterDao

FilterDao interface.

Version:

$Id: $

Author:

DJ Gregor

Method Summary

Modifier and Type	Method	Description
void	flushActiveIpAddressListCache()
List<InetAddress>	getActiveIPAddressList(String rule)	Get the (non-deleted) IP addresses that match the specified rule.
List<InetAddress>	getIPAddressList(String rule)	Get the IP addresses (including deleted) that match the specified rule.
Map<InetAddress,Set<String>>	getIPAddressServiceMap(String rule)	getIPServiceMap
Map<Integer,Map<InetAddress,Set<String>>>	getNodeIPAddressServiceMap(String rule)	Retrieve a mapping of IP-services scoped by node that match the given rule.
SortedMap<Integer,String>	getNodeMap(String rule)	This method returns a map of all node IDs and node labels that match the rule that is passed in, sorted by node ID.
boolean	isRuleMatching(String rule)	Does this rule match anything in the database? In particular, does it return at least one record from the database?
boolean	isValid(String addr, String rule)	isValid
void	validateRule(String rule)	validateRule

Method Detail

getNodeMap

SortedMap<Integer,String> getNodeMap(String rule)
                                    throws FilterParseException

This method returns a map of all node IDs and node labels that match the rule that is passed in, sorted by node ID.

Parameters:

rule - an expression rule to be parsed and executed.

Returns:

SortedMap containing all node IDs and node labels selected by the rule.

Throws:

FilterParseException - if a rule is syntactically incorrect or failed in executing the SQL statement

FilterParseException - if any.

getIPAddressServiceMap

Map<InetAddress,Set<String>> getIPAddressServiceMap(String rule)
                                                   throws FilterParseException

getIPServiceMap

Parameters:

rule - a String object.

Returns:

a Map object.

Throws:

FilterParseException - if any.

getNodeIPAddressServiceMap

Map<Integer,Map<InetAddress,Set<String>>> getNodeIPAddressServiceMap(String rule)
                                                                          throws FilterParseException

Retrieve a mapping of IP-services scoped by node that match the given rule.

Parameters:

rule - filter rule to evaluate

Returns:

map of IP-services

Throws:

FilterParseException - if the rule is invalid

flushActiveIpAddressListCache

void flushActiveIpAddressListCache()

getActiveIPAddressList

List<InetAddress> getActiveIPAddressList(String rule)
                                  throws FilterParseException

Get the (non-deleted) IP addresses that match the specified rule.

Parameters:

rule - the filter rule

Returns:

a List of IP addresses.

Throws:

FilterParseException - if a rule is syntactically incorrect or failed in executing the SQL statement.

getIPAddressList

List<InetAddress> getIPAddressList(String rule)
                            throws FilterParseException

Get the IP addresses (including deleted) that match the specified rule.

Parameters:

rule - the filter rule

Returns:

a List of IP addresses.

Throws:

FilterParseException - if a rule is syntactically incorrect or failed in executing the SQL statement.

isValid

boolean isValid(String addr,
                String rule)
         throws FilterParseException

isValid

Parameters:

addr - a String object.

rule - a String object.

Returns:

a boolean.

Throws:

FilterParseException - if any.

isRuleMatching

boolean isRuleMatching(String rule)
                throws FilterParseException

Does this rule match anything in the database? In particular, does it return at least one record from the database?

Parameters:

rule - rule to match on

Returns:

true if there is at least one match, false otherwise

Throws:

FilterParseException - if any.

validateRule

void validateRule(String rule)
           throws FilterParseException

validateRule

Parameters:

rule - a String object.

Throws:

FilterParseException - if any.