KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * @(#)file SnmpOidRecord.java
3  * @(#)author Sun Microsystems, Inc.
4  * @(#)version 4.11
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
12
13 package com.sun.jmx.snmp;
14
15
16 /**
17  * Represents an entry of an {@link com.sun.jmx.snmp.SnmpOidTable SnmpOidTable}. It contains the name of the MIB variable,
18  * the corresponding OID and its type.
19  * The type is represented using one of the following:
20  * <UL>
21  *<LI>"C" for <CODE>Counter32</CODE>
22  *<LI>"C64" for <CODE>Counter64</CODE>
23  *<LI>"EN" for <CODE>Table Entry</CODE>
24  *<LI>"G" for <CODE>Gauge32</CODE>
25  *<LI>"I" for <CODE>Integer32</CODE>
26  *<LI>"ID" for <CODE>OBJECT-IDENTITY</CODE>
27  *<LI>"IP" for <CODE>IpAddress</CODE>
28  *<LI>"NT" for <CODE>NOTIFICATION-TYPE</CODE>
29  *<LI>"NU" for <CODE>Null</CODE>
30  *<LI>"O" for <CODE>Opaque</CODE>
31  *<LI>"OI" for <CODE>Object Identifier</CODE>
32  *<LI>"S" for <CODE>String</CODE>
33  *<LI>"T" for <CODE>TimeTicks</CODE>
34  *<LI>"TA" for <CODE>Table</CODE>
35  *<LI>"U" for <CODE>Unsigned32</CODE>
36  *</UL>
37  *
38  * <p><b>This API is a Sun Microsystems internal API and is subject
39  * to change without notice.</b></p>
40  * @see com.sun.jmx.snmp.SnmpOidTable
41  */
42
43 public class SnmpOidRecord {
44
45     /**
46      * Creates an <CODE>SnmpOidRecord</CODE> with the specified MIB variable
47      * name, OID and type.
48      * @param name The logical name of the MIB variable.
49      * @param oid The OID of the MIB variable.
50      * @param type The type of the MIB variable.
51      */
52     public SnmpOidRecord(String JavaDoc name, String JavaDoc oid, String JavaDoc type) {
53         this.name = name;
54         this.oid = oid;
55         this.type = type;
56     }
57
58     /**
59      * Gets the logical name of the MIB variable.
60      * @return The MIB variable name.
61      */
62     public String JavaDoc getName() {
63         return name;
64     }
65
66     /**
67      * Gets the OID of the MIB variable.
68      * @return The MIB variable OID.
69      */
70     public String JavaDoc getOid() {
71         return oid;
72     }
73
74     /**
75      * Gets the type of the MIB variable.
76      * @return The MIB variable type.
77      */
78     public String JavaDoc getType() {
79         return type;
80     }
81
82     // PRIVATE VARIABLES
83
84     /**
85      * The MIB variable name.
86      */
87     private String JavaDoc name;
88     /**
89      * The MIB variable OID.
90      */
91     private String JavaDoc oid;
92     /**
93      * The MIB variable type.
94      */
95     private String JavaDoc type;
96 }
97
Popular Tags