Package org.opennms.netmgt.collectd

Class SnmpAttributeType

java.lang.Object

org.opennms.netmgt.collection.support.AbstractCollectionAttributeType

org.opennms.netmgt.collectd.SnmpAttributeType

All Implemented Interfaces:

CollectionAttributeType

Direct Known Subclasses:

HexStringAttributeType, MibPropertyAttributeType, NumericAttributeType, StringAttributeType, ValueMappingAttributeType

public abstract class SnmpAttributeType
extends AbstractCollectionAttributeType

Represents an OID to be collected (it might be specific or an indexed object). Also specific to a collection (e.g.: "default"), resource type (e.g.: node or interface), and attribute group (data collection group name, e.g.: "mib2-interfaces"). This is extended to create concrete classes that represent specific types of data to be stored such as numeric data ({@link (NumericAttributeType)}) or string data ({@link (StringAttributeType)}).

Version:

$Id: $

Author:

ranger

Field Summary

Fields

Modifier and Type	Field	Description
protected MibObject	m_mibObj

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SnmpAttributeType(ResourceType resourceType, String collectionName, MibObject mibObj, AttributeGroupType groupType)	Constructor for SnmpAttributeType.

Method Summary

Modifier and Type	Method	Description
static SnmpAttributeType	create(ResourceType resourceType, String collectionName, MibObject mibObj, AttributeGroupType groupType)	create
boolean	equals(Object obj)	equals
String	getAlias()	getAlias
protected String	getCollectionName()	getCollectionName
static List<Collectable>	getCollectionTrackers(Collection<SnmpAttributeType> objList)	getCollectionTrackers
String	getGroupIfType()	getGroupIfType
String	getGroupName()	getGroupName
String	getInstance()	getInstance
String	getName()	getName
String	getOid()	getOid
ResourceType	getResourceType()	getResourceType
int	hashCode()	hashCode
boolean	matches(SnmpObjId base, SnmpInstId inst)	matches
abstract void	storeAttribute(CollectionAttribute attribute, Persister persister)	storeAttribute
void	storeResult(SnmpCollectionSet collectionSet, SNMPCollectorEntry entry, SnmpResult res)	storeResult
String	toString()	toString

Methods inherited from class org.opennms.netmgt.collection.support.AbstractCollectionAttributeType

getGroupType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opennms.netmgt.collection.api.CollectionAttributeType

getType

Field Detail

m_mibObj

protected final MibObject m_mibObj

Constructor Detail

SnmpAttributeType

protected SnmpAttributeType(ResourceType resourceType,
                            String collectionName,
                            MibObject mibObj,
                            AttributeGroupType groupType)

Constructor for SnmpAttributeType.

Parameters:

resourceType - a ResourceType object.

collectionName - a String object.

mibObj - a MibObject object.

groupType - a AttributeGroupType object.

Method Detail

getCollectionName

protected String getCollectionName()

getCollectionName

Returns:

a String object.

getCollectionTrackers

public static List<Collectable> getCollectionTrackers(Collection<SnmpAttributeType> objList)

getCollectionTrackers

Parameters:

objList - a Collection object.

Returns:

a List object.

create

public static SnmpAttributeType create(ResourceType resourceType,
                                       String collectionName,
                                       MibObject mibObj,
                                       AttributeGroupType groupType)

create

Parameters:

resourceType - a ResourceType object.

collectionName - a String object.

mibObj - a MibObject object.

groupType - a AttributeGroupType object.

Returns:

a SnmpAttributeType object.

getResourceType

public ResourceType getResourceType()

getResourceType

Returns:

a ResourceType object.

getGroupName

public String getGroupName()

getGroupName

Returns:

a String object.

getAlias

public String getAlias()

getAlias

Returns:

a String object.

getOid

public String getOid()

getOid

Returns:

a String object.

getInstance

public String getInstance()

getInstance

Returns:

a String object.

getName

public String getName()

getName

Returns:

a String object.

storeAttribute

public abstract void storeAttribute(CollectionAttribute attribute,
                                    Persister persister)

storeAttribute

Parameters:

attribute - a CollectionAttribute object.

persister - a Persister object.

storeResult

public void storeResult(SnmpCollectionSet collectionSet,
                        SNMPCollectorEntry entry,
                        SnmpResult res)

storeResult

Parameters:

collectionSet - a SnmpCollectionSet object.

entry - a SNMPCollectorEntry object.

res - a SnmpResult object.

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.

equals

public boolean equals(Object obj)

equals

Specified by:

equals in interface CollectionAttributeType

Overrides:

equals in class Object

Parameters:

obj - a Object object.

Returns:

a boolean.

hashCode

public int hashCode()

hashCode

Specified by:

hashCode in interface CollectionAttributeType

Overrides:

hashCode in class Object

Returns:

a int.

getGroupIfType

public String getGroupIfType()

getGroupIfType

Returns:

a String object.

matches

public boolean matches(SnmpObjId base,
                       SnmpInstId inst)

matches

Parameters:

base - a SnmpObjId object.

inst - a SnmpInstId object.

Returns:

a boolean.