Package org.opennms.netmgt.provision.service

Class DefaultProvisionService

java.lang.Object

org.opennms.netmgt.provision.service.DefaultProvisionService

All Implemented Interfaces:

ProvisionService, org.springframework.beans.factory.InitializingBean

@Service
public class DefaultProvisionService
extends Object
implements ProvisionService, org.springframework.beans.factory.InitializingBean

DefaultProvisionService

Version:

$Id: $

Author:

brozow

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROVISIOND

Fields inherited from interface org.opennms.netmgt.provision.service.ProvisionService

ABORT, DETECTOR_NAME, ERROR, FOREIGN_ID, FOREIGN_SOURCE, IP_ADDRESS, LOCATION, NODE_ID

Constructor Summary

Constructors

Constructor	Description
DefaultProvisionService()

Method Summary

Modifier and Type	Method	Description
OnmsMonitoredService	addMonitoredService(Integer ipInterfaceId, String svcName, String monitorKey)
OnmsMonitoredService	addMonitoredService(Integer nodeId, String ipAddress, String svcName, String monitorKey)
void	afterPropertiesSet()
io.opentracing.Span	buildAndStartSpan(String name, io.opentracing.SpanContext spanContext)
void	clearCache()	clearCache
OnmsCategory	createCategoryIfNecessary(String name)	Look up the OnmsCategory with the give name, creating one if none exists.
protected OnmsMonitoringLocation	createLocationDefIfNecessary(OnmsMonitoringLocation location)
OnmsMonitoringLocation	createLocationIfNecessary(String locationName)	Lookup a monitoring location in the database, creating it if necessary.
OnmsServiceType	createServiceTypeIfNecessary(String serviceName)	Look up the OnmsServiceType with the given name, creating one if it doesn't exist.
OnmsNode	createUndiscoveredNode(String ipAddress, String foreignSource, String locationString, String monitorKey)
void	deleteInterface(Integer nodeId, String ipAddr)
void	deleteNode(Integer nodeId)	Delete the indicated node from the database.
void	deleteObsoleteInterfaces(Integer nodeId, Date scanStamp)
void	deleteService(Integer nodeId, InetAddress addr, String svcName, boolean ignoreUnmanaged)	Delete the indicated service from the database.
Set<String>	getCategoriesForNode(OnmsNode node)
OnmsNode	getDbNodeInitCat(Integer nodeId)
List<PluginConfig>	getDetectorsForForeignSource(String foreignSourceName)
Map<String,Integer>	getForeignIdToNodeIdMap(String foreignSource)	Creates a map of foreignIds to nodeIds for all nodes that have the indicated foreignSorce.
ForeignSourceRepository	getForeignSourceRepository()	getForeignSourceRepository
HostnameResolver	getHostnameResolver()
List<IpInterfacePolicy>	getIpInterfacePoliciesForForeignSource(String foreignSourceName)
LocationAwareDetectorClient	getLocationAwareDetectorClient()
LocationAwareDnsLookupClient	getLocationAwareDnsLookupClient()
LocationAwareSnmpClient	getLocationAwareSnmpClient()
OnmsNode	getNode(Integer nodeId)
List<NodePolicy>	getNodePoliciesForForeignSource(String foreignSourceName)
<T> List<T>	getPluginsForForeignSource(Class<T> pluginClass, String foreignSourceName)	getPluginsForForeignSource
OnmsIpInterface	getPrimaryInterfaceForNode(OnmsNode node)
OnmsNode	getRequisitionedNode(String foreignSource, String foreignId)
NodeScanSchedule	getScheduleForNode(int nodeId, boolean force, String monitorKey)
List<NodeScanSchedule>	getScheduleForNodes(String monitorKey)	getScheduleForNodes
List<SnmpInterfacePolicy>	getSnmpInterfacePoliciesForForeignSource(String foreignSourceName)
SnmpProfileMapper	getSnmpProfileMapper()
void	insertNode(OnmsNode node, String monitorKey)	Insert the provided node into the database
boolean	isDiscoveryEnabled()	isDiscoveryEnabled
Requisition	loadRequisition(org.springframework.core.io.Resource resource)
void	setEventForwarder(EventForwarder eventForwarder)
void	setForeignSourceRepository(ForeignSourceRepository foreignSourceRepository)
void	setHostnameResolver(HostnameResolver resolver)
void	setIpInterfaceDao(IpInterfaceDao dao)
OnmsIpInterface	setIsPrimaryFlag(Integer nodeId, String ipAddress)
void	setMonitoredServiceDao(MonitoredServiceDao dao)
void	setMonitoringLocationDao(MonitoringLocationDao dao)
void	setNodeDao(NodeDao dao)
void	setNodeParentAndDependencies(String foreignSource, String foreignId, String parentForeignSource, String parentForeignId, String parentNodeLabel)	Sets the parent of the node and adds the relationship to the path element for the node.
void	setServiceTypeDao(ServiceTypeDao dao)
void	setSnmpInterfaceDao(SnmpInterfaceDao dao)
void	setSnmpProfileMapper(SnmpProfileMapper snmpProfileMapper)
static void	setTag(io.opentracing.Span span, String name, String value)
void	setTracer(io.opentracing.Tracer tracer)
OnmsIpInterface	updateIpInterfaceAttributes(Integer nodeId, OnmsIpInterface scannedIface, String monitorKey)
OnmsMonitoredService	updateMonitoredServiceState(Integer nodeId, String ipAddress, String svcName)
void	updateNode(OnmsNode node, String rescanExisting, String monitorKey)	Update the database entry for the given node.
OnmsNode	updateNodeAttributes(OnmsNode node)
void	updateNodeScanStamp(Integer nodeId, Date scanStamp)
OnmsSnmpInterface	updateSnmpInterfaceAttributes(Integer nodeId, OnmsSnmpInterface snmpInterface)

