CollectionAgentFactory (OpenNMS 2022.1.1 API)

All Known Implementing Classes:

AbstractCollectionAgentFactory, DefaultCollectionAgentFactory, DefaultSnmpCollectionAgentFactory, OsgiCollectionAgentFactory
```
public interface CollectionAgentFactory
```
Used to create CollectionAgents for a given IP interface.

Author:

jwhite

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CollectionAgent`	`createCollectionAgent(String nodeCriteria, InetAddress ipAddr)`
`CollectionAgent`	`createCollectionAgent(OnmsIpInterface ipIf)`
`CollectionAgent`	`createCollectionAgentAndOverrideLocation(String nodeCriteria, InetAddress ipAddr, String location)`	Create a collection agent for the given IP interface, and optionally override the node's location.

Method Detail

createCollectionAgent

CollectionAgent createCollectionAgent(OnmsIpInterface ipIf)

createCollectionAgent

CollectionAgent createCollectionAgent(String nodeCriteria,
                                      InetAddress ipAddr)

createCollectionAgentAndOverrideLocation
```
CollectionAgent createCollectionAgentAndOverrideLocation(String nodeCriteria,
                                                         InetAddress ipAddr,
                                                         String location)
```
Create a collection agent for the given IP interface, and optionally override the node's location. Overriding the node's location is strictly used for testing (i.e. via the opennms:collect) command in the Karaf console and is not used in normal operations.

Parameters:

nodeCriteria - node id or fs:fid

ipAddr - ip address associated with the node

location - null if the nodes existing location should be used

Returns:

the CollectionAgent