public class

JvmMemGCEntryMeta

extends SnmpMibEntry
implements SnmpStandardMetaServer Serializable
java.lang.Object
   ↳ com.sun.jmx.snmp.agent.SnmpMibNode
     ↳ com.sun.jmx.snmp.agent.SnmpMibEntry
       ↳ sun.management.snmp.jvmmib.JvmMemGCEntryMeta

Class Overview

The class is used for representing SNMP metadata for the "JvmMemGCEntry" group. The group is defined with the following oid: 1.3.6.1.4.1.42.2.145.3.163.1.1.2.101.1.

Summary

Fields
protected JvmMemGCEntryMBean node
protected SnmpStandardObjectServer objectserver
[Expand]
Inherited Fields
From class com.sun.jmx.snmp.agent.SnmpMibNode
Public Constructors
JvmMemGCEntryMeta(SnmpMib myMib, SnmpStandardObjectServer objserv)
Constructor for the metadata associated to "JvmMemGCEntry".
Public Methods
void check(SnmpMibSubRequest req, int depth)
Generic handling of the check operation.
void check(SnmpValue x, long var, Object data)
Check the value of a scalar variable
void get(SnmpMibSubRequest req, int depth)
Generic handling of the get operation.
SnmpValue get(long var, Object data)
Get the value of a scalar variable
String getAttributeName(long id)
Return the name of the attribute corresponding to the SNMP variable identified by "id".
boolean isReadable(long arc)
Returns true if "arc" identifies a readable scalar object.
boolean isVariable(long arc)
Returns true if "arc" identifies a scalar object.
void set(SnmpMibSubRequest req, int depth)
Generic handling of the set operation.
SnmpValue set(SnmpValue x, long var, Object data)
Set the value of a scalar variable
boolean skipVariable(long var, Object data, int pduVersion)
Hook for subclasses.
Protected Methods
void setInstance(JvmMemGCEntryMBean var)
Allow to bind the metadata description to a specific object.
[Expand]
Inherited Methods
From class com.sun.jmx.snmp.agent.SnmpMibEntry
From class com.sun.jmx.snmp.agent.SnmpMibNode
From class java.lang.Object
From interface com.sun.jmx.snmp.agent.SnmpStandardMetaServer

Fields

protected JvmMemGCEntryMBean node

protected SnmpStandardObjectServer objectserver

Public Constructors

public JvmMemGCEntryMeta (SnmpMib myMib, SnmpStandardObjectServer objserv)

Constructor for the metadata associated to "JvmMemGCEntry".

Public Methods

public 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

public void check (SnmpValue x, long var, Object data)

Check the value of a scalar variable

Parameters
x New value for the scalar object identified by arc
var OID arc of the scalar object whose value is set.
data A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Throws
SnmpStatusException

public 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

public SnmpValue get (long var, Object data)

Get the value of a scalar variable

Parameters
var OID arc of the querried scalar object.
data A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Returns
  • The SnmpValue of the scalar object identified by arc.
Throws
SnmpStatusException

public String getAttributeName (long id)

Return the name of the attribute corresponding to the SNMP variable identified by "id".

Throws
SnmpStatusException

public boolean isReadable (long arc)

Returns true if "arc" identifies a readable scalar object.

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

public boolean isVariable (long arc)

Returns true if "arc" identifies a scalar object.

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

public 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

public SnmpValue set (SnmpValue x, long var, Object data)

Set the value of a scalar variable

Parameters
x New value for the scalar object identified by arc
var OID arc of the scalar object whose value is set.
data A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Returns
  • The new SnmpValue of the scalar object identified by arc.
Throws
SnmpStatusException

public boolean skipVariable (long var, Object data, int pduVersion)

Hook for subclasses. The default implementation of this method is to always return false. Subclasses should redefine this method so that it returns true when:

  • the variable is a leaf that is not instantiated,
  • or the variable is a leaf whose type cannot be returned by that version of the protocol (e.g. an Counter64 with SNMPv1).

Parameters
var Id we start from looking for the next.
data A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
pduVersion Protocol version of the original request PDU.
Returns
  • true if the variable must be skipped by the get-next algorithm.

Protected Methods

protected void setInstance (JvmMemGCEntryMBean var)

Allow to bind the metadata description to a specific object.