Package org.netxms.client.snmp

Class MibObject

java.lang.Object

org.netxms.client.snmp.MibObject

public class MibObject
extends Object

This class represents single MIB tree object.

Field Summary

Fields

Modifier and Type	Field	Description
static int	ACCESS_CREATE
static int	ACCESS_NOACCESS
static int	ACCESS_NOTIFY
static int	ACCESS_READONLY
static int	ACCESS_READWRITE
static int	ACCESS_WRITEONLY
protected static int	MIB_END_OF_TAG
protected static int	MIB_TAG_ACCESS
protected static int	MIB_TAG_BYTE_OID
protected static int	MIB_TAG_DESCRIPTION
protected static int	MIB_TAG_DWORD_OID
protected static int	MIB_TAG_NAME
protected static int	MIB_TAG_OBJECT
protected static int	MIB_TAG_STATUS
protected static int	MIB_TAG_TEXTUAL_CONVENTION
protected static int	MIB_TAG_TYPE
protected static int	MIB_TAG_WORD_OID
static int	MIB_TYPE_AGENTCAP
static int	MIB_TYPE_BITSTRING
static int	MIB_TYPE_CHOICE
static int	MIB_TYPE_COUNTER
static int	MIB_TYPE_COUNTER32
static int	MIB_TYPE_COUNTER64
static int	MIB_TYPE_GAUGE
static int	MIB_TYPE_GAUGE32
static int	MIB_TYPE_IMPORT_ITEM
static int	MIB_TYPE_INTEGER
static int	MIB_TYPE_INTEGER32
static int	MIB_TYPE_INTEGER64
static int	MIB_TYPE_IPADDR
static int	MIB_TYPE_MACRO_DEFINITION
static int	MIB_TYPE_MODCOMP
static int	MIB_TYPE_MODID
static int	MIB_TYPE_NAMED_TYPE
static int	MIB_TYPE_NETADDR
static int	MIB_TYPE_NOTIFGROUP
static int	MIB_TYPE_NOTIFTYPE
static int	MIB_TYPE_NSAPADDRESS
static int	MIB_TYPE_NULL
static int	MIB_TYPE_OBJGROUP
static int	MIB_TYPE_OBJID
static int	MIB_TYPE_OCTETSTR
static int	MIB_TYPE_OPAQUE
static int	MIB_TYPE_OTHER
static int	MIB_TYPE_PHYSADDR
static int	MIB_TYPE_SEQID
static int	MIB_TYPE_SEQUENCE
static int	MIB_TYPE_TEXTUAL_CONVENTION
static int	MIB_TYPE_TIMETICKS
static int	MIB_TYPE_TRAPTYPE
static int	MIB_TYPE_UINTEGER
static int	MIB_TYPE_UNSIGNED32
static int	STATUS_CURRENT
static int	STATUS_DEPRECATED
static int	STATUS_MANDATORY
static int	STATUS_OBSOLETE
static int	STATUS_OPTIONAL

Constructor Summary

Constructors

Modifier	Constructor	Description
	MibObject()	Default constructor - create empty "[root]" object.
protected	MibObject(org.netxms.base.NXCPDataInputStream in, MibObject parent)	Read MIB object from compiled MIB file

Method Summary

Modifier and Type	Method	Description
protected MibObject	findChildObject(SnmpObjectId oid)	Find child object with given ID
int	getAccess()
MibObject[]	getChildObjects()	Get all child objects
String	getDescription()
String	getFullName()	Get object's full name (including all parents)
long	getId()
String	getName()
SnmpObjectId	getObjectId()
MibObject	getParent()
int	getStatus()
String	getTextualConvention()
int	getType()
boolean	hasChildren()	Check if object has child objects.

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_MANDATORY

public static final int STATUS_MANDATORY

See Also:

Constant Field Values

STATUS_OPTIONAL

public static final int STATUS_OPTIONAL

See Also:

Constant Field Values

STATUS_OBSOLETE

public static final int STATUS_OBSOLETE

See Also:

