/* * Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.sun.jmx.snmp.agent; // java imports // import java.io.Serializable; import java.util.Hashtable; import java.util.Enumeration; // jmx imports // import com.sun.jmx.snmp.SnmpValue; import com.sun.jmx.snmp.SnmpVarBind; import com.sun.jmx.snmp.SnmpStatusException; import com.sun.jmx.snmp.agent.SnmpMibOid; import com.sun.jmx.snmp.agent.SnmpMibNode; /** * 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.

*/ public abstract class SnmpMibEntry extends SnmpMibNode implements Serializable { /** * 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 boolean isVariable(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 boolean isReadable(long arc); /** * Get the next OID arc corresponding to a readable scalar variable. * */ public long getNextVarId(long id, Object userData) throws SnmpStatusException { long nextvar = super.getNextVarId(id,userData); while (!isReadable(nextvar)) nextvar = super.getNextVarId(nextvar,userData); return nextvar; } /** * 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. */ public void validateVarId(long arc, Object userData) throws SnmpStatusException { if (isVariable(arc) == false) throw noSuchNameException; } /** * 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: *

*

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. */ abstract public void get(SnmpMibSubRequest req, int depth) throws SnmpStatusException; /** * 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: *

*

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. */ abstract public void set(SnmpMibSubRequest req, int depth) throws SnmpStatusException; /** * 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: *

*

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. */ abstract public void check(SnmpMibSubRequest req, int depth) throws SnmpStatusException; }