1 /* 2 * Copyright (c) 2001, 2003, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 package com.sun.jmx.snmp; 26 27 import com.sun.jmx.snmp.SnmpDefinitions; 28 29 /** 30 * This class is the base class of all parameters that are used when making SNMP requests to an <CODE>SnmpPeer</CODE>. 31 * <p><b>This API is a Sun Microsystems internal API and is subject 32 * to change without notice.</b></p> 33 * @since 1.5 34 */ 35 public abstract class SnmpParams implements SnmpDefinitions { 36 private int protocolVersion = snmpVersionOne; 37 SnmpParams(int version) { 38 protocolVersion = version; 39 } 40 41 SnmpParams() {} 42 /** 43 * Checks whether parameters are in place for an SNMP <CODE>set</CODE> operation. 44 * @return <CODE>true</CODE> if parameters are in place, <CODE>false</CODE> otherwise. 45 */ 46 public abstract boolean allowSnmpSets(); 47 /** 48 * Returns the version of the protocol to use. 49 * The returned value is: 50 * <UL> 51 * <LI>{@link com.sun.jmx.snmp.SnmpDefinitions#snmpVersionOne snmpVersionOne} if the protocol is SNMPv1 52 * <LI>{@link com.sun.jmx.snmp.SnmpDefinitions#snmpVersionTwo snmpVersionTwo} if the protocol is SNMPv2 53 * <LI>{@link com.sun.jmx.snmp.SnmpDefinitions#snmpVersionThree snmpVersionThree} if the protocol is SNMPv3 54 * </UL> 55 * @return The version of the protocol to use. 56 */ 57 public int getProtocolVersion() { 58 return protocolVersion ; 59 } 60 61 /** 62 * Sets the version of the protocol to be used. 63 * The version should be identified using the definitions 64 * contained in 65 * {@link com.sun.jmx.snmp.SnmpDefinitions SnmpDefinitions}. 66 * <BR>For instance if you wish to use SNMPv2, you can call the method as follows: 67 * <BLOCKQUOTE><PRE> 68 * setProtocolVersion(SnmpDefinitions.snmpVersionTwo); 69 * </PRE></BLOCKQUOTE> 70 * @param protocolversion The version of the protocol to be used. 71 */ 72 73 public void setProtocolVersion(int protocolversion) { 74 this.protocolVersion = protocolversion ; 75 } 76 }