public abstract class

SnmpMibGroup

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

Class Overview

Represents a node in an SNMP MIB which corresponds to a group. This class allows subnodes to be registered below a group, providing support for nested groups. The subnodes are registered at run time when registering the nested groups in the global MIB OID tree.

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

Fields
protected Hashtable<Long, Long> subgroups
[Expand]
Inherited Fields
From class com.sun.jmx.snmp.agent.SnmpMibNode
Public Constructors
SnmpMibGroup()
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.
void getRootOid(Vector result)
Computes the root OID of the MIB.
abstract SnmpMibTable getTable(long arc)
Gets the table identified by the given `arc'.
boolean isNestedArc(long arc)
Tell whether the given OID arc identifies a sub-tree leading to a nested SNMP sub-group.
abstract boolean isReadable(long arc)
Tells whether the given arc identifies a readable scalar object in this group.
abstract boolean isTable(long arc)
Tells whether the given arc identifies a table in this group.
abstract boolean isVariable(long arc)
Tells whether the given arc identifies a variable (scalar object) in this group.
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 (scalar object).
Protected Methods
void registerObject(long arc)
Register an OID arc that identifies a scalar object or a table.
[Expand]
Inherited Methods
From class com.sun.jmx.snmp.agent.SnmpMibOid
From class com.sun.jmx.snmp.agent.SnmpMibNode
From class java.lang.Object

Fields

protected Hashtable<Long, Long> subgroups

Public Constructors

public SnmpMibGroup ()

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 void getRootOid (Vector result)

Computes the root OID of the MIB.

public abstract SnmpMibTable getTable (long arc)

Gets the table identified by the given `arc'.

Parameters
arc An OID arc.
Returns
  • The SnmpMibTable identified by `arc', or null if `arc' does not identify any table.

public boolean isNestedArc (long arc)

Tell whether the given OID arc identifies a sub-tree leading to a nested SNMP sub-group. This method is used internally. You shouldn't need to call it directly.

Parameters
arc An OID arc.
Returns
  • true if the given OID arc identifies a subtree leading to a nested SNMP sub-group.

public abstract boolean isReadable (long arc)

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

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

public abstract boolean isTable (long arc)

Tells whether the given arc identifies a table in this group.

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

public abstract boolean isVariable (long arc)

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

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 (scalar object).

Throws
the given `arc' does not identify any variable in this group, throws an SnmpStatusException.
SnmpStatusException

Protected Methods

protected void registerObject (long arc)

Register an OID arc that identifies a scalar object or a table. This method is used internally. You shouldn't ever call it directly.

Parameters
arc An OID arc.
Throws
IllegalAccessException