ncdperfdatabean.java

snmp zip 包开发snmp协议

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

/*
 * Copyright (C) 1998 - 2006 by Westhawk Ltd
 *
 * 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.beans;

import uk.co.westhawk.snmp.stack.*;
import uk.co.westhawk.snmp.pdu.*;
import java.awt.*;
import java.util.*;
import java.text.*;
import java.lang.*;
import java.io.*;
import java.beans.*;

/**
 * <p>
 * This bean collects information about a 
 * <a href="http://www.pc.ibm.com/networkstation/">IBM Network Computer</a>. 
 * </p>
 *
 * <p>
 * <ul>
 * It provide the following data:
 * <li> the speed of the Ethernet Card </li>
 * <li> the available memory in bytes </li>
 * <li> the name of the user that is logged in </li>
 * </ul>
 * 
 * A message will be set if some of the data is not available
 * </p>
 *
 * <p>
 * This class uses the NCDware v3.2 MIB, which was very kindly provided
 * to me by <a href="http://www.ncd.com/">Network Computing Devices, inc
 * (NCD)</a>. This MIB is an extention of the older versions of the 
 * <a href="ftp://ftp.ncd.com/pub/ncd/Archive/NCD-Articles/NCD_X_Terminals/SNMP/3.3.2/mib.my">MIB</a>
 * </p>
 *
 * <p>
 * The properties in the parent classes should be set, before calling
 * the action() method. Via a PropertyChangeEvent the application/applet
 * will be notified.
 * </p>
 *
 * @see SNMPBean#setHost
 * @see SNMPBean#setPort
 * @see SNMPBean#setCommunityName
 * @see #setUpdateInterval(int)
 * @see #setUpdateInterval(String)
 * @see SNMPBean#addPropertyChangeListener
 * @see SNMPBean#action
 * 
 * @author <a href="mailto:[e-mail]">Birgit Arkesteijn</a>
 * @version $Revision: 1.12 $ $Date: 2006/01/17 17:43:53 $
 */
public class NcdPerfDataBean extends SNMPBean 
      implements PropertyChangeListener 
{
    private static final String     version_id =
        "@(#)$Id: NcdPerfDataBean.java,v 1.12 2006/01/17 17:43:53 birgit Exp $ Copyright Westhawk Ltd";

    /**
     * Used as propertyName when a propertyChangeEvent is fired because
     * the speed was updated
     */
    public final static String speedPropertyName  = "Speed";

    /**
     * Used as propertyName when a propertyChangeEvent is fired because
     * the memory was updated
     */
    public final static String memoryPropertyName = "Memory";

    /**
     * Used as propertyName when a propertyChangeEvent is fired because
     * the user name was updated
     */
    public final static String userPropertyName   = "User";

    /**
     * Used as propertyName when a propertyChangeEvent is fired because
     * a message was set
     */
    public final static String messagePropertyName   = "Message";

    /**
     * Used as name when no one is logged in. 
     */
    public final static String noLogin = "no one is logged in";

    /**
     * Used as name when the name is not available.
     */
    public final static String noName = "not available";


    private ethernet ethernetData;
    private user  userData;
    private memory memoryData;

    private Date lastUpdateDate = null;

    private int interval = 3000;
    private long speed = -1;
    private long memoryAvail = -1;
    private String userName = "";

/**
 * The default constructor.
 */
public NcdPerfDataBean() 
{
}

/**
 * Returns the speed (bits per second) of the ethernet card interface.
 * @return the speed (b/s)
 */
public long getSpeed()
{
    return speed;
}

/**
 * Returns the amount of RAM memory in bytes which is
 * currently available.
 *
 * @return the memory in bytes
 */
public long getMemory()
{
    return memoryAvail;
}

/**
 * Returns the login name of the user that is logged in.
 *
 * @return the user name 
 * @see #noLogin
 * @see #noName
 */
public String getUserName()
{
    return userName;
}

/**
 * Returns the update interval. This is the interval that the
 * bean will sleep between 2 requests.
 *
 * @return the update interval in msec
 * @see #setUpdateInterval(int)
 * @see #setUpdateInterval(String)
 */
public int getUpdateInterval()
{
    return interval;
}

/**
 * Sets the update interval. This is the interval that the
 * bean will sleep between 2 requests.
 * The default will be <em>3000</em> (= 3 sec).
 *
 * @param i the interval in msec
 * @see #getUpdateInterval
 * @see #setUpdateInterval(String)
 */
public void setUpdateInterval(int i)
{
    if (interval != i)
    {
        interval = i;
    }
}

/**
 * Sets the update interval as String. 
 *
 * @param i the interval in msec as String
 * @see #getUpdateInterval
 * @see #setUpdateInterval(int)
 */
public void setUpdateInterval(String i)
{
    int iNo;
    try
    {
        iNo = Integer.valueOf(i.trim()).intValue();
        setUpdateInterval(iNo);
    }
    catch (NumberFormatException exp)
    {
    }
}

/**
 * Returns the date of the moment when this bean was last updated.
 * This might be null when the first time the update was not finished.
 *
 * @return the last update date
 */
public Date getLastUpdateDate()
{
    return lastUpdateDate;
}

/**
 * This method starts sending the SNMP request. All properties should be
 * set before this method is called.
 *
 * The actual sending will take place in the run method.
 * It makes a new snmp context and initialises all variables before
 * starting.
 */
public void action() 
{
    if (isHostPortReachable())
    {
        lastUpdateDate = new Date();

        if (ethernetData != null)
        {
            ethernetData.setRunning(false);
        }
        if (userData != null)
        {
            userData.setRunning(false);
        }
        if (memoryData != null)
        {
            memoryData.setRunning(false);
        }
        ethernetData = new ethernet(host, port, community, interval, context);
        userData = new user(host, port, community, interval, context);
        memoryData = new memory(host, port, community, interval, context);

        ethernetData.addPropertyChangeListener(this);
        userData.addPropertyChangeListener(this);
        memoryData.addPropertyChangeListener(this);
    }
}

protected void setMessage(String st)
{
    message = st;
    firePropertyChange (NcdPerfDataBean.messagePropertyName, 
        null, message);
}

/**
 * This method is called when a new value of the speed, memory, user or 
 * message is available. It will propagate this event to any listeners.
 *
 * @see #speedPropertyName
 * @see #memoryPropertyName
 * @see #userPropertyName
 * @see #messagePropertyName
 */
public void propertyChange(PropertyChangeEvent e)
{
    Object src = e.getSource();
    Object oldV = e.getOldValue();
    Object newV= e.getNewValue();
    String propName = e.getPropertyName();

    if (propName.equals(messagePropertyName))
    {
        setMessage((String) newV);
    }
    else
    {
        if (src == ethernetData)
        {
            speed = ((Long) newV).longValue();
        }
        else if (src == userData)
        {
            userName = (String) newV;
        }
        else if (src == memoryData)
        {
            memoryAvail = ((Long) newV).longValue();
        }

        firePropertyChange (e.getPropertyName(), oldV, newV);
    }
}

}


