org.opennms.netmgt.capsd.snmp
Class NamedSnmpVar

java.lang.Object
  org.opennms.netmgt.capsd.snmp.NamedSnmpVar

All Implemented Interfaces:

Collectable

public final class NamedSnmpVar
extends Object
implements Collectable

The NamedSnmpVar class is used to associate a name for a particular snmp instance with its object identifier. Common names often include ifIndex, sysObjectId, etc al. These names are the names of particular variables as defined by the SMI. Should the instance also be part of a table, then the column number of the instance is also stored in the object.

Author:

Brian Weaver , Mike Davidson , OpenNMS

Field Summary

static String	SNMPCOUNTER32
static String	SNMPCOUNTER64
static String	SNMPENDOFMIBVIEW
static String	SNMPGAUGE32
static String	SNMPINT32
static String	SNMPIPADDRESS
static String	SNMPNOSUCHINSTANCE
static String	SNMPNOSUCHOBJECT
static String	SNMPNULL
static String	SNMPOBJECTID
static String	SNMPOCTETSTRING
static String	SNMPOPAQUE
static String	SNMPTIMETICKS
static String	SNMPUINT32
static String	SNMPV2PARTYCLOCK

Constructor Summary

NamedSnmpVar(String type, String alias, String oid)
This constructor creates a new instance of the class with the type, alias and object identifier.

NamedSnmpVar(String type, String alias, String oid, int column)
This constructor creates a new instance of the class with the type, alias, object identifier, and table column set.

Method Summary

String	getAlias() Returns the alias for the object identifier.
CollectionTracker	getCollectionTracker()
int	getColumn() Returns the column of the table this instance is in.
String	getOid() Returns the object identifer for this instance.
SnmpObjId	getSnmpObjId()
static CollectionTracker[]	getTrackersFor(NamedSnmpVar[] columns)
String	getType() Returns the class name stored in m_type which represents the expected SNMP data type of the object.
Class<?>	getTypeClass() Returns the class object associated with the class name stored in m_type.
boolean	isTableEntry() Returns true if this instance is part of a table.

Methods inherited from class java.lang.Object

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

Field Detail

SNMPINT32

public static final String SNMPINT32

See Also:

Constant Field Values

SNMPUINT32

public static final String SNMPUINT32

See Also:

Constant Field Values

SNMPCOUNTER32

public static final String SNMPCOUNTER32

See Also:

Constant Field Values

SNMPCOUNTER64

public static final String SNMPCOUNTER64

See Also:

Constant Field Values

SNMPGAUGE32

public static final String SNMPGAUGE32

See Also:

Constant Field Values

SNMPTIMETICKS

public static final String SNMPTIMETICKS

See Also:

Constant Field Values

SNMPOCTETSTRING

public static final String SNMPOCTETSTRING

See Also:

Constant Field Values

SNMPOPAQUE

public static final String SNMPOPAQUE

See Also:

Constant Field Values

SNMPIPADDRESS

public static final String SNMPIPADDRESS

See Also:

Constant Field Values

SNMPOBJECTID

public static final String SNMPOBJECTID

See Also:

Constant Field Values

SNMPV2PARTYCLOCK

public static final String SNMPV2PARTYCLOCK

See Also:

Constant Field Values

SNMPNOSUCHINSTANCE

public static final String SNMPNOSUCHINSTANCE

See Also:

Constant Field Values

SNMPNOSUCHOBJECT

public static final String SNMPNOSUCHOBJECT

See Also:

Constant Field Values

SNMPENDOFMIBVIEW

public static final String SNMPENDOFMIBVIEW

See Also:

Constant Field Values

SNMPNULL

public static final String SNMPNULL

See Also:

Constant Field Values

Constructor Detail

NamedSnmpVar

public NamedSnmpVar(String type,
                    String alias,
                    String oid)

This constructor creates a new instance of the class with the type, alias and object identifier. The instance is not considered to be part of a table.

Parameters:

type - The expected SNMP data type of this object.

alias - The alias for the object identifier.

oid - The object identifier for the instance.

NamedSnmpVar

public NamedSnmpVar(String type,
                    String alias,
                    String oid,
                    int column)

This constructor creates a new instance of the class with the type, alias, object identifier, and table column set. The instance is considered to be part of a table and the column is the "instance" number for the table.

Parameters:

type - The expected SNMP data type of this object.

alias - The alias for the object identifier.

oid - The object identifier for the instance.

column - The column entry for its table.

Method Detail

getType

public String getType()

Returns the class name stored in m_type which represents the expected SNMP data type of the object.

getTypeClass

public Class<?> getTypeClass()
                      throws ClassNotFoundException

Returns the class object associated with the class name stored in m_type.

Throws:

ClassNotFoundException - Thrown from this method if forName() fails.

getAlias

public String getAlias()

Returns the alias for the object identifier.

getOid

public String getOid()

Returns the object identifer for this instance.

getSnmpObjId

public SnmpObjId getSnmpObjId()

isTableEntry

public boolean isTableEntry()

Returns true if this instance is part of a table.

getCollectionTracker

public CollectionTracker getCollectionTracker()

Specified by:

getCollectionTracker in interface Collectable

getColumn

public int getColumn()

Returns the column of the table this instance is in. If the instance is not part of a table then the return code is not defined.

getTrackersFor

public static CollectionTracker[] getTrackersFor(NamedSnmpVar[] columns)