01: /*
02: * SNMP Package
03: *
04: * Copyright (C) 2004, Jonathan Sevy <jsevy@mcs.drexel.edu>
05: *
06: * This is free software. Redistribution and use in source and binary forms, with
07: * or without modification, are permitted provided that the following conditions
08: * are met:
09: *
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: import java.math.*;
33:
34: /** Defines a 32-bit gauge, whose value "pegs" at the maximum if initialized with a larger
35: * value. For an indicator which wraps when it reaches its maximum value, use SNMPCounter32;
36: * for a counter with a wider range, use SNMPCounter64.
37: * @see snmp.SNMPCounter32
38: * @see snmp.SNMPCounter64
39: */
40:
41: public class SNMPGauge32 extends SNMPInteger {
42: // maximum value is 2^32 - 1 (hack w/ 4*107...)
43: private static BigInteger maxValue = new BigInteger("4294967295");
44:
45: /** Initialize value to 0.
46: */
47:
48: public SNMPGauge32() {
49: this (0); // initialize value to 0
50: }
51:
52: public SNMPGauge32(long newValue) {
53: tag = SNMPBERCodec.SNMPGAUGE32;
54:
55: value = new BigInteger(new Long(newValue).toString());
56:
57: // peg if value > maxValue
58: value = value.min(maxValue);
59: }
60:
61: /** Used to initialize from the BER encoding, usually received in a response from
62: * an SNMP device responding to an SNMPGetRequest.
63: * @throws SNMPBadValueException Indicates an invalid BER encoding supplied. Shouldn't
64: * occur in normal operation, i.e., when valid responses are received from devices.
65: */
66:
67: protected SNMPGauge32(byte[] enc) throws SNMPBadValueException {
68: tag = SNMPBERCodec.SNMPGAUGE32;
69:
70: extractValueFromBEREncoding(enc);
71:
72: // peg if value > maxValue
73: value = value.min(maxValue);
74: }
75:
76: /** Used to set the value with an instance of java.lang.Integer or
77: * java.lang.BigInteger. The value of the constructed SNMPGauge32 object is the
78: * supplied value or 2^32, whichever is less.
79: * @throws SNMPBadValueException Indicates an incorrect object type supplied.
80: */
81:
82: public void setValue(Object newValue) throws SNMPBadValueException {
83: // plateau when value hits maxValue
84: if (newValue instanceof BigInteger) {
85: value = (BigInteger) newValue;
86: value = value.min(maxValue);
87: } else if (newValue instanceof Integer) {
88: value = value = new BigInteger(newValue.toString());
89: value = value.min(maxValue);
90: } else if (newValue instanceof String) {
91: value = value = new BigInteger((String) newValue);
92: value = value.min(maxValue);
93: } else
94: throw new SNMPBadValueException(
95: " Gauge32: bad object supplied to set value ");
96: }
97:
98: }
|