public interface

SnmpGenericMetaServer

com.sun.jmx.snmp.agent.SnmpGenericMetaServer

Class Overview

This interface defines the methods that must be implemented by an SNMP metadata object that needs to interact with an SnmpGenericObjectServer object.

All these methods are usually generated by mibgen when run in generic-metadata mode.

This interface is used internally between the generated Metadata and the SNMP runtime and you shouldn't need to worry about it, because you will never have to use it directly.

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

Summary

Public Methods
abstract Object buildAttributeValue(long id, SnmpValue value)
Construct an attribute value (as returned by Attribute::getValue()) from an SnmpValue.
abstract SnmpValue buildSnmpValue(long id, Object value)
Construct an SnmpValue from an Attribute value as returned by Attribute::getValue().
abstract void checkGetAccess(long id, Object data)
Check the access rights for a GET operation.
abstract void checkSetAccess(SnmpValue x, long id, Object data)
Check the access rights for a SET operation.
abstract String getAttributeName(long id)
Return the name of the attribute corresponding to the SNMP variable identified by the given id.

Public Methods

public abstract Object buildAttributeValue (long id, SnmpValue value)

Construct an attribute value (as returned by Attribute::getValue()) from an SnmpValue. The returned attribute value can be used to construct an Attribute object.

Parameters
id The OID arc identifying the variable for which the value is constructed.
value The SnmpValue from which the Attribute::value will be constructed.
Returns
  • The attribute value built from the given value.
Throws
SnmpStatusException if the attribute value cannot be built from the given SnmpValue value.

public abstract SnmpValue buildSnmpValue (long id, Object value)

Construct an SnmpValue from an Attribute value as returned by Attribute::getValue().

Parameters
id The OID arc identifying the variable for which the value is constructed.
value The attribute value as returned by Attribute::getValue().
Returns
  • The SnmpValue built from the given value.
Throws
SnmpStatusException if the SnmpValue cannot be built from the given value.

public abstract void checkGetAccess (long id, Object data)

Check the access rights for a GET operation.

Parameters
id The OID arc identifying the variable for which the SET is requested.
data A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Throws
SnmpStatusException if the SET operation must be rejected.

public abstract void checkSetAccess (SnmpValue x, long id, Object data)

Check the access rights for a SET operation.

Parameters
x The new requested value.
id The OID arc identifying the variable for which the SET is requested.
data A contextual object containing user-data. This object is allocated through the SnmpUserDataFactory for each incoming SNMP request.
Throws
SnmpStatusException if the SET operation must be rejected.

public abstract String getAttributeName (long id)

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

Parameters
id The OID arc identifying the variable.
Returns
  • The name of the variable identified by the given id.
Throws
SnmpStatusException if the given id does not correspond to a known variable.