org.opennms.netmgt.dao.api

Interface NodeDao

All Superinterfaces:

LegacyOnmsDao<OnmsNode,Integer>, OnmsDao<OnmsNode,Integer>

All Known Implementing Classes:

MockNodeDao, NodeDaoHibernate

@Repository
public interface NodeDao
extends LegacyOnmsDao<OnmsNode,Integer>

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteObsoleteInterfaces(Integer nodeId, Date scanStamp) deleteObsoleteInterfaces
List<OnmsNode>	findAll() Returns a list of nodes ordered by label.
List<OnmsNode>	findAllByCategoryList(Collection<OnmsCategory> categories) findAllByCategoryList
List<OnmsNode>	findAllByCategoryLists(Collection<OnmsCategory> rowCatNames, Collection<OnmsCategory> colCatNames) findAllByCategoryLists
List<OnmsNode>	findAllByVarCharAssetColumn(String columnName, String columnValue) findAllByVarCharAssetColumn
List<OnmsNode>	findAllByVarCharAssetColumnCategoryList(String columnName, String columnValue, Collection<OnmsCategory> categories) findAllByVarCharAssetColumnCategoryList
List<OnmsNode>	findAllProvisionedNodes() findAllProvisionedNodes
List<OnmsNode>	findByCategory(OnmsCategory category) findByCategory
OnmsNode	findByForeignId(String foreignSource, String foreignId) findByForeignId
List<OnmsNode>	findByForeignSource(String foreignSource) findByForeignSource
List<OnmsNode>	findByForeignSourceAndIpAddress(String foreignSource, String ipAddress) findByForeignSourceAndIpAddress
List<OnmsNode>	findByLabel(String label) findByLabel
List<OnmsNode>	findNodes(OnmsDistPoller dp) findNodes
List<OnmsIpInterface>	findObsoleteIpInterfaces(Integer nodeId, Date scanStamp) findObsoleteIpInterfaces
SurveillanceStatus	findSurveillanceStatusByCategoryLists(Collection<OnmsCategory> rowCategories, Collection<OnmsCategory> columnCategories)
OnmsNode	get(String lookupCriteria) Get a node based on it's node ID or foreignSource:foreignId
Map<Integer,String>	getAllLabelsById() Retrieves all of node id/label tuples.
Map<String,Integer>	getForeignIdToNodeIdMap(String foreignSource) getForeignIdToNodeIdMap
OnmsNode	getHierarchy(Integer id) getHierarchy
String	getLabelForId(Integer id) Light weight call to simply get the node label without loading the entire node.
Integer	getNextNodeId(Integer nodeId)
int	getNodeCountForForeignSource(String groupName) getNodeCountForForeignSource
Collection<Integer>	getNodeIds() getNodeIds
Integer	getPreviousNodeId(Integer nodeId)
void	updateNodeScanStamp(Integer nodeId, Date scanStamp) updateNodeScanStamp

Methods inherited from interface org.opennms.netmgt.dao.api.LegacyOnmsDao

countMatching, findMatching

Methods inherited from interface org.opennms.netmgt.dao.api.OnmsDao

clear, countAll, countMatching, delete, delete, findMatching, flush, get, initialize, load, lock, save, saveOrUpdate, update

Method Detail

get

OnmsNode get(String lookupCriteria)

Get a node based on it's node ID or foreignSource:foreignId

Parameters:

lookupCriteria - the criteria, either the node ID, or a colon-separated string of foreignSource:foreignId

Returns:

the node

getAllLabelsById

Map<Integer,String> getAllLabelsById()

Retrieves all of node id/label tuples. Can be used as a lightweight alternative to findAll().

Returns:

a Map containing all node ids and their associated labels.

getLabelForId

String getLabelForId(Integer id)

Light weight call to simply get the node label without loading the entire node.

Parameters:

id -

Returns:

A String representing the provisioned label for the node. Returns null if not found.

findByLabel

List<OnmsNode> findByLabel(String label)

findByLabel

Parameters:

label - a String object.

Returns:

a Collection object.

findNodes

List<OnmsNode> findNodes(OnmsDistPoller dp)

findNodes

Parameters:

dp - a OnmsDistPoller object.

