KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > snmp > SNMPGauge32


1 /*
2  * SNMP Package
3  *
4  * Copyright (C) 2004, Jonathan Sevy <jsevy@mcs.drexel.edu>
5  *
6  * This is free software. Redistribution and use in source and binary forms, with
7  * or without modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  * list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  * derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
19  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
23  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  */
29
30 package snmp;
31
32
33
34
35 import java.math.*;
36
37
38 /** Defines a 32-bit gauge, whose value "pegs" at the maximum if initialized with a larger
39 * value. For an indicator which wraps when it reaches its maximum value, use SNMPCounter32;
40 * for a counter with a wider range, use SNMPCounter64.
41 * @see snmp.SNMPCounter32
42 * @see snmp.SNMPCounter64
43 */
44
45
46 public class SNMPGauge32 extends SNMPInteger
47 {
48     // maximum value is 2^32 - 1 (hack w/ 4*107...)
49 private static BigInteger maxValue = new BigInteger("4294967295");
50     
51     /** Initialize value to 0.
52     */
53     
54     public SNMPGauge32()
55     {
56         this(0); // initialize value to 0
57 }
58     
59     
60     public SNMPGauge32(long newValue)
61     {
62         tag = SNMPBERCodec.SNMPGAUGE32;
63         
64         value = new BigInteger(new Long JavaDoc(newValue).toString());
65         
66         // peg if value > maxValue
67 value = value.min(maxValue);
68     }
69     
70     
71     
72     
73     /** Used to initialize from the BER encoding, usually received in a response from
74     * an SNMP device responding to an SNMPGetRequest.
75     * @throws SNMPBadValueException Indicates an invalid BER encoding supplied. Shouldn't
76     * occur in normal operation, i.e., when valid responses are received from devices.
77     */
78     
79     protected SNMPGauge32(byte[] enc)
80         throws SNMPBadValueException
81     {
82         tag = SNMPBERCodec.SNMPGAUGE32;
83         
84         extractValueFromBEREncoding(enc);
85         
86         // peg if value > maxValue
87 value = value.min(maxValue);
88     }
89     
90     
91     
92     
93     /** Used to set the value with an instance of java.lang.Integer or
94     * java.lang.BigInteger. The value of the constructed SNMPGauge32 object is the
95     * supplied value or 2^32, whichever is less.
96     * @throws SNMPBadValueException Indicates an incorrect object type supplied.
97     */
98     
99     public void setValue(Object JavaDoc newValue)
100         throws SNMPBadValueException
101     {
102         // plateau when value hits maxValue
103 if (newValue instanceof BigInteger)
104         {
105             value = (BigInteger)newValue;
106             value = value.min(maxValue);
107         }
108         else if (newValue instanceof Integer JavaDoc)
109         {
110             value = value = new BigInteger(newValue.toString());
111             value = value.min(maxValue);
112         }
113         else if (newValue instanceof String JavaDoc)
114         {
115             value = value = new BigInteger((String JavaDoc)newValue);
116             value = value.min(maxValue);
117         }
118         else
119             throw new SNMPBadValueException(" Gauge32: bad object supplied to set value ");
120     }
121     
122     
123 }
Popular Tags