Package org.opennms.netmgt.collectd

Class IfInfo

java.lang.Object

org.opennms.netmgt.collectd.SnmpCollectionResource

org.opennms.netmgt.collectd.IfInfo

All Implemented Interfaces:

CollectionResource, CollectionVisitable, Persistable, ResourceIdentifier

public final class IfInfo
extends SnmpCollectionResource

This class encapsulates all the information required by the SNMP collector in order to perform data collection for an individual interface and store that data in an appropriately named RRD file.

Version:

$Id: $

Author:

Mike Davidson , OpenNMS

Field Summary

Fields inherited from interface org.opennms.netmgt.collection.api.CollectionResource

RESOURCE_TYPE_IF, RESOURCE_TYPE_LATENCY, RESOURCE_TYPE_NODE

Constructor Summary

Constructors

Constructor	Description
IfInfo(ResourceType def, CollectionAgent agent, SnmpIfData snmpIfData)	Constructor for IfInfo.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	getAttributesMap()	getAttributesMap
protected SNMPCollectorEntry	getEntry()	getEntry
int	getIndex()	getIndex
java.lang.String	getInstance()	getInstance
java.lang.String	getInterfaceLabel()	getLabel
int	getNodeId()
ResourcePath	getParent()	Returns the name of the parent resource.
ResourcePath	getPath()	Retrieves path for the resource, relative to the root of the associated RrdRepository.
java.lang.String	getResourceTypeName()	getResourceTypeName
int	getSnmpIfType()	getType
java.lang.String	getUnmodifiedInstance()	getUnmodifiedInstance
boolean	isCollectionEnabled()	isCollectionEnabled
boolean	isScheduledForCollection()
void	setEntry(SNMPCollectorEntry ifEntry)	setEntry
void	setIfAlias(java.lang.String ifAlias)	setIfAlias
boolean	shouldPersist(ServiceParameters serviceParameters)	Determines whether the attribute should be persisted.
java.lang.String	toString()	toString

Methods inherited from class org.opennms.netmgt.collectd.SnmpCollectionResource

getCollectionAgent, getGroups, getGroupType, getOwnerName, getResourceType, getStringAttributes, getTimeKeeper, rescanNeeded, setAttributeValue, visit

Methods inherited from class java.lang.Object

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

Constructor Detail

IfInfo

public IfInfo(ResourceType def,
              CollectionAgent agent,
              SnmpIfData snmpIfData)

Constructor for IfInfo.

Parameters:

def - a ResourceType object.

agent - a CollectionAgent object.

snmpIfData - a SnmpIfData object.

Method Detail

getNodeId

public int getNodeId()

getIndex

public int getIndex()

getIndex

Returns:

a int.

getSnmpIfType

public int getSnmpIfType()

getType

Specified by:

getSnmpIfType in class SnmpCollectionResource

Returns:

a int.

getInterfaceLabel

public java.lang.String getInterfaceLabel()

getLabel

Returns:

a String object.

setIfAlias

public void setIfAlias(java.lang.String ifAlias)

setIfAlias

Parameters:

ifAlias - a String object.

isCollectionEnabled

public boolean isCollectionEnabled()

isCollectionEnabled

Returns:

a boolean.

setEntry

public void setEntry(SNMPCollectorEntry ifEntry)

setEntry

Parameters:

ifEntry - a SNMPCollectorEntry object.

getEntry

protected SNMPCollectorEntry getEntry()

getEntry

Returns:

a SNMPCollectorEntry object.

getAttributesMap

public java.util.Map<java.lang.String,java.lang.String> getAttributesMap()

getAttributesMap

Returns:

a Map object.

isScheduledForCollection

public boolean isScheduledForCollection()

getPath

public ResourcePath getPath()

Description copied from interface: ResourceIdentifier

Retrieves path for the resource, relative to the root of the associated RrdRepository.

Returns:

ResourcePath object.

toString

public java.lang.String toString()

toString

Overrides:

toString in class java.lang.Object

Returns:

a String object.

shouldPersist

public boolean shouldPersist(ServiceParameters serviceParameters)

Determines whether the attribute should be persisted.

Specified by:

shouldPersist in interface Persistable

Specified by:

shouldPersist in class SnmpCollectionResource

Parameters:

serviceParameters - a ServiceParameters object.

Returns:

a boolean.

getResourceTypeName

public java.lang.String getResourceTypeName()

getResourceTypeName

Returns:

a String object.

getInstance

public java.lang.String getInstance()

getInstance

Returns:

a String object.

getUnmodifiedInstance

public java.lang.String getUnmodifiedInstance()

getUnmodifiedInstance

Returns:

a String object.

getParent

public ResourcePath getParent()

Description copied from interface: CollectionResource

Returns the name of the parent resource.

Returns:

a String object.