OnmsSnmpCollection (OpenNMS 2015.1.9 API)

java.lang.Object
- org.opennms.netmgt.collectd.OnmsSnmpCollection

```
public class OnmsSnmpCollection
extends Object
```
Represents SNMP collection data for a single collection period. It is particularly used to create a CollectionSet for a specific remote agent with createCollectionSet(org.opennms.netmgt.collectd.SnmpCollectionAgent) and to provide data to CollectionSet and other classes that are created during collection.

Version:

$Id: $

Author:

ranger

Constructor Summary

Constructors
Constructor and Description
`OnmsSnmpCollection(SnmpCollectionAgent agent, ServiceParameters params)` Constructor for OnmsSnmpCollection.
`OnmsSnmpCollection(SnmpCollectionAgent agent, ServiceParameters params, DataCollectionConfigDao config)` Constructor for OnmsSnmpCollection.

Method Summary

Methods
Modifier and Type	Method and Description
`SnmpCollectionSet`	`createCollectionSet(SnmpCollectionAgent agent)` createCollectionSet
`List<SnmpAttributeType>`	`getAliasAttributeTypes(SnmpCollectionAgent agent)` getAliasAttributeTypes
`Collection<SnmpAttributeType>`	`getAttributeTypes(SnmpCollectionAgent agent)` getAttributeTypes
`Collection<ResourceType>`	`getGenericIndexResourceTypes(SnmpCollectionAgent agent)` getGenericIndexResourceTypes
`IfAliasResourceType`	`getIfAliasResourceType(SnmpCollectionAgent agent)` getIfAliasResourceType
`IfResourceType`	`getIfResourceType(SnmpCollectionAgent agent)` getIfResourceType
`List<SnmpAttributeType>`	`getIndexedAttributeTypesForResourceType(SnmpCollectionAgent agent, ResourceType resourceType)` getIndexedAttributeTypesForResourceType
`String`	`getName()` getName
`List<SnmpAttributeType>`	`getNodeAttributeTypes(SnmpCollectionAgent agent)` getNodeAttributeTypes
`NodeResourceType`	`getNodeResourceType(SnmpCollectionAgent agent)` getNodeResourceType
`Collection<? extends CollectionResource>`	`getResources(SnmpCollectionAgent agent)` getResources
`ResourceType`	`getResourceType(SnmpCollectionAgent agent, String instanceName)` getResourceType
`ServiceParameters`	`getServiceParameters()` getServiceParameters
`String`	`getSnmpAuthPassPhrase(String current)` getSnmpAuthPassPhrase
`String`	`getSnmpAuthProtocol(String current)` getSnmpAuthProtocol
`int`	`getSnmpMaxRepetitions(int current)` getSnmpMaxRepetitions
`int`	`getSnmpMaxRequestSize(int current)` getSnmpMaxRequestSize
`int`	`getSnmpMaxVarsPerPdu(int current)` getSnmpMaxVarsPerPdu
`int`	`getSnmpPort(int current)` getSnmpPort
`String`	`getSnmpPrivPassPhrase(String current)` getSnmpPrivPassPhrase
`String`	`getSnmpPrivProtocol(String current)` getSnmpPrivProtocol
`InetAddress`	`getSnmpProxyFor(InetAddress current)` getSnmpProxyFor
`String`	`getSnmpReadCommunity(String current)` getSnmpReadCommunity
`int`	`getSnmpRetries(int current)` getSnmpRetries
`String`	`getSnmpSecurityName(String current)` getSnmpSecurityName
`int`	`getSnmpTimeout(int current)` getSnmpTimeout
`int`	`getSnmpVersion(int current)` getSnmpVersion
`String`	`getSnmpWriteCommunity(String current)` getSnmpWriteCommunity
`String`	`getStorageFlag()` getStorageFlag
`List<SnmpAttributeType>`	`loadAliasAttributeTypes(SnmpCollectionAgent agent)` loadAliasAttributeTypes
`List<SnmpAttributeType>`	`loadAttributeTypes(SnmpCollectionAgent agent, int ifType)` loadAttributeTypes
`void`	`setDataCollectionConfigDao(DataCollectionConfigDao config)` setDataCollectionConfig
`String`	`toString()` toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OnmsSnmpCollection
```
public OnmsSnmpCollection(SnmpCollectionAgent agent,
                  ServiceParameters params)
```
    Constructor for OnmsSnmpCollection.
    
    Parameters:
    agent - a CollectionAgent object.
    params - a ServiceParameters object.
  - OnmsSnmpCollection
