dialogchannelstatusbean.java

snmp zip 包开发snmp协议

// NAME
//      $RCSfile: DialogChannelStatusBean.java,v $
// DESCRIPTION
//      [given below in javadoc format]
// DELTA
//      $Revision: 1.18 $
// CREATED
//      $Date: 2006/02/02 15:49:39 $
// 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 javax.swing.tree.*;
import java.awt.*;
import java.util.*;
import java.text.*;
import java.lang.*;
import java.io.*;
import java.beans.*;

/**
 * <p>
 * This bean is written for a Dialogic card.
 *
 * The Dialogic MIBs come with their 
 * <a
 * href="http://support.dialogic.com/Download/boardwatch/index.htm">BoardWatch
 * package</a>. You will have to fill in a form before downloading it.
 *
 * <p>
 * This bean collects information about the voice channel status of the
 * Dialogic card. It will only collect those channels that are open.
 * </p>
 *
 * <p>
 * You can get the data via the getChannelIndexes() and 
 * getChannelStatus(Integer index) methods. This way you can visualise
 * the data yourself. 
 * </p>
 *
 * <p>
 * You can also use the Swing JTree to visualise the channels.
 * This bean implements the Swing TreeNode interface. 
 * The user has to set the setDefaultTreeModel, so this class can update all
 * the nodes that are added, removed of changed.
 * If this class is <em>not</em> the root of the JTree, you have to set
 * the (TreeNode) parent of this class.
 * </p>
 *
 * <p>
 * The properties in the parent classes should be set, before calling
 * the action() method. Via a TreeModelEvent the application/applet
 * will be notified. 
 * </p>
 *
 * <p>
 * We only have one (1) Dialogics card, so I don't know how and if it
 * works with more than 1 card. Please let us know if it doesn't work.
 * </p>
 *
 * @see SNMPBean#setHost
 * @see SNMPBean#setPort
 * @see SNMPBean#setCommunityName
 * @see SNMPRunBean#setUpdateInterval
 * @see SNMPBean#addPropertyChangeListener
 * @see SNMPBean#action
 * @see GetNextPdu_vec
 * 
 * @author <a href="mailto:[e-mail]">Birgit Arkesteijn</a>
 * @version $Revision: 1.18 $ $Date: 2006/02/02 15:49:39 $
 *
 */
