Interface.java

package org.batfish.representation.cisco;

import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;

import org.batfish.common.util.ComparableStructure;
import org.batfish.datamodel.IsisInterfaceMode;
import org.batfish.datamodel.Prefix;
import org.batfish.datamodel.SubRange;
import org.batfish.datamodel.SwitchportEncapsulationType;
import org.batfish.datamodel.SwitchportMode;

public class Interface extends ComparableStructure<String> {

   private static final double DEFAULT_INTERFACE_BANDWIDTH = 1E12;

   private static final int DEFAULT_INTERFACE_MTU = 1500;

   /**
    * NX-OS Ethernet 802.3z - may not apply for non-NX-OS
    */
   private static final double ETHERNET_BANDWIDTH = 1E9;

   private static final double FAST_ETHERNET_BANDWIDTH = 100E6;

   private static final double GIGABIT_ETHERNET_BANDWIDTH = 1E9;

   private static final double LONG_REACH_ETHERNET_BANDWIDTH = 10E6;

   /**
    * dirty hack: just chose a very large number
    */
   private static final double LOOPBACK_BANDWIDTH = 1E12;

   private static final long serialVersionUID = 1L;

   private static final double TEN_GIGABIT_ETHERNET_BANDWIDTH = 10E9;

   public static double getDefaultBandwidth(String name) {
      Double bandwidth = null;
      if (name.startsWith("Ethernet")) {
         bandwidth = ETHERNET_BANDWIDTH;
      }
      else if (name.startsWith("FastEthernet")) {
         bandwidth = FAST_ETHERNET_BANDWIDTH;
      }
      else if (name.startsWith("GigabitEthernet")) {
         bandwidth = GIGABIT_ETHERNET_BANDWIDTH;
      }
      else if (name.startsWith("LongReachEthernet")) {
         bandwidth = LONG_REACH_ETHERNET_BANDWIDTH;
      }
      else if (name.startsWith("TenGigabitEthernet")) {
         bandwidth = TEN_GIGABIT_ETHERNET_BANDWIDTH;
      }
      else if (name.startsWith("Vlan")) {
         bandwidth = null;
      }
      else if (name.startsWith("Loopback")) {
         bandwidth = LOOPBACK_BANDWIDTH;
      }
      if (bandwidth == null) {
         bandwidth = DEFAULT_INTERFACE_BANDWIDTH;
      }
      return bandwidth;
   }

   public static int getDefaultMtu() {
      return DEFAULT_INTERFACE_MTU;
   }

   private int _accessVlan;

   private boolean _active;

   private ArrayList<SubRange> _allowedVlans;

   private Double _bandwidth;

   private String _description;

   private String _incomingFilter;

   private int _incomingFilterLine;

   private Integer _isisCost;

   private IsisInterfaceMode _isisInterfaceMode;

   private int _mtu;

   private int _nativeVlan;

   private boolean _ospfActive;

   private Long _ospfArea;

   private Integer _ospfCost;

   private int _ospfDeadInterval;

   private int _ospfHelloMultiplier;

   private boolean _ospfPassive;

   private String _outgoingFilter;

   private int _outgoingFilterLine;

   private Prefix _prefix;

   private boolean _proxyArp;

   private String _routingPolicy;

   int _routingPolicyLine;

   private Set<Prefix> _secondaryPrefixes;

   private Prefix _standbyPrefix;

   private boolean _switchportAccessDynamic;

   private SwitchportMode _switchportMode;

   private SwitchportEncapsulationType _switchportTrunkEncapsulation;

   private String _vrf;

   public Interface(String name) {
      super(name);
      _active = true;
      _allowedVlans = new ArrayList<>();
      _isisInterfaceMode = IsisInterfaceMode.UNSET;
      _nativeVlan = 1;
      _secondaryPrefixes = new LinkedHashSet<>();
      _switchportMode = SwitchportMode.NONE;
   }

   public void addAllowedRanges(List<SubRange> ranges) {
      _allowedVlans.addAll(ranges);
   }

   public int getAccessVlan() {
      return _accessVlan;
   }

   public boolean getActive() {
      return _active;
   }

   public List<SubRange> getAllowedVlans() {
      return _allowedVlans;
   }

   public Set<Prefix> getAllPrefixes() {
      Set<Prefix> allPrefixes = new TreeSet<>();
      if (_prefix != null) {
         allPrefixes.add(_prefix);
      }
      allPrefixes.addAll(_secondaryPrefixes);
      return allPrefixes;
   }

   public Double getBandwidth() {
      return _bandwidth;
   }

   public String getDescription() {
      return _description;
   }

   public String getIncomingFilter() {
      return _incomingFilter;
   }

