jdk/src/jdk.snmp/share/classes/com/sun/jmx/snmp/agent/SnmpMibEntry.java
changeset 27220 315d620f5726
parent 27219 c4918033790e
parent 27214 d9f500808d8a
child 27222 422e90d83a4e
--- a/jdk/src/jdk.snmp/share/classes/com/sun/jmx/snmp/agent/SnmpMibEntry.java	Thu Oct 23 13:45:30 2014 -0700
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,188 +0,0 @@
-/*
- * Copyright (c) 2000, 2014, 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 com.sun.jmx.snmp.SnmpDefinitions;
-import java.io.Serializable;
-import com.sun.jmx.snmp.SnmpStatusException;
-
-/**
- * Represents a node in an SNMP MIB which corresponds to a table entry
- * meta node.
- * <P>
- * This class is used by the class generated by <CODE>mibgen</CODE>.
- * You should not need to use this class directly.
- *
- * <p><b>This API is a Sun Microsystems internal API  and is subject
- * to change without notice.</b></p>
- */
-@SuppressWarnings("serial") // JDK implementation class
-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 <CODE>true</CODE> 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 <CODE>true</CODE> 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 <code>
-     *        {@link com.sun.jmx.snmp.agent.SnmpUserDataFactory}</code>
-     *        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 new SnmpStatusException(SnmpDefinitions.snmpRspNoSuchName);
-        }
-    }
-
-    /**
-     * Generic handling of the <CODE>get</CODE> operation.
-     * <p>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:
-     * <ul><li>The standard implementation will directly access the
-     *         MBean through a java reference,</li>
-     *     <li>The generic implementation will access the MBean through
-     *         the MBean server.</li>
-     * </ul>
-     * <p>Both implementations rely upon specific - and distinct, set of
-     * mibgen generated methods.
-     * <p> You can override this method if you need to implement some
-     * specific policies for minimizing the accesses made to some remote
-     * underlying resources.
-     * <p>
-     *
-     * @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 <CODE>set</CODE> operation.
-     * <p>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:
-     * <ul><li>The standard implementation will directly access the
-     *         MBean through a java reference,</li>
-     *     <li>The generic implementation will access the MBean through
-     *         the MBean server.</li>
-     * </ul>
-     * <p>Both implementations rely upon specific - and distinct, set of
-     * mibgen generated methods.
-     * <p> You can override this method if you need to implement some
-     * specific policies for minimizing the accesses made to some remote
-     * underlying resources.
-     * <p>
-     *
-     * @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 <CODE>check</CODE> operation.
-     *
-     * <p>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:
-     * <ul><li>The standard implementation will directly access the
-     *         MBean through a java reference,</li>
-     *     <li>The generic implementation will access the MBean through
-     *         the MBean server.</li>
-     * </ul>
-     * <p>Both implementations rely upon specific - and distinct, set of
-     * mibgen generated methods.
-     * <p> 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.
-     * <p>
-     *
-     * @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;
-
-}