Methods inherited from class java.lang.Object

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

Field Detail

PROVISIOND

public static final String PROVISIOND

See Also:

Constant Field Values

Constructor Detail

DefaultProvisionService

public DefaultProvisionService()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

isDiscoveryEnabled

public boolean isDiscoveryEnabled()

isDiscoveryEnabled

Specified by:

isDiscoveryEnabled in interface ProvisionService

Returns:

a boolean.

insertNode

@Transactional
public void insertNode(OnmsNode node,
                       String monitorKey)

Insert the provided node into the database

Specified by:

insertNode in interface ProvisionService

updateNode

@Transactional
public void updateNode(OnmsNode node,
                       String rescanExisting,
                       String monitorKey)

Update the database entry for the given node. The node supplied is used to update the database. Entries that have been change in the node are copied into the database. It is assumed that the node passed in has been previously loaded from the database and modified.

Specified by:

updateNode in interface ProvisionService

Parameters:

node - The node that has been updated and should be written to the database

rescanExisting - true, if the node must be rescanned. false, if the node should not be rescanned (perform only add/delete operations on the DB) dbonly, if the node should not be rescanned (perform all DB operations)

deleteNode

@Transactional
public void deleteNode(Integer nodeId)

Delete the indicated node from the database.

Specified by:

deleteNode in interface ProvisionService

deleteInterface

@Transactional
public void deleteInterface(Integer nodeId,
                            String ipAddr)

Specified by:

deleteInterface in interface ProvisionService

deleteService

@Transactional
public void deleteService(Integer nodeId,
                          InetAddress addr,
                          String svcName,
                          boolean ignoreUnmanaged)

Delete the indicated service from the database. If the service is the last service on the interface, delete the interface as well. If the interface is the last interface on the node, delete the node as well.

Specified by:

deleteService in interface ProvisionService

Parameters:

nodeId - the node containing the service

addr - the IP address containing the service

svcName - the service to delete

ignoreUnmanaged - if true, cascade delete the containing interface if only unmanaged services remain

updateIpInterfaceAttributes

@Transactional
public OnmsIpInterface updateIpInterfaceAttributes(Integer nodeId,
                                                   OnmsIpInterface scannedIface,
                                                   String monitorKey)

Specified by:

updateIpInterfaceAttributes in interface ProvisionService

updateSnmpInterfaceAttributes

@Transactional
public OnmsSnmpInterface updateSnmpInterfaceAttributes(Integer nodeId,
                                                       OnmsSnmpInterface snmpInterface)

Specified by:

updateSnmpInterfaceAttributes in interface ProvisionService

addMonitoredService

@Transactional
public OnmsMonitoredService addMonitoredService(Integer ipInterfaceId,
                                                String svcName,
                                                String monitorKey)

Specified by:

addMonitoredService in interface ProvisionService

addMonitoredService

@Transactional
public OnmsMonitoredService addMonitoredService(Integer nodeId,
                                                String ipAddress,
                                                String svcName,
                                                String monitorKey)

Specified by:

addMonitoredService in interface ProvisionService

updateMonitoredServiceState

@Transactional
public OnmsMonitoredService updateMonitoredServiceState(Integer nodeId,
                                                        String ipAddress,
                                                        String svcName)

Specified by:

updateMonitoredServiceState in interface ProvisionService

