KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > jmx > snmp > SnmpOidTable


1 /*
2  * @(#)file SnmpOidTable.java
3  * @(#)author Sun Microsystems, Inc.
4  * @(#)version 4.14
5  * @(#)date 08/02/09
6  *
7  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
8  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
9  *
10  */
11 // Copyright (c) 1995-96 by Cisco Systems, Inc.
12
13 package com.sun.jmx.snmp;
14
15
16 // java import
17 //
18 import java.util.Vector JavaDoc;
19
20
21 /**
22  * Defines the minimum functionality that should be provided by
23  * a class containing metadata definitions for variables of a MIB.
24  * A name can be resolved against a table of MIB variables.
25  * Each entry in the table is an <CODE>SnmpOidRecord</CODE> object that contains a name, a dot-separated OID string,
26  * and the corresponding SMI type of the variable.
27  * <P>
28  * If you need to load a specific <CODE>SnmpOidTable</CODE>, just call the static method
29  * {@link com.sun.jmx.snmp.SnmpOid#setSnmpOidTable <CODE>SnmpOid.setSnmpOidTable(<I>myOidTable</I>)</CODE>}.
30  *
31  * <p><b>This API is a Sun Microsystems internal API and is subject
32  * to change without notice.</b></p>
33  * @see com.sun.jmx.snmp.SnmpOidRecord
34  *
35  * @version 4.14 12/19/03
36  * @author Sun Microsystems, Inc
37  *
38  */
39
40
41 public interface SnmpOidTable {
42
43     /**
44      * Searches for a MIB variable given its logical name and returns an {@link com.sun.jmx.snmp.SnmpOidRecord} object
45      * containing information on the variable.
46      *
47      * @param name The name of the MIB variable.
48      * @return The <CODE>SnmpOidRecord</CODE> object containing information on the variable.
49      * @exception SnmpStatusException If the variable is not found.
50      */
51     public SnmpOidRecord resolveVarName(String JavaDoc name)
52     throws SnmpStatusException;
53
54
55     /**
56      * Searches for a MIB variable given its OID and returns an {@link com.sun.jmx.snmp.SnmpOidRecord} object
57      * containing information on the variable.
58      *
59      * @param oid The OID of the MIB variable.
60      * @return The <CODE>SnmpOidRecord</CODE> object containing information
61      * on the variable.
62      * @exception SnmpStatusException If the variable is not found.
63      */
64     public SnmpOidRecord resolveVarOid(String JavaDoc oid)
65     throws SnmpStatusException;
66
67     /**
68      * Returns a list that can be used to traverse all the entries this <CODE>SnmpOidTable</CODE>.
69      * @return A Vector of {@link com.sun.jmx.snmp.SnmpOidRecord} objects.
70      */
71     public Vector JavaDoc getAllEntries();
72 }
73
Popular Tags