Package org.opennms.netmgt.snmp

Class NamedSnmpVar

java.lang.Object

org.opennms.netmgt.snmp.NamedSnmpVar

public final class NamedSnmpVar
extends java.lang.Object

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.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SNMPCOUNTER32	Constant SNMPCOUNTER32="org.opennms.protocols.snmp.SnmpCounter3"{trunked}
static java.lang.String	SNMPCOUNTER64	Constant SNMPCOUNTER64="org.opennms.protocols.snmp.SnmpCounter6"{trunked}
static java.lang.String	SNMPENDOFMIBVIEW	Constant SNMPENDOFMIBVIEW="org.opennms.protocols.snmp.SnmpEndOfMib"{trunked}
static java.lang.String	SNMPGAUGE32	Constant SNMPGAUGE32="org.opennms.protocols.snmp.SnmpGauge32"
static java.lang.String	SNMPINT32	Constant SNMPINT32="org.opennms.protocols.snmp.SnmpInt32"
static java.lang.String	SNMPIPADDRESS	Constant SNMPIPADDRESS="org.opennms.protocols.snmp.SnmpIPAddres"{trunked}
static java.lang.String	SNMPNOSUCHINSTANCE	Constant SNMPNOSUCHINSTANCE="org.opennms.protocols.snmp.SnmpNoSuchIn"{trunked}
static java.lang.String	SNMPNOSUCHOBJECT	Constant SNMPNOSUCHOBJECT="org.opennms.protocols.snmp.SnmpNoSuchOb"{trunked}
static java.lang.String	SNMPNULL	Constant SNMPNULL="org.opennms.protocols.snmp.SnmpNull"
static java.lang.String	SNMPOBJECTID	Constant SNMPOBJECTID="org.opennms.protocols.snmp.SnmpObjectId"
static java.lang.String	SNMPOCTETSTRING	Constant SNMPOCTETSTRING="org.opennms.protocols.snmp.SnmpOctetStr"{trunked}
static java.lang.String	SNMPOPAQUE	Constant SNMPOPAQUE="org.opennms.protocols.snmp.SnmpOpaque"
static java.lang.String	SNMPTIMETICKS	Constant SNMPTIMETICKS="org.opennms.protocols.snmp.SnmpTimeTick"{trunked}
static java.lang.String	SNMPUINT32	Constant SNMPUINT32="org.opennms.protocols.snmp.SnmpUInt32"
static java.lang.String	SNMPV2PARTYCLOCK	Constant SNMPV2PARTYCLOCK="org.opennms.protocols.snmp.SnmpV2PartyC"{trunked}

Constructor Summary

Constructors

