org.opennms.web.element
Interface NetworkElementFactoryInterface

All Known Implementing Classes:

NetworkElementFactory

public interface NetworkElementFactoryInterface

Method Summary

Interface[]	getActiveInterfacesOnNode(int nodeId) getActiveInterfacesOnNode
DataLinkInterface[]	getAllDataLinks() getAllDataLinks
Interface[]	getAllInterfaces() getAllInterfaces
Interface[]	getAllInterfaces(boolean includeSnmp)
Interface[]	getAllInterfacesOnNode(int nodeId) getAllInterfacesOnNode
Interface[]	getAllManagedIpInterfaces(boolean includeSNMP) getAllManagedIpInterfaces
Node[]	getAllNodes() Returns all non-deleted nodes.
Node[]	getAllNodes(int serviceId) getAllNodes
Service[]	getAllServices() getAllServices
Interface[]	getAllSnmpInterfacesOnNode(int nodeId) Returns all snmp interfaces on a node
AtInterface	getAtInterface(int nodeId, String ipAddr)
DataLinkInterface[]	getDataLinks(int nodeId, int ifIndex) getDataLinks
DataLinkInterface[]	getDataLinksFromNodeParent(int nodeId, int ifIndex) getDataLinksFromNodeParent
DataLinkInterface[]	getDataLinksOnInterface(int nodeID, int ifindex) getDataLinksOnInterface
DataLinkInterface[]	getDataLinksOnNode(int nodeID) getDataLinksOnNode
String	getHostname(String ipAddress) Resolve an IP address to a DNS hostname via the database.
Interface	getInterface(int ipInterfaceId) getInterface
Interface	getInterface(int nodeId, String ipAddress) getInterface
Interface	getInterface(int nodeId, String ipAddress, int ifIndex) getInterface
Interface[]	getInterfacesWithIfAlias(int nodeId, String ifAlias)
Interface[]	getInterfacesWithIpAddress(String ipAddress) getInterfacesWithIpAddress
String	getIpPrimaryAddress(int nodeId) Translate a node id into a human-readable ipaddress.
IpRouteInterface[]	getIpRoute(int nodeId)
Node	getNode(int nodeId)
List<Integer>	getNodeIdsWithIpLike(String iplike) Returns all non-deleted nodes with an IP address like the rule given.
String	getNodeLabel(int nodeId)
Node[]	getNodesFromPhysaddr(String AtPhysAddr) getNodesFromPhysaddr
Node[]	getNodesLike(String nodeLabel) Returns all non-deleted nodes that have the given nodeLabel substring somewhere in their nodeLabel.
Node[]	getNodesLike(String nodeLabel, int serviceId) getNodesLike
Node[]	getNodesLikeAndIpLike(String nodeLabel, String iplike, int serviceId) getNodesLikeAndIpLike
Node[]	getNodesWithCategories(String[] categories, boolean onlyNodesWithDownAggregateStatus) getNodesWithCategories
Node[]	getNodesWithCategories(String[] categories1, String[] categories2, boolean onlyNodesWithDownAggregateStatus) getNodesWithCategories
Node[]	getNodesWithCategories(org.springframework.transaction.support.TransactionTemplate transTemplate, String[] categories1, boolean onlyNodesWithDownAggregateStatus) getNodesWithCategories
Node[]	getNodesWithCategories(org.springframework.transaction.support.TransactionTemplate transTemplate, String[] categories1, String[] categories2, boolean onlyNodesWithDownAggregateStatus) getNodesWithCategories
Node[]	getNodesWithIfAlias(String ifAlias) Returns all non-deleted nodes that contain the given string in an ifAlias
Node[]	getNodesWithIpLike(String iplike)
Node[]	getNodesWithIpLike(String iplike, int serviceId) getNodesWithIpLike
Node[]	getNodesWithPhysAddr(String macAddr) Returns all non-deleted nodes that have the given mac.
Node[]	getNodesWithPhysAddrAtInterface(String macAddr) Returns all non-deleted nodes with a MAC address like the rule given from AtInterface.
Node[]	getNodesWithPhysAddrFromSnmpInterface(String macAddr) Returns all non-deleted nodes with a MAC address like the rule given from SnmpInterface.
Node[]	getNodesWithService(int serviceId) Returns all non-deleted nodes that have the given service.
Service	getService(int ifServiceId) Return the service specified by the node identifier, IP address, and service identifier.
Service	getService(int nodeId, String ipAddress, int serviceId) Return the service specified by the node identifier, IP address, and service identifier.
int	getServiceIdFromName(String serviceName) getServiceIdFromName
Map<Integer,String>	getServiceIdToNameMap() getServiceIdToNameMap
String	getServiceNameFromId(int serviceId) getServiceNameFromId
Map<String,Integer>	getServiceNameToIdMap() getServiceNameToIdMap
Service[]	getServicesOnInterface(int nodeId, String ipAddress) getServicesOnInterface
Service[]	getServicesOnInterface(int nodeId, String ipAddress, boolean includeDeletions) getServicesOnInterface
Service[]	getServicesOnNode(int nodeId) Get the list of all services on a given node.
Service[]	getServicesOnNode(int nodeId, int serviceId) Get the list of all instances of a specific service on a given node.
Interface	getSnmpInterface(int nodeId, int ifIndex) Get interface from snmpinterface table.
boolean	isParentNode(int nodeId) isParentNode
boolean	nodeHasIfAliases(int nodeId) Returns true if node has any snmpIfAliases

