varbind.java

snmp zip 包开发snmp协议

// NAME
//      $RCSfile: varbind.java,v $
// DESCRIPTION
//      [given below in javadoc format]
// DELTA
//      $Revision: 3.9 $
// CREATED
//      $Date: 2006/01/17 17:43:54 $
// COPYRIGHT
//      Westhawk Ltd
// TO DO
//

/*
 * Copyright (C) 1995, 1996 by West Consulting BV
 *
 * 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>
 */

/*
 * Copyright (C) 1996 - 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.stack;

/**
 * <p>
 * This class represents the variable bindings to a PDU.
 * A variable consists of a name (an AsnObjectId) and a value (an
 * AsnObject)
 * </p>
 *
 * <p>
 * The varbind is usually passed to the Observers of the PDU when
 * notifying them. 
 * </p>
 *
 * @see Pdu#addOid(varbind)
 * @see Pdu#addOid(String, AsnObject)
 * @author <a href="mailto:[e-mail]">Tim Panton</a>
 * @version $Revision: 3.9 $ $Date: 2006/01/17 17:43:54 $
 */
public class varbind extends Object 
{
    private static final String     version_id =
        "@(#)$Id: varbind.java,v 3.9 2006/01/17 17:43:54 birgit Exp $ Copyright Westhawk Ltd";

    private AsnObjectId name;
    private AsnObject value;

    /** 
     * Constructor.
     * It will clone the varbind given as parameter.
     *
     * @param var The varbind
     */
    public varbind (varbind var)
    {
        name  = var.name;
        value = var.value;
    }

    /** 
     * Constructor.
     * The name will be set to the Oid, the value will be set to
     * AsnNull. This is usually used in Get or GetNext requests.
     *
     * @param Oid The oid
     * @see AsnNull
     */
    public varbind(String Oid) 
    {
        this(new AsnObjectId(Oid), new AsnNull());
    }

    /** 
     * Constructor.
     * The name will be set to the Oid, the value will be set to
     * AsnNull. This is usually used in Get or GetNext requests.
     *
     * @param Oid The oid
     * @see AsnNull
     */
    public varbind(AsnObjectId Oid) 
    {
        this(Oid, new AsnNull());
    }

    /** 
     * Constructor.
     * The name and value will be set. 
     * This is usually used in Set requests.
     *
     * @param Oid The oid
     * @param val The value for the varbind
     */
    public varbind(String Oid, AsnObject val) 
    {
        this(new AsnObjectId(Oid), val); 
    }

    /** 
     * Constructor.
     * The name and value will be set. 
     * This is usually used in Set requests.
     *
     * @param Oid The oid
     * @param val The value for the varbind
     * @since 4_12
     */
    public varbind(AsnObjectId Oid, AsnObject val) 
    {
        name = Oid;
        value = val;
    }

    varbind(AsnSequence vb)
    {
        name  = (AsnObjectId) vb.getObj(0);
        value = vb.getObj(1);
    }

    /** 
     * Returns the oid, this is the name of the varbind.
     *
     * @return the name as an AsnObjectId
     */
    public AsnObjectId getOid() 
    {
        return name;
    }

    /** 
     * Returns the value of the varbind.
     *
     * @return the value as AsnObject
     */
    public AsnObject getValue() 
    {
        return value;
    }

    Object setValue(AsnSequence vb) 
    {
        name  = (AsnObjectId) vb.getObj(0);
        value = vb.getObj(1);
        return value;
    }

    /** 
     * Returns the string representation of the varbind.
     *
     * @return The string of the varbind
     */
    public String toString()
    {
        return (name.toString() + ": " + value.toString());
    }
}