clearCache

@Transactional
public void clearCache()

clearCache

Specified by:

clearCache in interface ProvisionService

createLocationIfNecessary

public OnmsMonitoringLocation createLocationIfNecessary(String locationName)

Description copied from interface: ProvisionService

Lookup a monitoring location in the database, creating it if necessary. This method looks up the OnmsMonitoringLocation object with the ID 'locationId' in the database and returns it. If there is no OnmsMonitoringLocation with that name then one is created using the name provided, saved in the database, and returned.

Specified by:

createLocationIfNecessary in interface ProvisionService

Parameters:

locationName - The ID of the OnmsMonitoringLocation that is needed

Returns:

a new OnmsMonitoringLocation that will be saved to the database when the transaction is committed.

createLocationDefIfNecessary

protected OnmsMonitoringLocation createLocationDefIfNecessary(OnmsMonitoringLocation location)

getRequisitionedNode

@Transactional
public OnmsNode getRequisitionedNode(String foreignSource,
                                     String foreignId)
                              throws ForeignSourceRepositoryException

Specified by:

getRequisitionedNode in interface ProvisionService

Throws:

ForeignSourceRepositoryException

createServiceTypeIfNecessary

@Transactional
public OnmsServiceType createServiceTypeIfNecessary(String serviceName)

Look up the OnmsServiceType with the given name, creating one if it doesn't exist.

Specified by:

createServiceTypeIfNecessary in interface ProvisionService

Parameters:

serviceName - the name of the OnmsServiceType to look up

Returns:

a OnmsServiceType object with the given name, if none existed in the database then a new one will been created and saved in the database.

createCategoryIfNecessary

@Transactional
public OnmsCategory createCategoryIfNecessary(String name)

Look up the OnmsCategory with the give name, creating one if none exists.

Specified by:

createCategoryIfNecessary in interface ProvisionService

Parameters:

name - the name of the OnmsCategory to look up

Returns:

an OnmsCategory that represents the given name, if none existed in the database a new one will have been created.

getForeignIdToNodeIdMap

@Transactional(readOnly=true)
public Map<String,Integer> getForeignIdToNodeIdMap(String foreignSource)

Creates a map of foreignIds to nodeIds for all nodes that have the indicated foreignSorce.

Specified by:

getForeignIdToNodeIdMap in interface ProvisionService

setNodeParentAndDependencies

@Transactional
public void setNodeParentAndDependencies(String foreignSource,
                                         String foreignId,
                                         String parentForeignSource,
                                         String parentForeignId,
                                         String parentNodeLabel)

Sets the parent of the node and adds the relationship to the path element for the node. The foreignId is used to reference the node and the parentForeignId and the parentNodeLabel are used to locate the parentNodeId

Specified by:

setNodeParentAndDependencies in interface ProvisionService

Parameters:

foreignSource - the foreignSource to use when looking for the nodeId and parentNodeId by foreignId.

foreignId - the foreignId for the node being set

parentForeignId - the foreignId of the parent node

parentNodeLabel - if the parent node cannot be found using its foreignId then an attempt to locate it using the its nodeLabel is made

getScheduleForNode

@Transactional(readOnly=true)
public NodeScanSchedule getScheduleForNode(int nodeId,
                                           boolean force,
                                           String monitorKey)

Specified by:

getScheduleForNode in interface ProvisionService

getScheduleForNodes

@Transactional(readOnly=true)
public List<NodeScanSchedule> getScheduleForNodes(String monitorKey)

getScheduleForNodes

Specified by:

getScheduleForNodes in interface ProvisionService

Returns:

a List object.

setForeignSourceRepository

public void setForeignSourceRepository(ForeignSourceRepository foreignSourceRepository)

Specified by:

setForeignSourceRepository in interface ProvisionService

getForeignSourceRepository

public ForeignSourceRepository getForeignSourceRepository()

getForeignSourceRepository

Returns:

a ForeignSourceRepository object.

loadRequisition

public Requisition loadRequisition(org.springframework.core.io.Resource resource)

Specified by:

loadRequisition in interface ProvisionService

updateNodeAttributes

@Transactional
public OnmsNode updateNodeAttributes(OnmsNode node)

Specified by:

updateNodeAttributes in interface ProvisionService

getCategoriesForNode

public Set<String> getCategoriesForNode(OnmsNode node)

getDetectorsForForeignSource

public List<PluginConfig> getDetectorsForForeignSource(String foreignSourceName)

Specified by:

getDetectorsForForeignSource in interface ProvisionService

getNodePoliciesForForeignSource