   public int getIncomingFilterLine() {
      return _incomingFilterLine;
   }

   public Integer getIsisCost() {
      return _isisCost;
   }

   public IsisInterfaceMode getIsisInterfaceMode() {
      return _isisInterfaceMode;
   }

   public int getMtu() {
      return _mtu;
   }

   public int getNativeVlan() {
      return _nativeVlan;
   }

   public boolean getOspfActive() {
      return _ospfActive;
   }

   public Long getOspfArea() {
      return _ospfArea;
   }

   public Integer getOspfCost() {
      return _ospfCost;
   }

   public int getOspfDeadInterval() {
      return _ospfDeadInterval;
   }

   public int getOspfHelloMultiplier() {
      return _ospfHelloMultiplier;
   }

   public boolean getOspfPassive() {
      return _ospfPassive;
   }

   public String getOutgoingFilter() {
      return _outgoingFilter;
   }

   public int getOutgoingFilterLine() {
      return _outgoingFilterLine;
   }

   public Prefix getPrefix() {
      return _prefix;
   }

   public boolean getProxyArp() {
      return _proxyArp;
   }

   public String getRoutingPolicy() {
      return _routingPolicy;
   }

   public int getRoutingPolicyLine() {
      return _routingPolicyLine;
   }

   public Set<Prefix> getSecondaryPrefixes() {
      return _secondaryPrefixes;
   }

   public Prefix getStandbyPrefix() {
      return _standbyPrefix;
   }

   public boolean getSwitchportAccessDynamic() {
      return _switchportAccessDynamic;
   }

   public SwitchportMode getSwitchportMode() {
      return _switchportMode;
   }

   public SwitchportEncapsulationType getSwitchportTrunkEncapsulation() {
      return _switchportTrunkEncapsulation;
   }

   public String getVrf() {
      return _vrf;
   }

   public void setAccessVlan(int vlan) {
      _accessVlan = vlan;
   }

   public void setActive(boolean active) {
      _active = active;
   }

   public void setBandwidth(Double bandwidth) {
      _bandwidth = bandwidth;
   }

   public void setDescription(String description) {
      _description = description;
   }

   public void setIncomingFilter(String accessListName) {
      _incomingFilter = accessListName;
   }

   public void setIncomingFilterLine(int incomingFilterLine) {
      _incomingFilterLine = incomingFilterLine;
   }

   public void setIsisCost(Integer isisCost) {
      _isisCost = isisCost;
   }

   public void setIsisInterfaceMode(IsisInterfaceMode mode) {
      _isisInterfaceMode = mode;
   }

   public void setMtu(int mtu) {
      _mtu = mtu;
   }

   public void setNativeVlan(int vlan) {
      _nativeVlan = vlan;
   }

   public void setOspfActive(boolean ospfActive) {
      _ospfActive = ospfActive;
   }

   public void setOspfArea(Long ospfArea) {
      _ospfArea = ospfArea;
   }

   public void setOspfCost(int ospfCost) {
      _ospfCost = ospfCost;
   }

   public void setOspfDeadInterval(int seconds) {
      _ospfDeadInterval = seconds;
   }

   public void setOspfHelloMultiplier(int multiplier) {
      _ospfHelloMultiplier = multiplier;
   }

   public void setOspfPassive(boolean ospfPassive) {
      _ospfPassive = ospfPassive;
   }

   public void setOutgoingFilter(String accessListName) {
      _outgoingFilter = accessListName;
   }

   public void setOutgoingFilterLine(int outgoingFilterLine) {
      _outgoingFilterLine = outgoingFilterLine;
   }

   public void setPrefix(Prefix prefix) {
      _prefix = prefix;
   }

   public void setProxyArp(boolean proxyArp) {
      _proxyArp = proxyArp;
   }

   public void setRoutingPolicy(String routingPolicy) {
      _routingPolicy = routingPolicy;
   }

   public void setRoutingPolicyLine(int routingPolicyLine) {
      _routingPolicyLine = routingPolicyLine;
   }

   public void setStandbyPrefix(Prefix standbyPrefix) {
      _standbyPrefix = standbyPrefix;
   }

   public void setSwitchportAccessDynamic(boolean switchportAccessDynamic) {
      _switchportAccessDynamic = switchportAccessDynamic;
   }

   public void setSwitchportMode(SwitchportMode switchportMode) {
      _switchportMode = switchportMode;
   }

   public void setSwitchportTrunkEncapsulation(
         SwitchportEncapsulationType encapsulation) {
      _switchportTrunkEncapsulation = encapsulation;
   }

   public void setVrf(String vrf) {
      _vrf = vrf;
   }

}