swport.java

Network Administration Visualized 网络管理可视化源码

/*
 * $Id: Swport.java 3564 2006-07-20 09:04:01Z mortenv $
 *
 * Copyright 2003-2005 Norwegian University of Science and Technology
 * 
 * This file is part of Network Administration Visualized (NAV)
 * 
 * NAV is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * NAV 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 Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with NAV; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *
 * Authors: Kristian Eide <[e-mail]>
 * 
 */
package no.ntnu.nav.getDeviceData.dataplugins.Swport;

import java.util.ArrayList;

import no.ntnu.nav.logger.Log;
import no.ntnu.nav.util.util;


/**
 * Contain Swport data
 */

public class Swport implements Comparable
{
	/**
	 * The switch port has link.
	 */
	public static final char PORT_LINK_YES = 'y';

	/**
	 * The switch port does not have link.
	 */
	public static final char PORT_LINK_NO = 'n';

	/**
	 * The switch port is turned off (admin down).
	 */
	public static final char PORT_LINK_DOWN = 'd';

	private int swportid;

	private Integer port;
	private String ifindex;

	private String interf;
	private Character link;
	private String speed;
	private Character duplex;
	private String media;
	private Boolean trunk;
	private String portname;

	private Integer vlan;
	private ArrayList vlanList;

	private String hexstring;
	private boolean retEmptyHexstring = false;

	private boolean assignedToModule;

	Swport(String ifindex)
	{
		this.ifindex = ifindex.trim();
		Integer.parseInt(this.ifindex);
	}

	public void setData(Integer port, char link, String speed, char duplex, String media, String portname) {
		setPort(port);
		setLink(link);
		setSpeed(speed);
		setDuplex(duplex);
		setMedia(media);
		setPortname(portname);
	}

	int getSwportid() { return swportid; }
	String getSwportidS() { return String.valueOf(swportid); }
	void setSwportid(int i) { swportid = i; }
	void setSwportid(String s) { swportid = Integer.parseInt(s); }

	public Integer getPort() { return port; }
	String getPortS() {
		if (port == null) return null;
		return ((port.toString().length()==1)?"0":"")+getPort();
	}

	public String getIfindex() { return ifindex; }
	String getIfindexS() { return ((ifindex.length()==1)?"0":"")+getIfindex(); }

	public String getInterface() { return interf; }

	public Character getLink() { return link; }
	String getLinkS() { return string(link); }

	public String getSpeed() { return speed; }
	public Character getDuplex() { return duplex; }
	String getDuplexS() {
		if (duplex == null) return null;
		String s = String.valueOf(duplex).trim();
		if (s.length() == 0) {
			Log.w("SWPORT", "MISSING_DUPLEX", "Defaulting to full duplex. Port="+getPort()+", Swportid="+getSwportid());
			return "f";
		}
		return s;
	}

	public String getMedia() { return media; }

	void assignedToModule() { assignedToModule = true; }
	boolean isAssignedToModule() { return assignedToModule; }

	/**
	 * Set the port number.
	 */
	public void setPort(Integer port) {
		this.port = port;
	}

	/**
	 * Set the interface name (ifDescr).
	 */
	public void setInterface(String interf) {
		this.interf = interf;
	}

	/**
	 * Get if the port is using trunking or not.
	 */
	public Boolean getTrunk() { return trunk; }
	boolean getTrunkB() { return trunk != null && trunk.booleanValue(); }
	String getTrunkS() {
		if (getTrunk() == null) return null;
		return getTrunk().booleanValue()?"t":"f";
	}
	String getPortname() { return portname; }

	/**
	 * Set the link status of the port:
	 * 
	 * <ul>
	 *  <li>'y' means link is up</li>
	 *  <li>'n' means link is down</li>
	 *  <li>'d' means the port is turned off (adm down)</li>
	 * </ul>
	 */
	public void setLink(char c) { link = new Character(c); }

	/**
	 * Set the current speed of the port in MBit/sec.
	 *
	 */
	public void setSpeed(String s) { speed = trim(s); }

	/**
	 * Set the current duplex of the port:
	 * 
	 * <ul>
	 *  <li>'f' means full duplex</li>
	 *  <li>'h' means half duplex</li>
	 * </ul>
	 */
	public void setDuplex(char c) { duplex = new Character(c); }

	/**
	 * Set the media type for the port, e.g. "100BaseTX" for a 100Mbit TP port.
	 */
	public void setMedia(String s) { media = trim(s); }

	/**
	 * Set if the port is using trunking or not.
	 */
	public void setTrunk(boolean b) {
		trunk = new Boolean(b);
		if (b && vlanList == null) vlanList = new ArrayList();
	}

	/**
	 * Set the port name
	 */
	public void setPortname(String s) {
		if (s != null && s.trim().length() > 0) {
			portname = s.trim();
		} else {
			portname = null;
		}
	}