/**
 * <p>
 * This class is the super class of the classes ethernet, user and
 * memory.
 * </p>
 *
 * @see user
 * @see ethernet
 * @see memory
 */
abstract class ncdPart extends SNMPRunBean 
{
    Thread me;
    protected boolean isPduInFlight;

public abstract void doPdu() 
throws PduException, java.io.IOException;

public ncdPart (String h, int p, String c, int i, SnmpContext con)
{
    // reuse the context of the NcdPrefData class, so do not call
    // isHostPortReachable() !
    context = con;
    setHost(h);
    setPort(p);
    setCommunityName(c);
    setUpdateInterval(i);

    action();
}

protected void setMessage(String st)
{
    message = st;
    firePropertyChange (NcdPerfDataBean.messagePropertyName, 
        null, message);
}

public void action()
{
    setRunning(true);
}

/**
 *
 * @see SNMPRunBean#isRunning()
 */
public void run()
{
    while (context != null && isRunning())
    {
        if (isPduInFlight == false)
        {
            isPduInFlight = true;
            try
            {
                doPdu();
            }
            catch (PduException exc)
            {
                System.out.println("PduException " + exc.getMessage());
            }
            catch (IOException exc)
            {
                System.out.println("IOException " + exc.getMessage());
            }
        }

        try
        {
            Thread.sleep(interval);
        } 
        catch (InterruptedException ix)
        {
            ;
        }
    }
}

}

/**
 * <p>
 * This class collects information about the ethernet card.
 * </p>
 *
 * <p>
 * The first time it will search the interface table to find the entry
 * describing the ethernet card. After it has been found, it will ask
 * for the information to calculate the speed.
 * </p>
 *
 * <p>
 * If the ethernet card is not found, this class assumes that it is not
 * available at all, and will not try again. 
 * </p>
 *
 * @see user
 * @see memory
 */
class ethernet extends ncdPart implements Observer
{
    private final static int ethernetType = 6;
    private final static int statusUp = 1;

    private final static String sysUpTime =    "1.3.6.1.2.1.1.3.0";
    private final static String ifIndex =      "1.3.6.1.2.1.2.2.1.1";
    private final static String ifType =       "1.3.6.1.2.1.2.2.1.3";
    private final static String ifOperStatus = "1.3.6.1.2.1.2.2.1.8";
    private final static String ifInOctets =   "1.3.6.1.2.1.2.2.1.10";
    private final static String ifOutOctets =  "1.3.6.1.2.1.2.2.1.16";

    private long speed = -1;
    private long prevSpeed = -1;
    private long prevSys = -1;
    private int prevOper = -1;
    private long prevInO = -1;
    private long prevOutO = -1;
    private int index = -1;

    GetNextPdu_vec typePdu;
    GetPdu_vec ethernetPdu;