Method Detail

getNodeLabel

String getNodeLabel(int nodeId)

getIpPrimaryAddress

String getIpPrimaryAddress(int nodeId)

Translate a node id into a human-readable ipaddress. Note these values are not cached.

Parameters:

nodeId - a int.

Returns:

A human-readable node name or null if the node id given does not specify a real node.

getNode

Node getNode(int nodeId)

getAllNodes

Node[] getAllNodes()

Returns all non-deleted nodes.

Returns:

an array of Node objects.

getNodesLike

Node[] getNodesLike(String nodeLabel)

Returns all non-deleted nodes that have the given nodeLabel substring somewhere in their nodeLabel.

Parameters:

nodeLabel - a String object.

Returns:

an array of Node objects.

getNodesWithIpLike

Node[] getNodesWithIpLike(String iplike)

getNodesWithService

Node[] getNodesWithService(int serviceId)

Returns all non-deleted nodes that have the given service.

Parameters:

serviceId - a int.

Returns:

an array of Node objects.

getNodesWithPhysAddr

Node[] getNodesWithPhysAddr(String macAddr)

Returns all non-deleted nodes that have the given mac.

Parameters:

macAddr - a String object.

Returns:

an array of Node objects.

getNodesWithPhysAddrAtInterface

Node[] getNodesWithPhysAddrAtInterface(String macAddr)

Returns all non-deleted nodes with a MAC address like the rule given from AtInterface.

Parameters:

macAddr - a String object.

Returns:

an array of Node objects.

getNodesWithPhysAddrFromSnmpInterface

Node[] getNodesWithPhysAddrFromSnmpInterface(String macAddr)

Returns all non-deleted nodes with a MAC address like the rule given from SnmpInterface.

Parameters:

macAddr - a String object.

Returns:

an array of Node objects.

getNodesWithIfAlias

Node[] getNodesWithIfAlias(String ifAlias)

Returns all non-deleted nodes that contain the given string in an ifAlias

Parameters:

ifAlias - a String object.

Returns:

nodes the nodes with a matching ifAlias on one or more interfaces

getHostname

String getHostname(String ipAddress)

Resolve an IP address to a DNS hostname via the database. If no hostname can be found, the given IP address is returned.

Parameters:

ipAddress - a String object.

Returns:

a String object.

getInterface

Interface getInterface(int ipInterfaceId)

getInterface

Parameters:

ipInterfaceId - a int.

Returns:

a Interface object.

getInterface

Interface getInterface(int nodeId,
                       String ipAddress)

getInterface

Parameters:

nodeId - a int.

ipAddress - a String object.

Returns:

a Interface object.

getInterface

Interface getInterface(int nodeId,
                       String ipAddress,
                       int ifIndex)

getInterface

Parameters:

nodeId - a int.

ipAddress - a String object.

ifindex - a int.

Returns:

a Interface object.

getSnmpInterface

Interface getSnmpInterface(int nodeId,
                           int ifIndex)

Get interface from snmpinterface table. Intended for use with non-ip interfaces.

Parameters:

nodeId - a int.

ifIndex - a int.

Returns:

Interface

getInterfacesWithIpAddress

Interface[] getInterfacesWithIpAddress(String ipAddress)