public class DialogChannelStatusBean extends SNMPRunBean 
        implements Observer, TreeNode
{
    private static final String     version_id =
        "@(#)$Id: DialogChannelStatusBean.java,v 1.18 2006/02/02 15:49:39 birgit Exp $ Copyright Westhawk Ltd";

    /**
     * A unique value for each R4 device contained by the
     * host.  The value for each R4 device must remain
     * constant at least from one re-initialization of the
     * agent to the next re-initialization.
     *
     * See the dlgr4dev.mib.
     */
    public final static String dlgR4DeviceIndex = 
          "1.3.6.1.4.1.3028.2.1.1.2.1.1.1";

    /**
     * Release 4 Device Name. This is the name the application will
     * use when opening the device (e.g. dxxxB1C1, dtiB1T1, msiB1C1)
     * See the dlgr4dev.mib.
     */
    public final static String dlgR4DeviceName = 
          "1.3.6.1.4.1.3028.2.1.1.2.1.1.2";

    /**
     * An indication of the type of the device.
     * <ol>
     * <li>
     * other - some other type of device unknown to the agent. </li>
     * <li>
     * voice - A voice channel device. An entry exits in the
     * dlgR4VoiceTable for this device. </li>
     * <li>
     * dti - A DTI timeslot device. An entry exits in the
     * dlgR4DTITable for this device. </li>
     * <li>
     * isdn - An ISDN B-Channel device. An entry exits in the
     * dlgR4ISDNTable for this device. </li>
     * <li>
     * msi - An MSI station set device. An entry exits in the
     * dlgR4MSITable for this device. </li>
     * </ol>
     * 
     * See the dlgr4dev.mib.
     */
    public final static String dlgR4DeviceType = 
          "1.3.6.1.4.1.3028.2.1.1.2.1.1.3";

    /**
     * An indication of how many instances of this device is currently 
     * opened.
     * See the dlgr4dev.mib.
     */
    public final static String dlgR4DeviceOpenCount =
          "1.3.6.1.4.1.3028.2.1.1.2.1.1.5";

    /**
     * Indicates current activity status on the (voice) channel.
     * See the dlgr4dev.mib.
     */
    public final static String dlgR4VoiceChannelStatus =
          "1.3.6.1.4.1.3028.2.1.1.2.2.1.2";

    private final static int NR_OID = 5;

    // dlgR4DeviceType values
    public final static int unknown = 1;
    public final static int voice = 2;
    public final static int dti = 3;
    public final static int isdn = 4;
    public final static int msi = 5;

    // dlgR4VoiceChannelStatus values
    public final static int idle = 1;
    public final static int playing = 2;
    public final static int recording = 3;
    public final static int gettingDigits = 5;
    public final static int blocked = 16;

    public final static int dialing = 4;
    public final static int playTone = 6;
    public final static int sendingFax = 8;
    public final static int receivingFax = 9;
    public final static int betweenFAXPages = 10;
    public final static int hookState = 11;
    public final static int winking = 12;
    public final static int callProgess = 13;
    public final static int gettingR2MF = 14;

    public final static String vch_status[] =
    {
        "",
        "Channel not active",
        "Playing Audio Data",
        "Recording Audio Data",
        "Dialing Digits",
        "Collecting DTMF digits",
        "Playing a tone",
        "",
        "Sending a FAX (VFX boards)",
        "Receiving a FAX (VFX boards)",
        "Between FAX pages (VFX boards)",
        "Changing hook status to onhook or offhook",
        "Performing a wink",
        "Performing Call progress analysis",
        "Retrieving R2MF digits",
        "",
        "Blocked"
    };

    private GetNextPdu_vec  pdu;
    private Hashtable       channelIndexStatusHash;
    private Hashtable       channelHash;

    private TreeNode          parent;
    private DefaultTreeModel  treeModel;

    private boolean         isGetNextInFlight;
    private Date            lastUpdateDate = null;

    private int             deviceType = 0;
    private String          deviceName = "";
    private int             openCount = 0;
    private int             channelStatus = 0;

/**
 * The default constructor.
 */
public DialogChannelStatusBean() 
{
    channelIndexStatusHash = new Hashtable();
    channelHash = new Hashtable();
}

/**
 * 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 DialogChannelStatusBean(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 DialogChannelStatusBean(String h, int p, String b) 
{
    this();
    setHost(h);
    setPort(p);
    setBindAddress(b);
}

/**
 * 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;
}

/**
 * Returns the indexes (as Integers) of the voice channels that are
 * open. Only the open voice channels of the card are saved.
 * 
 * Use getChannelStatus() or getChannelStatusString() to get the status
 * of the channel.
 *
 * @see #getChannelStatus
 * @see #getChannelStatusString
 */
public Enumeration getChannelIndexes()
{
    return channelIndexStatusHash.keys();
}
 
/**
 * Returns the number of voice channels in the table.
 */
public synchronized int getChannelCount()
{
    return channelIndexStatusHash.size();
}

/**
 * Returns the name of the channel.
 *
 * @param index The index of the channel
 * @return The name
 *
 */
public String getChannelName(Integer index)
{
    String name = "";
    Object obj = channelHash.get(index);
    if (obj != null)
    {
        ChannelStatus chSt = (ChannelStatus) obj;
        name = chSt.getName();
    }
    return name;
}

/**
 * Returns the status of the channel as an int.
 *
 * @param index The index of the channel
 * @return The status
 *
 * @see #getChannelIndexes
 */
public int getChannelStatus(Integer index)
{
    int status = 0;
    Object obj = channelIndexStatusHash.get(index);
    if (obj != null)
    {
        status = ((Integer)obj).intValue();
    }
    return status;
}

/**
 * Returns the String representation of the status of the channel.
 *
 * @param index The index of the channel
 * @return The status
 *
 * @see #getChannelIndexes
 */
public String getChannelStatusString(Integer index)
{
    int status = getChannelStatus(index);
    String str = vch_status[status];
    return str;
}

/**
 * Returns the children of the reciever as an Enumeration.
 */
public Enumeration children()
{
    return channelHash.elements();
}

/**
 * Returns the number of children <code>TreeNode</code>s the receiver
 * contains.
 */
public int getChildCount()
{
    int sz = channelHash.size();
    return sz;
}

/**
 * Returns the child <code>TreeNode</code> at index 
 * <code>childIndex</code>.
 */