// NAME
   //      $RCSfile: OneInterfaceBean.java,v $
   // DESCRIPTION
   //      [given below in javadoc format]
   // DELTA
   //      $Revision: 1.14 $
   // CREATED
   //      $Date: 2006/01/25 18:08:56 $
   // 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:snmp@westhawk.co.uk">Tim Panton</a>
   */
  
  package uk.co.westhawk.snmp.beans;
  
  /*-
   * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
   * SNMP Java Client
   * ჻჻჻჻჻჻
   * Copyright 2023 Sentry Software, Westhawk
   * ჻჻჻჻჻჻
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Lesser General Public License as
   * published by the Free Software Foundation, either version 3 of the
   * License, or (at your option) any later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Lesser Public License for more details.
   *
   * You should have received a copy of the GNU General Lesser Public
   * License along with this program.  If not, see
   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
   * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
   */
  
  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 one interface. 
   * </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 SNMPRunBean#setUpdateInterval
   * @see #setIndex(int)
   * @see SNMPBean#addPropertyChangeListener
   * @see SNMPBean#action
   * @see InterfaceGetNextPdu
   * @see InterfaceIndexesBean
   * 
   * @author <a href="mailto:snmp@westhawk.co.uk">Birgit Arkesteijn</a>
   * @version $Revision: 1.14 $ $Date: 2006/01/25 18:08:56 $
   */
  public class OneInterfaceBean extends SNMPRunBean implements Observer 
  {
      private static final String     version_id =
          "@(#)$Id: OneInterfaceBean.java,v 1.14 2006/01/25 18:08:56 birgit Exp $ Copyright Westhawk Ltd";
  
      private InterfaceGetNextPdu pdu, prev;
  
      private boolean isPduInFlight;
      private Date lastUpdateDate = null;
  
      private int index = 1;
      private String descr = "";
      private String operState = "";
      private long speed = -1;
  
  
 /**
  * The default constructor.
  */
 public OneInterfaceBean() 
 {
 }
 
 /**
  * The constructor that will set the host and the port no.
  *
  * @param h the hostname
  * @param p the port no
  * @see SNMPBean#setHost
  * @see SNMPBean#setPort
  */
 public OneInterfaceBean(String h, int p) 
 {
     this(h, p, null);
 }
 
 /**
  * The constructor that will set the host, the port no and the local
  * bind address.
  *
  * @param h the hostname
  * @param p the port no
  * @param b the local bind address
  * @see SNMPBean#setHost
  * @see SNMPBean#setPort
  * @see SNMPBean#setBindAddress
  *
  * @since 4_14
  */
 public OneInterfaceBean(String h, int p, String b) 
 {
     this();
     setHost(h);
     setPort(p);
     setBindAddress(b);
 }
 
 /**
  * Sets the index of the interface that will be requested.
  * @param i the index
  * @see #getIndex()
  */
 public void setIndex(int i)
 {
     if (index != i)
     {
         index = i;
     }
 }
 
 /**
  * Returns the index of the interface.
  * @return the index
  * @see #setIndex(int)
  */
 public int getIndex()
 {
     return index;
 }
 
 /**
  * Returns the description of the interface.
  * @return the description
  */
 public String getDescription()
 {
     return descr;
 }
 
 /**
  * Returns the operation state of the interface.
  * @return the operation state
  */
 public String getOperStatusString()
 {
     return operState;
 }
 
 /**
  * Returns the speed (bits per second) of the interface.
  * @return the speed
  */
 public long getSpeed()
 {
     return speed;
 }
 
 /**
  * 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();
         isPduInFlight = false;
         setRunning(true);
     }
 }
 
 
 /**
  * The run method according to the Runnable interface.
  * This method will send the Pdu request, if the previous one is not
  * still in flight.
  * @see SNMPRunBean#isRunning()
  */
 public void run()
 {
     while (context != null && isRunning())
     {
         if (isPduInFlight == false)
         {
             isPduInFlight = true;
             prev = pdu;
             try
             {
                 pdu = new InterfaceGetNextPdu(context);
                 pdu.addObserver(this);
                 pdu.addOids(index-1);
                 pdu.send();
             }
             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)
         {
             ;
         }
     }
 }
 
 /**
  * The update method according to the Observer interface, it will be
  * called when the Pdu response is received.
  * The speed is calculated with the previous answer, after that the
  * property change event is fired.
  *
  * @see SNMPBean#addPropertyChangeListener
  */
 public void update(Observable obs, Object ov)
 {
     if (pdu.getErrorStatus() == AsnObject.SNMP_ERR_NOERROR)
     {
         if (prev != null)
         {
             speed = pdu.getSpeed(prev);
         }
         
         descr = pdu.getIfDescr();
         operState = pdu.getIfOperStatusStr();
 
         lastUpdateDate = new Date();
         isPduInFlight = false;
         firePropertyChange("Interface", null, null);
     }
 }
 
 
 }