getInterfacesWithIpAddress

Parameters:

ipAddress - a String object.

Returns:

an array of Interface objects.

getInterfacesWithIfAlias

Interface[] getInterfacesWithIfAlias(int nodeId,
                                     String ifAlias)

nodeHasIfAliases

boolean nodeHasIfAliases(int nodeId)

Returns true if node has any snmpIfAliases

Parameters:

nodeId - a int.

Returns:

boolean true if node has any snmpIfAliases

getAllInterfacesOnNode

Interface[] getAllInterfacesOnNode(int nodeId)

getAllInterfacesOnNode

Parameters:

nodeId - a int.

Returns:

an array of Interface objects.

getAllSnmpInterfacesOnNode

Interface[] getAllSnmpInterfacesOnNode(int nodeId)

Returns all snmp interfaces on a node

Parameters:

nodeId - a int.

Returns:

Interface[]

getActiveInterfacesOnNode

Interface[] getActiveInterfacesOnNode(int nodeId)

getActiveInterfacesOnNode

Parameters:

nodeId - a int.

Returns:

an array of Interface objects.

getAllInterfaces

Interface[] getAllInterfaces()

getAllInterfaces

Returns:

an array of Interface objects.

getAllInterfaces

Interface[] getAllInterfaces(boolean includeSnmp)

getAllManagedIpInterfaces

Interface[] getAllManagedIpInterfaces(boolean includeSNMP)

getAllManagedIpInterfaces

Parameters:

includeSNMP - a boolean.

Returns:

an array of Interface objects.

getService

Service getService(int nodeId,
                   String ipAddress,
                   int serviceId)

Return the service specified by the node identifier, IP address, and service identifier.

Note that if there are both an active service and historically deleted services with this (nodeid, ipAddress, serviceId) key, then the active service will be returned. If there are only deleted services, then the first deleted service will be returned.

Parameters:

nodeId - a int.

ipAddress - a String object.

serviceId - a int.

Returns:

a Service object.

getService

Service getService(int ifServiceId)

Return the service specified by the node identifier, IP address, and service identifier.

Note that if there are both an active service and historically deleted services with this (nodeid, ipAddress, serviceId) key, then the active service will be returned. If there are only deleted services, then the first deleted service will be returned.

Parameters:

ifServiceId - a int.

Returns:

a Service object.

getAllServices

Service[] getAllServices()

getAllServices

Returns:

an array of Service objects.

getServicesOnInterface

Service[] getServicesOnInterface(int nodeId,
                                 String ipAddress)

getServicesOnInterface

Parameters:

nodeId - a int.

ipAddress - a String object.

Returns:

an array of Service objects.

getServicesOnInterface

Service[] getServicesOnInterface(int nodeId,
                                 String ipAddress,
                                 boolean includeDeletions)

getServicesOnInterface

Parameters:

nodeId - a int.

ipAddress - a String object.

includeDeletions - a boolean.

Returns:

an array of Service objects.

getServicesOnNode

Service[] getServicesOnNode(int nodeId)

Get the list of all services on a given node.

Parameters:

nodeId - a int.

Returns:

an array of Service objects.

getServicesOnNode

Service[] getServicesOnNode(int nodeId,
                            int serviceId)

Get the list of all instances of a specific service on a given node.

Parameters:

nodeId - a int.

serviceId - a int.

Returns:

an array of Service objects.

getServiceNameFromId

String getServiceNameFromId(int serviceId)

getServiceNameFromId

Parameters:

serviceId - a int.

Returns:

a String object.

getServiceIdFromName

int getServiceIdFromName(String serviceName)

getServiceIdFromName

Parameters:

serviceName - a String object.

Returns:

a int.

getServiceIdToNameMap

Map<Integer,String> getServiceIdToNameMap()

getServiceIdToNameMap

Returns:

a java$util$Map object.

getServiceNameToIdMap

Map<String,Integer> getServiceNameToIdMap()

getServiceNameToIdMap

Returns:

a java$util$Map object.

getNodesLikeAndIpLike

Node[] getNodesLikeAndIpLike(String nodeLabel,
                             String iplike,
                             int serviceId)

getNodesLikeAndIpLike

Parameters:

nodeLabel - a String object.

iplike - a String object.

serviceId - a int.

Returns:

an array of Node objects.

getNodesLike

Node[] getNodesLike(String nodeLabel,
                    int serviceId)