Constant Field Values

STATUS_DEPRECATED

public static final int STATUS_DEPRECATED

See Also:

Constant Field Values

STATUS_CURRENT

public static final int STATUS_CURRENT

See Also:

Constant Field Values

ACCESS_READONLY

public static final int ACCESS_READONLY

See Also:

Constant Field Values

ACCESS_READWRITE

public static final int ACCESS_READWRITE

See Also:

Constant Field Values

ACCESS_WRITEONLY

public static final int ACCESS_WRITEONLY

See Also:

Constant Field Values

ACCESS_NOACCESS

public static final int ACCESS_NOACCESS

See Also:

Constant Field Values

ACCESS_NOTIFY

public static final int ACCESS_NOTIFY

See Also:

Constant Field Values

ACCESS_CREATE

public static final int ACCESS_CREATE

See Also:

Constant Field Values

MIB_TYPE_OTHER

public static final int MIB_TYPE_OTHER

See Also:

Constant Field Values

MIB_TYPE_IMPORT_ITEM

public static final int MIB_TYPE_IMPORT_ITEM

See Also:

Constant Field Values

MIB_TYPE_OBJID

public static final int MIB_TYPE_OBJID

See Also:

Constant Field Values

MIB_TYPE_BITSTRING

public static final int MIB_TYPE_BITSTRING

See Also:

Constant Field Values

MIB_TYPE_INTEGER

public static final int MIB_TYPE_INTEGER

See Also:

Constant Field Values

MIB_TYPE_INTEGER32

public static final int MIB_TYPE_INTEGER32

See Also:

Constant Field Values

MIB_TYPE_INTEGER64

public static final int MIB_TYPE_INTEGER64

See Also:

Constant Field Values

MIB_TYPE_UNSIGNED32

public static final int MIB_TYPE_UNSIGNED32

See Also:

Constant Field Values

MIB_TYPE_COUNTER

public static final int MIB_TYPE_COUNTER

See Also:

Constant Field Values

MIB_TYPE_COUNTER32

public static final int MIB_TYPE_COUNTER32

See Also:

Constant Field Values

MIB_TYPE_COUNTER64

public static final int MIB_TYPE_COUNTER64

See Also:

Constant Field Values

MIB_TYPE_GAUGE

public static final int MIB_TYPE_GAUGE

See Also:

Constant Field Values

MIB_TYPE_GAUGE32

public static final int MIB_TYPE_GAUGE32

See Also:

Constant Field Values

MIB_TYPE_TIMETICKS

public static final int MIB_TYPE_TIMETICKS

See Also:

Constant Field Values

MIB_TYPE_OCTETSTR

public static final int MIB_TYPE_OCTETSTR

See Also:

Constant Field Values

MIB_TYPE_OPAQUE

public static final int MIB_TYPE_OPAQUE

See Also:

Constant Field Values

MIB_TYPE_IPADDR

public static final int MIB_TYPE_IPADDR

See Also:

Constant Field Values

MIB_TYPE_PHYSADDR

public static final int MIB_TYPE_PHYSADDR

See Also:

Constant Field Values

MIB_TYPE_NETADDR

public static final int MIB_TYPE_NETADDR

See Also:

Constant Field Values

MIB_TYPE_NAMED_TYPE

public static final int MIB_TYPE_NAMED_TYPE

See Also:

Constant Field Values

MIB_TYPE_SEQID

public static final int MIB_TYPE_SEQID

See Also:

Constant Field Values

MIB_TYPE_SEQUENCE

public static final int MIB_TYPE_SEQUENCE

See Also:

Constant Field Values

MIB_TYPE_CHOICE

public static final int MIB_TYPE_CHOICE

See Also:

Constant Field Values

MIB_TYPE_TEXTUAL_CONVENTION

public static final int MIB_TYPE_TEXTUAL_CONVENTION

See Also:

Constant Field Values

MIB_TYPE_MACRO_DEFINITION

public static final int MIB_TYPE_MACRO_DEFINITION

See Also:

