org.opennms.netmgt.collectd
Class OnmsSnmpCollection

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.CollectionAgent) and to provide data to CollectionSet and other classes that are created during collection.

Version:

$Id: $

Author:

ranger

Constructor Summary

OnmsSnmpCollection(CollectionAgent agent, ServiceParameters params)
Constructor for OnmsSnmpCollection.

OnmsSnmpCollection(CollectionAgent agent, ServiceParameters params, DataCollectionConfig config)
Constructor for OnmsSnmpCollection.

Method Summary

SnmpCollectionSet	createCollectionSet(CollectionAgent agent) createCollectionSet
List<SnmpAttributeType>	getAliasAttributeTypes(CollectionAgent agent) getAliasAttributeTypes
Collection<SnmpAttributeType>	getAttributeTypes(CollectionAgent agent) getAttributeTypes
Collection<ResourceType>	getGenericIndexResourceTypes(CollectionAgent agent) getGenericIndexResourceTypes
IfAliasResourceType	getIfAliasResourceType(CollectionAgent agent) getIfAliasResourceType
IfResourceType	getIfResourceType(CollectionAgent agent) getIfResourceType
List<SnmpAttributeType>	getIndexedAttributeTypesForResourceType(CollectionAgent agent, ResourceType resourceType) getIndexedAttributeTypesForResourceType
String	getName() getName
List<SnmpAttributeType>	getNodeAttributeTypes(CollectionAgent agent) getNodeAttributeTypes
NodeResourceType	getNodeResourceType(CollectionAgent agent) getNodeResourceType
Collection<? extends CollectionResource>	getResources(CollectionAgent agent) getResources
ResourceType	getResourceType(CollectionAgent 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(CollectionAgent agent) loadAliasAttributeTypes
List<SnmpAttributeType>	loadAttributeTypes(CollectionAgent agent, int ifType) loadAttributeTypes
ThreadCategory	log() log
void	setDataCollectionConfig(DataCollectionConfig 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(CollectionAgent agent,
                          ServiceParameters params)

Constructor for OnmsSnmpCollection.

Parameters:

agent - a CollectionAgent object.

params - a ServiceParameters object.

OnmsSnmpCollection

public OnmsSnmpCollection(CollectionAgent agent,
                          ServiceParameters params,
                          DataCollectionConfig config)

Constructor for OnmsSnmpCollection.

Parameters:

agent - a CollectionAgent object.

params - a ServiceParameters object.

config - a DataCollectionConfig 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.

log

public ThreadCategory log()

log

Returns:

a ThreadCategory object.

setDataCollectionConfig

public void setDataCollectionConfig(DataCollectionConfig config)

setDataCollectionConfig

Parameters:

config - a DataCollectionConfig 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(CollectionAgent agent)

createCollectionSet

Parameters:

agent - a CollectionAgent object.

Returns:

a SnmpCollectionSet object.

getIndexedAttributeTypesForResourceType

public List<SnmpAttributeType> getIndexedAttributeTypesForResourceType(CollectionAgent agent,
                                                                       ResourceType resourceType)

getIndexedAttributeTypesForResourceType

Parameters:

agent - a CollectionAgent object.

resourceType - a ResourceType object.

Returns:

a List object.

getNodeAttributeTypes

public List<SnmpAttributeType> getNodeAttributeTypes(CollectionAgent agent)

getNodeAttributeTypes

Parameters:

agent - a CollectionAgent object.

Returns:

a List object.

loadAttributeTypes

public List<SnmpAttributeType> loadAttributeTypes(CollectionAgent agent,
                                                  int ifType)

loadAttributeTypes

Parameters:

agent - a CollectionAgent object.

ifType - a int.

Returns:

a List object.

getResourceType

public ResourceType getResourceType(CollectionAgent agent,
                                    String instanceName)

getResourceType

Parameters:

agent - a CollectionAgent object.

instanceName - a String object.

Returns:

a ResourceType object.

getNodeResourceType

public NodeResourceType getNodeResourceType(CollectionAgent agent)

getNodeResourceType

Parameters:

agent - a CollectionAgent object.

Returns:

a NodeResourceType object.

getIfResourceType

public IfResourceType getIfResourceType(CollectionAgent agent)

getIfResourceType

Parameters:

agent - a CollectionAgent object.

Returns:

a IfResourceType object.

getIfAliasResourceType

public IfAliasResourceType getIfAliasResourceType(CollectionAgent agent)

getIfAliasResourceType

Parameters:

agent - a CollectionAgent object.

Returns:

a IfAliasResourceType object.

getGenericIndexResourceTypes

public Collection<ResourceType> getGenericIndexResourceTypes(CollectionAgent agent)

getGenericIndexResourceTypes

Parameters:

agent - a CollectionAgent object.

Returns:

a Collection object.

getAttributeTypes

public Collection<SnmpAttributeType> getAttributeTypes(CollectionAgent agent)

getAttributeTypes

Parameters:

agent - a CollectionAgent object.

Returns:

a Collection object.

getResources

public Collection<? extends CollectionResource> getResources(CollectionAgent agent)

getResources

Parameters:

agent - a CollectionAgent object.

Returns:

a Collection object.

loadAliasAttributeTypes

public List<SnmpAttributeType> loadAliasAttributeTypes(CollectionAgent agent)

loadAliasAttributeTypes

Parameters:

agent - a CollectionAgent object.

Returns:

a List object.

getAliasAttributeTypes

public List<SnmpAttributeType> getAliasAttributeTypes(CollectionAgent agent)

getAliasAttributeTypes

Parameters:

agent - a CollectionAgent object.

Returns:

a List object.