public abstract class

SnmpMibEntry

extends SnmpMibNode
implements Serializable
java.lang.Object
   ↳ com.sun.jmx.snmp.agent.SnmpMibNode
     ↳ com.sun.jmx.snmp.agent.SnmpMibEntry
Known Direct Subclasses

Class Overview

Represents a node in an SNMP MIB which corresponds to a table entry meta node.

This class is used by the class generated by mibgen. You should not need to use this class directly.

This API is a Sun Microsystems internal API and is subject to change without notice.

Summary

[Expand]
Inherited Fields
From class com.sun.jmx.snmp.agent.SnmpMibNode
Public Constructors
SnmpMibEntry()
Public Methods
abstract void check(SnmpMibSubRequest req, int depth)
Generic handling of the check operation.
abstract void get(SnmpMibSubRequest req, int depth)
Generic handling of the get operation.
long getNextVarId(long id, Object userData)
Get the next OID arc corresponding to a readable scalar variable.
abstract boolean isReadable(long arc)
Tells whether the given arc identifies a readable scalar object in this entry.
abstract boolean isVariable(long arc)
Tells whether the given arc identifies a variable (scalar object) in this entry.
abstract void set(SnmpMibSubRequest req, int depth)
Generic handling of the set operation.
void validateVarId(long arc, Object userData)
Checks whether the given OID arc identifies a variable (columnar object).
[Expand]
Inherited Methods
From class com.sun.jmx.snmp.agent.SnmpMibNode
From class java.lang.Object

Public Constructors

public SnmpMibEntry ()

Public Methods

public abstract void check (SnmpMibSubRequest req, int depth)

Generic handling of the check operation.

The actual implementation of this method will be generated by mibgen. Usually, this implementation only delegates the job to some other provided runtime class, which knows how to access the MBean. The current toolkit thus provides two implementations:

  • The standard implementation will directly access the MBean through a java reference,
  • The generic implementation will access the MBean through the MBean server.

Both implementations rely upon specific - and distinct, set of mibgen generated methods.

You can override this method if you need to implement some specific policies for minimizing the accesses made to some remote underlying resources, or if you need to implement some consistency checks between the different values provided in the varbind list.

Parameters
req The sub-request that must be handled by this node.
depth The depth reached in the OID tree.
Throws
SnmpStatusException An error occurred while accessing the MIB node.

public abstract void get (SnmpMibSubRequest req, int depth)

Generic handling of the get operation.

The actual implementation of this method will be generated by mibgen. Usually, this implementation only delegates the job to some other provided runtime class, which knows how to access the MBean. The current toolkit thus provides two implementations:

  • The standard implementation will directly access the MBean through a java reference,
  • The generic implementation will access the MBean through the MBean server.

Both implementations rely upon specific - and distinct, set of mibgen generated methods.

You can override this method if you need to implement some specific policies for minimizing the accesses made to some remote underlying resources.

Parameters
req The sub-request that must be handled by this node.
depth The depth reached in the OID tree.
Throws
SnmpStatusException An error occurred while accessing the MIB node.

public long getNextVarId (long id, Object userData)

Get the next OID arc corresponding to a readable scalar variable.

Parameters
id Id we start from looking for the next.
userData A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Returns
  • The next id in this group.
Throws
SnmpStatusException

public abstract boolean isReadable (long arc)

Tells whether the given arc identifies a readable scalar object in this entry.

Parameters
arc An OID arc.
Returns
  • true if `arc' leads to a readable variable.

public abstract boolean isVariable (long arc)

Tells whether the given arc identifies a variable (scalar object) in this entry.

Parameters
arc An OID arc.
Returns
  • true if `arc' leads to a variable.

public abstract void set (SnmpMibSubRequest req, int depth)

Generic handling of the set operation.

The actual implementation of this method will be generated by mibgen. Usually, this implementation only delegates the job to some other provided runtime class, which knows how to access the MBean. The current toolkit thus provides two implementations:

  • The standard implementation will directly access the MBean through a java reference,
  • The generic implementation will access the MBean through the MBean server.

Both implementations rely upon specific - and distinct, set of mibgen generated methods.

You can override this method if you need to implement some specific policies for minimizing the accesses made to some remote underlying resources.

Parameters
req The sub-request that must be handled by this node.
depth The depth reached in the OID tree.
Throws
SnmpStatusException An error occurred while accessing the MIB node.

public void validateVarId (long arc, Object userData)

Checks whether the given OID arc identifies a variable (columnar object).

Parameters
userData A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Throws
the given `arc' does not identify any variable in this group, throws an SnmpStatusException.
SnmpStatusException