Constant Field Values

MIB_TYPE_MODCOMP

public static final int MIB_TYPE_MODCOMP

See Also:

Constant Field Values

MIB_TYPE_TRAPTYPE

public static final int MIB_TYPE_TRAPTYPE

See Also:

Constant Field Values

MIB_TYPE_NOTIFTYPE

public static final int MIB_TYPE_NOTIFTYPE

See Also:

Constant Field Values

MIB_TYPE_MODID

public static final int MIB_TYPE_MODID

See Also:

Constant Field Values

MIB_TYPE_NSAPADDRESS

public static final int MIB_TYPE_NSAPADDRESS

See Also:

Constant Field Values

MIB_TYPE_AGENTCAP

public static final int MIB_TYPE_AGENTCAP

See Also:

Constant Field Values

MIB_TYPE_UINTEGER

public static final int MIB_TYPE_UINTEGER

See Also:

Constant Field Values

MIB_TYPE_NULL

public static final int MIB_TYPE_NULL

See Also:

Constant Field Values

MIB_TYPE_OBJGROUP

public static final int MIB_TYPE_OBJGROUP

See Also:

Constant Field Values

MIB_TYPE_NOTIFGROUP

public static final int MIB_TYPE_NOTIFGROUP

See Also:

Constant Field Values

MIB_TAG_OBJECT

protected static final int MIB_TAG_OBJECT

See Also:

Constant Field Values

MIB_TAG_NAME

protected static final int MIB_TAG_NAME

See Also:

Constant Field Values

MIB_TAG_DESCRIPTION

protected static final int MIB_TAG_DESCRIPTION

See Also:

Constant Field Values

MIB_TAG_ACCESS

protected static final int MIB_TAG_ACCESS

See Also:

Constant Field Values

MIB_TAG_STATUS

protected static final int MIB_TAG_STATUS

See Also:

Constant Field Values

MIB_TAG_TYPE

protected static final int MIB_TAG_TYPE

See Also:

Constant Field Values

MIB_TAG_BYTE_OID

protected static final int MIB_TAG_BYTE_OID

See Also:

Constant Field Values

MIB_TAG_WORD_OID

protected static final int MIB_TAG_WORD_OID

See Also:

Constant Field Values

MIB_TAG_DWORD_OID

protected static final int MIB_TAG_DWORD_OID

See Also:

Constant Field Values

MIB_TAG_TEXTUAL_CONVENTION

protected static final int MIB_TAG_TEXTUAL_CONVENTION

See Also:

Constant Field Values

MIB_END_OF_TAG

protected static final int MIB_END_OF_TAG

See Also:

Constant Field Values

Constructor Detail

MibObject

public MibObject()

Default constructor - create empty "[root]" object.

MibObject

protected MibObject(org.netxms.base.NXCPDataInputStream in,
                    MibObject parent)
             throws IOException,
                    NXCException

Read MIB object from compiled MIB file

Parameters:

in - Input stream attached to MIB file

Throws:

IOException

NXCException

Method Detail

getId

public long getId()

Returns:

the id

getName

public String getName()

Returns:

the name

getFullName

public String getFullName()

Get object's full name (including all parents)

Returns:

object's full name (including all parents)

getDescription

public String getDescription()

Returns:

the description

getType

public int getType()

Returns:

the type

getStatus

public int getStatus()

Returns:

the status

getAccess

public int getAccess()

Returns:

the access

getChildObjects

public MibObject[] getChildObjects()

Get all child objects

Returns:

Array of child objects

getParent

public MibObject getParent()

Returns:

the parent

getObjectId

public SnmpObjectId getObjectId()

Returns:

the objectId

hasChildren

public boolean hasChildren()

Check if object has child objects.

Returns:

true if object has child objects

findChildObject

protected MibObject findChildObject(SnmpObjectId oid)

Find child object with given ID

Parameters:

oid - SNMP object ID

Returns:

MIB object with given OID or null

getTextualConvention

public final String getTextualConvention()

Returns:

the textualConvention