* This class is a utility class that transform SNMP GET / SET requests * into series of getAttributeName() setAttributeName() * invoked on the MBean. *
* *
* The transformation relies on the metadata information provided by the
* {@link com.sun.jmx.snmp.agent.SnmpStandardMetaServer} object which is
* passed as first parameter to every method. This SnmpStandardMetaServer
* object is usually a Metadata object generated by mibgen.
*
* The MBean is not invoked directly by this class but through the * metadata object which holds a reference on it. *
* ** This class is used internally by mibgen generated metadata objects and * you should never need to use it directly. *
*This API is a Sun Microsystems internal API and is subject * to change without notice.
**/ public class SnmpStandardObjectServer implements Serializable { /** * Generic handling of theget operation.
* The default implementation of this method is to loop over the
* varbind list associated with the sub-request and to call
* get(var.oid.getOidArc(depth), data);
*
* public void get(SnmpStandardMetaServer meta, SnmpMibSubRequest req,
* int depth)
* throws SnmpStatusException {
*
* final Object data = req.getUserData();
*
* for (Enumeration e= req.getElements(); e.hasMoreElements();) {
*
* final SnmpVarBind var= (SnmpVarBind) e.nextElement();
*
* try {
* // This method will generate a SnmpStatusException
* // if `depth' is out of bounds.
* //
* final long id = var.oid.getOidArc(depth);
* var.value = meta.get(id, data);
* } catch(SnmpStatusException x) {
* req.registerGetException(var,x);
* }
* }
* }
*
* You can override this method if you need to implement some * specific policies for minimizing the accesses made to some remote * underlying resources. *
*
* @param meta A pointer to the generated meta-data object which
* implements the SnmpStandardMetaServer
* interface.
*
* @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 void get(SnmpStandardMetaServer meta, SnmpMibSubRequest req,
int depth)
throws SnmpStatusException {
final Object data = req.getUserData();
for (Enumeration e= req.getElements(); e.hasMoreElements();) {
final SnmpVarBind var= (SnmpVarBind) e.nextElement();
try {
final long id = var.oid.getOidArc(depth);
var.value = meta.get(id, data);
} catch(SnmpStatusException x) {
req.registerGetException(var,x);
}
}
}
/**
* Generic handling of the set operation.
*
The default implementation of this method is to loop over the
* varbind list associated with the sub-request and to call
* set(var.value, var.oid.getOidArc(depth), data);
*
* public void set(SnmpStandardMetaServer meta, SnmpMibSubRequest req,
* int depth)
* throws SnmpStatusException {
*
* final Object data = req.getUserData();
*
* for (Enumeration e= req.getElements(); e.hasMoreElements();) {
*
* final SnmpVarBind var= (SnmpVarBind) e.nextElement();
*
* try {
* // This method will generate a SnmpStatusException
* // if `depth' is out of bounds.
* //
* final long id = var.oid.getOidArc(depth);
* var.value = meta.set(var.value, id, data);
* } catch(SnmpStatusException x) {
* req.registerSetException(var,x);
* }
* }
* }
*
* You can override this method if you need to implement some * specific policies for minimizing the accesses made to some remote * underlying resources. *
*
* @param meta A pointer to the generated meta-data object which
* implements the SnmpStandardMetaServer
* interface.
*
* @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 void set(SnmpStandardMetaServer meta, SnmpMibSubRequest req,
int depth)
throws SnmpStatusException {
final Object data = req.getUserData();
for (Enumeration e= req.getElements(); e.hasMoreElements();) {
SnmpVarBind var = null;
var = (SnmpVarBind) e.nextElement();
try {
// This method will generate a SnmpStatusException
// if `depth' is out of bounds.
//
final long id = var.oid.getOidArc(depth);
var.value = meta.set(var.value, id, data);
} catch(SnmpStatusException x) {
req.registerSetException(var,x);
}
}
}
/**
* Generic handling of the check operation.
*
The default implementation of this method is to loop over the
* varbind list associated with the sub-request and to call
* check(var.value, var.oid.getOidArc(depth), data);
*
* public void check(SnmpStandardMetaServer meta, SnmpMibSubRequest req,
* int depth)
* throws SnmpStatusException {
*
* final Object data = req.getUserData();
*
* for (Enumeration e= req.getElements(); e.hasMoreElements();) {
*
* final SnmpVarBind var= (SnmpVarBind) e.nextElement();
*
* try {
* // This method will generate a SnmpStatusException
* // if `depth' is out of bounds.
* //
* final long id = var.oid.getOidArc(depth);
* meta.check(var.value, id, data);
* } catch(SnmpStatusException x) {
* req.registerCheckException(var,x);
* }
* }
* }
*
* 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 meta A pointer to the generated meta-data object which
* implements the SnmpStandardMetaServer
* interface.
*
* @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 void check(SnmpStandardMetaServer meta, SnmpMibSubRequest req,
int depth)
throws SnmpStatusException {
final Object data = req.getUserData();
for (Enumeration e= req.getElements(); e.hasMoreElements();) {
final SnmpVarBind var = (SnmpVarBind) e.nextElement();
try {
// This method will generate a SnmpStatusException
// if `depth' is out of bounds.
//
final long id = var.oid.getOidArc(depth);
meta.check(var.value,id,data);
} catch(SnmpStatusException x) {
req.registerCheckException(var,x);
}
}
}
}