getNodesLike

Parameters:

nodeLabel - a String object.

serviceId - a int.

Returns:

an array of Node objects.

getNodesWithIpLike

Node[] getNodesWithIpLike(String iplike,
                          int serviceId)

getNodesWithIpLike

Parameters:

iplike - a String object.

serviceId - a int.

Returns:

an array of Node objects.

getAllNodes

Node[] getAllNodes(int serviceId)

getAllNodes

Parameters:

serviceId - a int.

Returns:

an array of Node objects.

getNodesFromPhysaddr

Node[] getNodesFromPhysaddr(String AtPhysAddr)

getNodesFromPhysaddr

Parameters:

AtPhysAddr - a String object.

Returns:

an array of Node objects.

getAtInterface

AtInterface getAtInterface(int nodeId,
                           String ipAddr)

getIpRoute

IpRouteInterface[] getIpRoute(int nodeId)

isParentNode

boolean isParentNode(int nodeId)

isParentNode

Parameters:

nodeID - a int.

Returns:

a boolean.

getDataLinksOnNode

DataLinkInterface[] getDataLinksOnNode(int nodeID)

getDataLinksOnNode

Parameters:

nodeID - a int.

Returns:

an array of DataLinkInterface objects.

Throws:

SQLException - if any.

getDataLinksOnInterface

DataLinkInterface[] getDataLinksOnInterface(int nodeID,
                                            int ifindex)

getDataLinksOnInterface

Parameters:

nodeID - a int.

ifindex - a int.

Returns:

an array of DataLinkInterface objects.

getDataLinks

DataLinkInterface[] getDataLinks(int nodeId,
                                 int ifIndex)

getDataLinks

Parameters:

nodeID - a int.

ifindex - a int.

Returns:

an array of DataLinkInterface objects.

getDataLinksFromNodeParent

DataLinkInterface[] getDataLinksFromNodeParent(int nodeId,
                                               int ifIndex)

getDataLinksFromNodeParent

Parameters:

nodeID - a int.

ifindex - a int.

Returns:

an array of DataLinkInterface objects.

getAllDataLinks

DataLinkInterface[] getAllDataLinks()

getAllDataLinks

Returns:

an array of DataLinkInterface objects.

getNodeIdsWithIpLike

List<Integer> getNodeIdsWithIpLike(String iplike)

Returns all non-deleted nodes with an IP address like the rule given.

Parameters:

iplike - a String object.

Returns:

a List object.

getNodesWithCategories

Node[] getNodesWithCategories(org.springframework.transaction.support.TransactionTemplate transTemplate,
                              String[] categories1,
                              boolean onlyNodesWithDownAggregateStatus)

getNodesWithCategories

Parameters:

transTemplate - a TransactionTemplate object.

nodeDao - a NodeDao object.

categoryDao - a CategoryDao object.

categories1 - an array of String objects.

onlyNodesWithDownAggregateStatus - a boolean.

Returns:

an array of Node objects.

getNodesWithCategories

Node[] getNodesWithCategories(String[] categories,
                              boolean onlyNodesWithDownAggregateStatus)

getNodesWithCategories

Parameters:

nodeDao - a NodeDao object.

categoryDao - a CategoryDao object.

categories1 - an array of String objects.

onlyNodesWithDownAggregateStatus - a boolean.

Returns:

an array of Node objects.

getNodesWithCategories

Node[] getNodesWithCategories(org.springframework.transaction.support.TransactionTemplate transTemplate,
                              String[] categories1,
                              String[] categories2,
                              boolean onlyNodesWithDownAggregateStatus)

getNodesWithCategories

Parameters:

transTemplate - a TransactionTemplate object.

nodeDao - a NodeDao object.

categoryDao - a CategoryDao object.

categories1 - an array of String objects.

categories2 - an array of String objects.

onlyNodesWithDownAggregateStatus - a boolean.

Returns:

an array of Node objects.

getNodesWithCategories

Node[] getNodesWithCategories(String[] categories1,
                              String[] categories2,
                              boolean onlyNodesWithDownAggregateStatus)

getNodesWithCategories

Parameters:

nodeDao - a NodeDao object.

categoryDao - a CategoryDao object.

categories1 - an array of String objects.

categories2 - an array of String objects.

onlyNodesWithDownAggregateStatus - a boolean.

Returns:

an array of Node objects.