```
public OnmsSnmpCollection(SnmpCollectionAgent agent,
                  ServiceParameters params,
                  DataCollectionConfigDao config)
```
    Constructor for OnmsSnmpCollection.
    
    Parameters:
    agent - a CollectionAgent object.
    params - a ServiceParameters object.
    config - a DataCollectionConfigDao object.
- Method Detail
  - getServiceParameters
```
public ServiceParameters getServiceParameters()
```
    getServiceParameters
    
    Returns:
    a ServiceParameters object.
  - getName
```
public String getName()
```
    getName
    
    Returns:
    a String object.
  - getSnmpPort
```
public int getSnmpPort(int current)
```
    getSnmpPort
    
    Parameters:
    current - a int.
    
    Returns:
    a int.
  - getSnmpRetries
```
public int getSnmpRetries(int current)
```
    getSnmpRetries
    
    Parameters:
    current - a int.
    
    Returns:
    a int.
  - getSnmpTimeout
```
public int getSnmpTimeout(int current)
```
    getSnmpTimeout
    
    Parameters:
    current - a int.
    
    Returns:
    a int.
  - getSnmpReadCommunity
```
public String getSnmpReadCommunity(String current)
```
    getSnmpReadCommunity
    
    Parameters:
    current - a String object.
    
    Returns:
    a String object.
  - getSnmpWriteCommunity
```
public String getSnmpWriteCommunity(String current)
```
    getSnmpWriteCommunity
    
    Parameters:
    current - a String object.
    
    Returns:
    a String object.
  - getSnmpProxyFor
```
public InetAddress getSnmpProxyFor(InetAddress current)
```
    getSnmpProxyFor
    
    Parameters:
    current - a InetAddress object.
    
    Returns:
    a InetAddress object.
  - getSnmpVersion
```
public int getSnmpVersion(int current)
```
    getSnmpVersion
    
    Parameters:
    current - a int.
    
    Returns:
    a int.
  - getSnmpMaxVarsPerPdu
```
public int getSnmpMaxVarsPerPdu(int current)
```
    getSnmpMaxVarsPerPdu
    
    Parameters:
    current - a int.
    
    Returns:
    a int.
  - getSnmpMaxRepetitions
```
public int getSnmpMaxRepetitions(int current)
```
    getSnmpMaxRepetitions
    
    Parameters:
    current - a int.
    
    Returns:
    a int.
  - getSnmpMaxRequestSize
```
public int getSnmpMaxRequestSize(int current)
```
    getSnmpMaxRequestSize
    
    Parameters:
    current - a int.
    
    Returns:
    a int.
  - getSnmpSecurityName
```
public String getSnmpSecurityName(String current)
```
    getSnmpSecurityName
    
    Parameters:
    current - a String object.
    
    Returns:
    a String object.
  - getSnmpAuthPassPhrase
```
public String getSnmpAuthPassPhrase(String current)
```
    getSnmpAuthPassPhrase
    
    Parameters:
    current - a String object.
    
    Returns:
    a String object.
  - getSnmpAuthProtocol
```
public String getSnmpAuthProtocol(String current)
```
    getSnmpAuthProtocol
    
    Parameters:
    current - a String object.
    
    Returns:
    a String object.
  - getSnmpPrivPassPhrase
```
public String getSnmpPrivPassPhrase(String current)
```
    getSnmpPrivPassPhrase
    
    Parameters:
    current - a String object.
    
    Returns:
    a String object.
  - getSnmpPrivProtocol
```
public String getSnmpPrivProtocol(String current)
```
    getSnmpPrivProtocol
    
    Parameters:
    current - a String object.
    
    Returns:
    a String object.
  - setDataCollectionConfigDao
