0N/A/*
2362N/A * Copyright (c) 2001, 2003, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/Apackage com.sun.jmx.snmp;
0N/A
0N/Aimport com.sun.jmx.snmp.SnmpDefinitions;
0N/A
0N/A/**
0N/A * This class is the base class of all parameters that are used when making SNMP requests to an <CODE>SnmpPeer</CODE>.
0N/A * <p><b>This API is a Sun Microsystems internal API and is subject
0N/A * to change without notice.</b></p>
0N/A * @since 1.5
0N/A */
0N/Apublic abstract class SnmpParams implements SnmpDefinitions {
0N/A private int protocolVersion = snmpVersionOne;
0N/A SnmpParams(int version) {
0N/A protocolVersion = version;
0N/A }
0N/A
0N/A SnmpParams() {}
0N/A /**
0N/A * Checks whether parameters are in place for an SNMP <CODE>set</CODE> operation.
0N/A * @return <CODE>true</CODE> if parameters are in place, <CODE>false</CODE> otherwise.
0N/A */
0N/A public abstract boolean allowSnmpSets();
0N/A /**
0N/A * Returns the version of the protocol to use.
0N/A * The returned value is:
0N/A * <UL>
0N/A * <LI>{@link com.sun.jmx.snmp.SnmpDefinitions#snmpVersionOne snmpVersionOne} if the protocol is SNMPv1
0N/A * <LI>{@link com.sun.jmx.snmp.SnmpDefinitions#snmpVersionTwo snmpVersionTwo} if the protocol is SNMPv2
0N/A * <LI>{@link com.sun.jmx.snmp.SnmpDefinitions#snmpVersionThree snmpVersionThree} if the protocol is SNMPv3
0N/A * </UL>
0N/A * @return The version of the protocol to use.
0N/A */
0N/A public int getProtocolVersion() {
0N/A return protocolVersion ;
0N/A }
0N/A
0N/A /**
0N/A * Sets the version of the protocol to be used.
0N/A * The version should be identified using the definitions
0N/A * contained in
0N/A * {@link com.sun.jmx.snmp.SnmpDefinitions SnmpDefinitions}.
0N/A * <BR>For instance if you wish to use SNMPv2, you can call the method as follows:
0N/A * <BLOCKQUOTE><PRE>
0N/A * setProtocolVersion(SnmpDefinitions.snmpVersionTwo);
0N/A * </PRE></BLOCKQUOTE>
0N/A * @param protocolversion The version of the protocol to be used.
0N/A */
0N/A
0N/A public void setProtocolVersion(int protocolversion) {
0N/A this.protocolVersion = protocolversion ;
0N/A }
0N/A}