Returns:

a Collection object.

getHierarchy

OnmsNode getHierarchy(Integer id)

getHierarchy

Parameters:

id - a Integer object.

Returns:

a OnmsNode object.

getForeignIdToNodeIdMap

Map<String,Integer> getForeignIdToNodeIdMap(String foreignSource)

getForeignIdToNodeIdMap

Parameters:

foreignSource - a String object.

Returns:

a Map object.

findAllByVarCharAssetColumn

List<OnmsNode> findAllByVarCharAssetColumn(String columnName,
                                         String columnValue)

findAllByVarCharAssetColumn

Parameters:

columnName - a String object.

columnValue - a String object.

Returns:

a Collection object.

findAllByVarCharAssetColumnCategoryList

List<OnmsNode> findAllByVarCharAssetColumnCategoryList(String columnName,
                                                     String columnValue,
                                                     Collection<OnmsCategory> categories)

findAllByVarCharAssetColumnCategoryList

Parameters:

columnName - a String object.

columnValue - a String object.

categories - a Collection object.

Returns:

a Collection object.

findByCategory

List<OnmsNode> findByCategory(OnmsCategory category)

findByCategory

Parameters:

category - a OnmsCategory object.

Returns:

a Collection object.

findAllByCategoryList

List<OnmsNode> findAllByCategoryList(Collection<OnmsCategory> categories)

findAllByCategoryList

Parameters:

categories - a Collection object.

Returns:

a Collection object.

findAllByCategoryLists

List<OnmsNode> findAllByCategoryLists(Collection<OnmsCategory> rowCatNames,
                                    Collection<OnmsCategory> colCatNames)

findAllByCategoryLists

Parameters:

rowCatNames - a Collection object.

colCatNames - a Collection object.

Returns:

a Collection object.

findAll

List<OnmsNode> findAll()

Returns a list of nodes ordered by label.

Specified by:

findAll in interface OnmsDao<OnmsNode,Integer>

Returns:

a List object.

findByForeignSource

List<OnmsNode> findByForeignSource(String foreignSource)

findByForeignSource

Parameters:

foreignSource - a String object.

Returns:

a List object.

findByForeignId

OnmsNode findByForeignId(String foreignSource,
                       String foreignId)

findByForeignId

Parameters:

foreignSource - a String object.

foreignId - a String object.

Returns:

a OnmsNode object.

getNodeCountForForeignSource

int getNodeCountForForeignSource(String groupName)

getNodeCountForForeignSource

Parameters:

groupName - a String object.

Returns:

a int.

findAllProvisionedNodes

List<OnmsNode> findAllProvisionedNodes()

findAllProvisionedNodes

Returns:

a List object.

findObsoleteIpInterfaces

List<OnmsIpInterface> findObsoleteIpInterfaces(Integer nodeId,
                                             Date scanStamp)

findObsoleteIpInterfaces

Parameters:

nodeId - a Integer object.

scanStamp - a Date object.

Returns:

a List object.

deleteObsoleteInterfaces

void deleteObsoleteInterfaces(Integer nodeId,
                            Date scanStamp)

deleteObsoleteInterfaces

Parameters:

nodeId - a Integer object.

scanStamp - a Date object.

updateNodeScanStamp

void updateNodeScanStamp(Integer nodeId,
                       Date scanStamp)

updateNodeScanStamp

Parameters:

nodeId - a Integer object.

scanStamp - a Date object.

getNodeIds

Collection<Integer> getNodeIds()

getNodeIds

Returns:

a Collection object.

findByForeignSourceAndIpAddress

List<OnmsNode> findByForeignSourceAndIpAddress(String foreignSource,
                                             String ipAddress)

findByForeignSourceAndIpAddress

Parameters:

foreignSource - a String object.

ipAddress - a String object.

Returns:

a List object.

findSurveillanceStatusByCategoryLists

SurveillanceStatus findSurveillanceStatusByCategoryLists(Collection<OnmsCategory> rowCategories,
                                                       Collection<OnmsCategory> columnCategories)

getNextNodeId

Integer getNextNodeId(Integer nodeId)

getPreviousNodeId

Integer getPreviousNodeId(Integer nodeId)