Constructor	Description
NamedSnmpVar(java.lang.String type, java.lang.String alias, java.lang.String oid)	This constructor creates a new instance of the class with the type, alias and object identifier.
NamedSnmpVar(java.lang.String type, java.lang.String alias, java.lang.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

Modifier and Type	Method	Description
java.lang.String	getAlias()	Returns the alias for the object identifier.
CollectionTracker	getCollectionTracker(java.util.Set<SnmpInstId> instances)	getCollectionTracker
int	getColumn()	Returns the column of the table this instance is in.
java.lang.String	getOid()	Returns the object identifer for this instance.
SnmpObjId	getSnmpObjId()	getSnmpObjId
static CollectionTracker[]	getTrackersFor(NamedSnmpVar[] columns)	getTrackersFor
static CollectionTracker[]	getTrackersFor(NamedSnmpVar[] columns, java.util.Set<SnmpInstId> instances)	getTrackersFor
java.lang.String	getType()	Returns the class name stored in m_type which represents the expected SNMP data type of the object.
java.lang.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 java.lang.String SNMPINT32

Constant SNMPINT32="org.opennms.protocols.snmp.SnmpInt32"

See Also:

Constant Field Values

SNMPUINT32

public static final java.lang.String SNMPUINT32

Constant SNMPUINT32="org.opennms.protocols.snmp.SnmpUInt32"

See Also:

Constant Field Values

SNMPCOUNTER32

public static final java.lang.String SNMPCOUNTER32

Constant SNMPCOUNTER32="org.opennms.protocols.snmp.SnmpCounter3"{trunked}

See Also:

Constant Field Values

SNMPCOUNTER64

public static final java.lang.String SNMPCOUNTER64

Constant SNMPCOUNTER64="org.opennms.protocols.snmp.SnmpCounter6"{trunked}

See Also:

Constant Field Values

SNMPGAUGE32

public static final java.lang.String SNMPGAUGE32

Constant SNMPGAUGE32="org.opennms.protocols.snmp.SnmpGauge32"

See Also:

Constant Field Values

SNMPTIMETICKS

public static final java.lang.String SNMPTIMETICKS

Constant SNMPTIMETICKS="org.opennms.protocols.snmp.SnmpTimeTick"{trunked}

See Also:

Constant Field Values

SNMPOCTETSTRING

public static final java.lang.String SNMPOCTETSTRING

Constant SNMPOCTETSTRING="org.opennms.protocols.snmp.SnmpOctetStr"{trunked}

See Also:

Constant Field Values

SNMPOPAQUE

public static final java.lang.String SNMPOPAQUE

Constant SNMPOPAQUE="org.opennms.protocols.snmp.SnmpOpaque"

See Also:

Constant Field Values

SNMPIPADDRESS

public static final java.lang.String SNMPIPADDRESS

Constant SNMPIPADDRESS="org.opennms.protocols.snmp.SnmpIPAddres"{trunked}

See Also:

Constant Field Values

SNMPOBJECTID

public static final java.lang.String SNMPOBJECTID

Constant SNMPOBJECTID="org.opennms.protocols.snmp.SnmpObjectId"

See Also:

Constant Field Values

SNMPV2PARTYCLOCK

public static final java.lang.String SNMPV2PARTYCLOCK

Constant SNMPV2PARTYCLOCK="org.opennms.protocols.snmp.SnmpV2PartyC"{trunked}

See Also:

Constant Field Values

SNMPNOSUCHINSTANCE

public static final java.lang.String SNMPNOSUCHINSTANCE

Constant SNMPNOSUCHINSTANCE="org.opennms.protocols.snmp.SnmpNoSuchIn"{trunked}

See Also:

Constant Field Values

SNMPNOSUCHOBJECT

public static final java.lang.String SNMPNOSUCHOBJECT

Constant SNMPNOSUCHOBJECT="org.opennms.protocols.snmp.SnmpNoSuchOb"{trunked}

See Also:

Constant Field Values

SNMPENDOFMIBVIEW

public static final java.lang.String SNMPENDOFMIBVIEW

Constant SNMPENDOFMIBVIEW="org.opennms.protocols.snmp.SnmpEndOfMib"{trunked}

See Also:

Constant Field Values

SNMPNULL

public static final java.lang.String SNMPNULL

Constant SNMPNULL="org.opennms.protocols.snmp.SnmpNull"

See Also:

Constant Field Values

Constructor Detail

NamedSnmpVar

public NamedSnmpVar(java.lang.String type,
                    java.lang.String alias,
                    java.lang.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(java.lang.String type,
                    java.lang.String alias,
                    java.lang.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 java.lang.String getType()

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

Returns:

a String object.

getTypeClass

public java.lang.Class<?> getTypeClass()
                                throws java.lang.ClassNotFoundException

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

Returns:

a Class object.

Throws:

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

java.lang.ClassNotFoundException - if any.

getAlias

public java.lang.String getAlias()

Returns the alias for the object identifier.

Returns:

a String object.

getOid

public java.lang.String getOid()

Returns the object identifer for this instance.

Returns:

a String object.

getSnmpObjId

public SnmpObjId getSnmpObjId()

getSnmpObjId

Returns:

a SnmpObjId object.

isTableEntry

public boolean isTableEntry()

Returns true if this instance is part of a table.

Returns:

a boolean.

getCollectionTracker

public CollectionTracker getCollectionTracker(java.util.Set<SnmpInstId> instances)

getCollectionTracker

Parameters:

instances - a Set object.

Returns:

a CollectionTracker object.

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.

Returns:

a int.

getTrackersFor

public static CollectionTracker[] getTrackersFor(NamedSnmpVar[] columns,
                                                 java.util.Set<SnmpInstId> instances)

getTrackersFor

Parameters:

columns - an array of NamedSnmpVar objects.

instances - a Set object.

Returns:

an array of CollectionTracker objects.

getTrackersFor

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

getTrackersFor

Parameters:

columns - an array of NamedSnmpVar objects.

Returns:

an array of CollectionTracker objects.