public List<NodePolicy> getNodePoliciesForForeignSource(String foreignSourceName)

Specified by:

getNodePoliciesForForeignSource in interface ProvisionService

getIpInterfacePoliciesForForeignSource

public List<IpInterfacePolicy> getIpInterfacePoliciesForForeignSource(String foreignSourceName)

Specified by:

getIpInterfacePoliciesForForeignSource in interface ProvisionService

getSnmpInterfacePoliciesForForeignSource

public List<SnmpInterfacePolicy> getSnmpInterfacePoliciesForForeignSource(String foreignSourceName)

Specified by:

getSnmpInterfacePoliciesForForeignSource in interface ProvisionService

getPluginsForForeignSource

public <T> List<T> getPluginsForForeignSource(Class<T> pluginClass,
                                              String foreignSourceName)

getPluginsForForeignSource

Type Parameters:

T - a T object.

Parameters:

pluginClass - a Class object.

foreignSourceName - a String object.

Returns:

a List object.

deleteObsoleteInterfaces

@Transactional
public void deleteObsoleteInterfaces(Integer nodeId,
                                     Date scanStamp)

Specified by:

deleteObsoleteInterfaces in interface ProvisionService

updateNodeScanStamp

@Transactional
public void updateNodeScanStamp(Integer nodeId,
                                Date scanStamp)

Specified by:

updateNodeScanStamp in interface ProvisionService

setIsPrimaryFlag

@Transactional
public OnmsIpInterface setIsPrimaryFlag(Integer nodeId,
                                        String ipAddress)

Specified by:

setIsPrimaryFlag in interface ProvisionService

getPrimaryInterfaceForNode

@Transactional
public OnmsIpInterface getPrimaryInterfaceForNode(OnmsNode node)

Specified by:

getPrimaryInterfaceForNode in interface ProvisionService

createUndiscoveredNode

@Transactional
public OnmsNode createUndiscoveredNode(String ipAddress,
                                       String foreignSource,
                                       String locationString,
                                       String monitorKey)

Specified by:

createUndiscoveredNode in interface ProvisionService

getNode

@Transactional
public OnmsNode getNode(Integer nodeId)

Specified by:

getNode in interface ProvisionService

getDbNodeInitCat

@Transactional
public OnmsNode getDbNodeInitCat(Integer nodeId)

Specified by:

getDbNodeInitCat in interface ProvisionService

setHostnameResolver

public void setHostnameResolver(HostnameResolver resolver)

Specified by:

setHostnameResolver in interface ProvisionService

getHostnameResolver

public HostnameResolver getHostnameResolver()

Specified by:

getHostnameResolver in interface ProvisionService

getLocationAwareDetectorClient

public LocationAwareDetectorClient getLocationAwareDetectorClient()

Specified by:

getLocationAwareDetectorClient in interface ProvisionService

getLocationAwareSnmpClient

public LocationAwareSnmpClient getLocationAwareSnmpClient()

Specified by:

getLocationAwareSnmpClient in interface ProvisionService

getSnmpProfileMapper

public SnmpProfileMapper getSnmpProfileMapper()

Specified by:

getSnmpProfileMapper in interface ProvisionService

setSnmpProfileMapper

public void setSnmpProfileMapper(SnmpProfileMapper snmpProfileMapper)

Specified by:

setSnmpProfileMapper in interface ProvisionService

setTracer

public void setTracer(io.opentracing.Tracer tracer)

Specified by:

setTracer in interface ProvisionService

getLocationAwareDnsLookupClient

public LocationAwareDnsLookupClient getLocationAwareDnsLookupClient()

Specified by:

getLocationAwareDnsLookupClient in interface ProvisionService

setMonitoringLocationDao

public void setMonitoringLocationDao(MonitoringLocationDao dao)

setNodeDao

public void setNodeDao(NodeDao dao)

setIpInterfaceDao

public void setIpInterfaceDao(IpInterfaceDao dao)

setSnmpInterfaceDao

public void setSnmpInterfaceDao(SnmpInterfaceDao dao)

setMonitoredServiceDao

public void setMonitoredServiceDao(MonitoredServiceDao dao)

setServiceTypeDao

public void setServiceTypeDao(ServiceTypeDao dao)

setEventForwarder

public void setEventForwarder(EventForwarder eventForwarder)

buildAndStartSpan

public io.opentracing.Span buildAndStartSpan(String name,
                                             io.opentracing.SpanContext spanContext)

Specified by:

buildAndStartSpan in interface ProvisionService

setTag

public static void setTag(io.opentracing.Span span,
                          String name,
                          String value)