FileDocCategorySizeDatePackage
SnmpMibEntry.javaAPI DocJava SE 5 API6470Fri Aug 26 14:55:04 BST 2005com.sun.jmx.snmp.agent

SnmpMibEntry

public abstract class SnmpMibEntry extends com.sun.jmx.snmp.agent.SnmpMibNode implements Serializable
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.

version
4.3 10/29/99
author
Sun Microsystems, Inc

Fields Summary
Constructors Summary
Methods Summary
public abstract voidcheck(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.

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

public abstract voidget(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.

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

public longgetNextVarId(long id, java.lang.Object userData)
Get the next OID arc corresponding to a readable scalar variable.

	long nextvar = super.getNextVarId(id,userData);
	while (!isReadable(nextvar)) 
	    nextvar = super.getNextVarId(nextvar,userData);
	return nextvar;
    
public abstract booleanisReadable(long arc)
Tells whether the given arc identifies a readable scalar object in this entry.

param
arc An OID arc.
return
true if `arc' leads to a readable variable.

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

param
arc An OID arc.
return
true if `arc' leads to a variable.

public abstract voidset(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.

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

public voidvalidateVarId(long arc, java.lang.Object userData)
Checks whether the given OID arc identifies a variable (columnar object).

param
userData A contextual object containing user-data. This object is allocated through the {@link com.sun.jmx.snmp.agent.SnmpUserDataFactory} for each incoming SNMP request.
exception
If the given `arc' does not identify any variable in this group, throws an SnmpStatusException.

	if (isVariable(arc) == false) throw noSuchNameException;