	Integer getVlan() { return vlan; }
	String getVlanS() { return string(vlan); }

	/**
	 * Set the vlan; only use this for non-trunking ports.
	 */
	public void setVlan(int i) {
		setTrunk(false);
		vlan = new Integer(i);
	}

	/**
	 * Used for trunking ports; call this method to add the VLANs
	 * allowed on the port. setTrunk(true) must be called before this
	 * method.
	 */
	public void addTrunkVlan(String vlan) {
		if (!getTrunkB()) return;
		retEmptyHexstring = true;
		vlanList.add(vlan);
	}

	public String getHexstring() {
		if (hexstring == null && retEmptyHexstring) hexstring = getVlanAllowHexString();
		return hexstring;
	}

	void setRetEmptyHexstring(boolean b) { retEmptyHexstring = b; }

	/**
	 * Set the allowed VLANs as a hexstring (used on Cisco devices).
	 */
	public void setHexstring(String s) {
		hexstring = s;
		if (hexstring != null) {
			// Make the hexstring a bit nicer
			hexstring = util.remove(hexstring, ":").toLowerCase();
		}
	}

	/**
	 * <p>Compute a Cisco proprietary hex string to describe which VLANs are
	 * allowed on this port.</p>
	 * 
	 * <p>The algorithm is described at 
	 * <a href="http://tools.cisco.com/Support/SNMP/do/BrowseOID.do?local=en&translate=Translate&objectInput=1.3.6.1.4.1.9.5.1.9.3.1.5">
	 * Cisco's SNMP object navigator</a>.  The algorithm is described only for
	 * VLAN values up to 1023, so this function will sadly ignore any allowed
	 * VLANs above this value.<p>
	 * 
	 * @return A hexadecimal string of 512 digits. If this is not a trunk port, an empty string is returned.
	 * 
	 */
	String getVlanAllowHexString()
	{
		if (!getTrunkB()) return "";

		int[] a = new int[256];
		for (int i=0; i < a.length; i++) a[i] = 0;

		for (int i=0; i < vlanList.size(); i++) {
			int vlan = Integer.parseInt((String)vlanList.get(i));
			if (vlan > 1023) {
				Log.d("SWPORT", "VLAN_ALLOWED_HEXSTRING", "Ignoring vlan " + vlan + " when computing hex string for ifindex " + ifindex + " (interface:" + interf + " / portname:" + portname + ")");
				continue; // Ignore VLANs above 1023
			}

			int index = vlan / 4;
			a[index] ^= (1<<3-(vlan%4));
		}

		StringBuffer sb = new StringBuffer();
		for (int i=0; i < a.length; i++) sb.append(Integer.toString(a[i], 16));

		return sb.toString();
	}

	/*
	public static void main(String[] args)
	{
		String s = "4080000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000040000000000008000000000000000000";
		for (int i=0;i<1024;i++) {
			if (isAllowedVlan(s, i)) System.out.println("vlan " + i + " allowed");
		}

	}
	private static boolean isAllowedVlan(String hexstr, int vlan)
	{
		if (vlan < 0 || vlan > 1023) return false;
		int index = vlan / 4;

		int allowed = Integer.parseInt(String.valueOf(hexstr.charAt(index)), 16);
		return ((allowed & (1<<3-(vlan%4))) != 0);
	}
	*/

	/**
	 * Checks if all fields in the given swport are equal to this one.
	 */
	public boolean equalsSwport(Swport sw) {
		return (ifindex.equals(sw.ifindex) &&
						(port == null || port.equals(sw.port)) &&
						(interf == null || interf.equals(sw.interf)) &&
						(link == null || link.equals(sw.link)) &&
						(speed == null || speed.equals(sw.speed)) &&
						(duplex == null || duplex.equals(sw.duplex)) &&
						(media == null || media.equals(sw.media)) &&
						(vlan == null || vlan.equals(sw.vlan)) &&
						(trunk == null || trunk.equals(sw.trunk)) &&
						(portname == null || portname.equals(sw.portname)));
	}

	/**
	 * Two swports are equal if their module number and ifindex are
	 * equal.
	 */
	public boolean equals(Object o) {
		return (o instanceof Swport &&
						ifindex != null &&
						ifindex.equals(((Swport)o).ifindex));
	}

	public int compareTo(Object o) {
		Swport sw = (Swport)o;
		return ifindex.compareTo(sw.ifindex);
	}

	public String toString() {
		return getIfindexS() + "," +
			" Port: " + getPort() +
			" Interface: " + getInterface() +
			" Link: " + getLink() +
			" Speed: " + speed +
			" Duplex: " + duplex +
			" Media: " + media +
			" Vlan: " + vlan +
			" Trunk: " + trunk +
			" Portname: " + portname;
	}

	private String trim(String s) {
		return (s == null) ? s : s.trim();
	}

	private String string(Object o) {
		if (o == null) return null;
		return String.valueOf(o);
	}

}