onesetpdu.java

snmp zip 包开发snmp协议

// NAME
//      $RCSfile: OneSetPdu.java,v $
// DESCRIPTION
//      [given below in javadoc format]
// DELTA
//      $Revision: 3.14 $
// CREATED
//      $Date: 2006/01/17 17:49:53 $
// COPYRIGHT
//      Westhawk Ltd
// TO DO
//


/*
 * Copyright (C) 1996 - 1998 by Westhawk Ltd (www.westhawk.nl)
 * Copyright (C) 1998 - 2006 by Westhawk Ltd 
 * <a href="www.westhawk.co.uk">www.westhawk.co.uk</a>
 *
 * Permission to use, copy, modify, and distribute this software
 * for any purpose and without fee is hereby granted, provided
 * that the above copyright notices appear in all copies and that
 * both the copyright notice and this permission notice appear in
 * supporting documentation.
 * This software is provided "as is" without express or implied
 * warranty.
 * author <a href="mailto:[e-mail]">Tim Panton</a>
 */
 
package uk.co.westhawk.snmp.pdu;
import uk.co.westhawk.snmp.stack.*;
import java.util.*;

/**
 * <p>
 * The OneSetPdu class will set the value of one (1) object (oid), based 
 * on the Set request.
 * </p>
 *
 * <p>
 * Unless an exception occurred the Object to the update() method of the
 * Observer will be a varbind, so any AsnObject type can be returned.
 * In the case of an exception, that exception will be passed.
 * </p>
 *
 * <p>
 * For SNMPv3: The receiver of a request PDU acts as the authoritative engine.
 * </p>
 *
 * @deprecated  As of 4_14, just use {@link SetPdu} 
 * @see varbind
 * @see SetPdu_vec
 *
 * @author <a href="mailto:[e-mail]">Birgit Arkesteijn</a>
 * @version $Revision: 3.14 $ $Date: 2006/01/17 17:49:53 $
 */
public class OneSetPdu extends SetPdu 
{
    private static final String     version_id =
        "@(#)$Id: OneSetPdu.java,v 3.14 2006/01/17 17:49:53 birgit Exp $ Copyright Westhawk Ltd";

    varbind var;

    /**
     * Constructor.
     *
     * @param con The context of the request
     */
    public OneSetPdu(SnmpContextBasisFace con)
    {
        super(con);
    }

    /**
     * Constructor that will send the request immediately. No Observer
     * is set.
     *
     * @param con the SnmpContextBasisFace
     * @param oid the oid 
     * @param val The value
     */
    public OneSetPdu(SnmpContextBasisFace con, String oid, AsnObject val) 
    throws PduException, java.io.IOException
    {
        this(con, oid, val, null);
    }

    /**
     * Constructor that will send the request immediately. 
     *
     * @param con the SnmpContextBasisFace
     * @param oid the oid 
     * @param val The value
     * @param o the Observer that will be notified when the answer is received
     */
    public OneSetPdu(SnmpContextBasisFace con, String oid, AsnObject val, Observer o) 
    throws PduException, java.io.IOException
    {
        super(con);
        if (o != null) 
        {
            addObserver(o);
        }
        addOid(oid, val);
        send();
    }

    /**
     * The value of the request is set. This will be called by
     * Pdu.fillin(). This is the value of the OID after the Set request
     * was done. If the SNMP server allowed the set, this will be the
     * same value as was set in SetPdu.addOid().
     *
     * @param n the index of the value
     * @param a_var the value
     * @see Pdu#new_value 
     * @see SetPdu#addOid(String, AsnObject)
     */
    protected void new_value(int n, varbind a_var) 
    {
        if (n == 0) 
        {
            var = a_var;
        }
    }

    /**
     * This method notifies all observers. 
     * This will be called by Pdu.fillin().
     * 
     * <p>
     * Unless an exception occurred the Object to the update() method of the
     * Observer will be a varbind, so any AsnObject type can be returned.
     * In the case of an exception, that exception will be passed.
     * </p>
     */
    protected void tell_them()  
    {
        notifyObservers(var);
    }

}