```
public void setDataCollectionConfigDao(DataCollectionConfigDao config)
```
    setDataCollectionConfig
    
    Parameters:
    config - a DataCollectionConfigDao object.
  - getStorageFlag
```
public String getStorageFlag()
```
    getStorageFlag
    
    Returns:
    a String object.
  - toString
```
public String toString()
```
    toString
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a String object.
  - createCollectionSet
```
public SnmpCollectionSet createCollectionSet(SnmpCollectionAgent agent)
```
    createCollectionSet
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a SnmpCollectionSet object.
  - getIndexedAttributeTypesForResourceType
```
public List<SnmpAttributeType> getIndexedAttributeTypesForResourceType(SnmpCollectionAgent agent,
                                                              ResourceType resourceType)
```
    getIndexedAttributeTypesForResourceType
    
    Parameters:
    agent - a CollectionAgent object.
    resourceType - a ResourceType object.
    
    Returns:
    a List object.
  - getNodeAttributeTypes
```
public List<SnmpAttributeType> getNodeAttributeTypes(SnmpCollectionAgent agent)
```
    getNodeAttributeTypes
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a List object.
  - loadAttributeTypes
```
public List<SnmpAttributeType> loadAttributeTypes(SnmpCollectionAgent agent,
                                         int ifType)
```
    loadAttributeTypes
    
    Parameters:
    agent - a CollectionAgent object.
    ifType - a int.
    
    Returns:
    a List object.
  - getResourceType
```
public ResourceType getResourceType(SnmpCollectionAgent agent,
                           String instanceName)
```
    getResourceType
    
    Parameters:
    agent - a CollectionAgent object.
    instanceName - a String object.
    
    Returns:
    a ResourceType object.
  - getNodeResourceType
```
public NodeResourceType getNodeResourceType(SnmpCollectionAgent agent)
```
    getNodeResourceType
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a NodeResourceType object.
  - getIfResourceType
```
public IfResourceType getIfResourceType(SnmpCollectionAgent agent)
```
    getIfResourceType
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a IfResourceType object.
  - getIfAliasResourceType
```
public IfAliasResourceType getIfAliasResourceType(SnmpCollectionAgent agent)
```
    getIfAliasResourceType
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a IfAliasResourceType object.
  - getGenericIndexResourceTypes
```
public Collection<ResourceType> getGenericIndexResourceTypes(SnmpCollectionAgent agent)
```
    getGenericIndexResourceTypes
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a Collection object.
  - getAttributeTypes
```
public Collection<SnmpAttributeType> getAttributeTypes(SnmpCollectionAgent agent)
```
    getAttributeTypes
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a Collection object.
  - getResources
```
public Collection<? extends CollectionResource> getResources(SnmpCollectionAgent agent)
```
    getResources
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a Collection object.
  - loadAliasAttributeTypes
```
public List<SnmpAttributeType> loadAliasAttributeTypes(SnmpCollectionAgent agent)
```
    loadAliasAttributeTypes
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a List object.
  - getAliasAttributeTypes
```
public List<SnmpAttributeType> getAliasAttributeTypes(SnmpCollectionAgent agent)
```
    getAliasAttributeTypes
    
    Parameters:
    agent - a CollectionAgent object.
    
    Returns:
    a List object.

Class OnmsSnmpCollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OnmsSnmpCollection

OnmsSnmpCollection

Method Detail

getServiceParameters

getName

getSnmpPort

getSnmpRetries

getSnmpTimeout

getSnmpReadCommunity

getSnmpWriteCommunity

getSnmpProxyFor

getSnmpVersion

getSnmpMaxVarsPerPdu

getSnmpMaxRepetitions

getSnmpMaxRequestSize

getSnmpSecurityName

getSnmpAuthPassPhrase

getSnmpAuthProtocol

getSnmpPrivPassPhrase

getSnmpPrivProtocol

setDataCollectionConfigDao

getStorageFlag

toString

createCollectionSet

getIndexedAttributeTypesForResourceType

getNodeAttributeTypes

loadAttributeTypes

getResourceType

getNodeResourceType

getIfResourceType

getIfAliasResourceType

getGenericIndexResourceTypes

getAttributeTypes

getResources

loadAliasAttributeTypes

getAliasAttributeTypes