opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/StaticRouteConfig.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 package org.opendaylight.controller.forwarding.staticrouting;
  11
  12 import java.io.Serializable;
  13 import java.lang.reflect.Field;
  14 import java.net.InetAddress;
  15 import java.net.UnknownHostException;
  16 import java.util.ArrayList;
  17 import java.util.HashMap;
  18 import java.util.List;
  19 import java.util.Map;
  20
  21 import org.opendaylight.controller.sal.utils.GUIField;
  22 import org.opendaylight.controller.sal.utils.Status;
  23 import org.opendaylight.controller.sal.utils.StatusCode;
  24
  25 /**
  26  * This class defines all the necessary configuration information for a static route.
  27  */
  28 public class StaticRouteConfig implements Serializable {
  29     private static final long serialVersionUID = 1L;
  30     private static final String regexSubnet = "^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\."
  31             + "([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\."
  32             + "([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\."
  33             + "([01]?\\d\\d?|2[0-4]\\d|25[0-5])[/](\\d|[12]\\d|3[0-2])$";
  34     private static final String regexIP = "^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\."
  35             + "([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\."
  36             + "([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\."
  37             + "([01]?\\d\\d?|2[0-4]\\d|25[0-5])$";
  38     private static final String regexDatapathID = "^([0-9a-fA-F]{1,2}[:-]){7}[0-9a-fA-F]{1,2}$";
  39     private static final String regexDatapathIDLong = "^[0-9a-fA-F]{1,16}$";
  40     private static final String prettyFields[] = { GUIField.NAME.toString(),
  41             GUIField.STATICROUTE.toString(), GUIField.NEXTHOP.toString() };
  42     private transient String nextHopType; // Ignoring NextHopType for now. Supporting just the next-hop IP-Address feature for now.
  43     // Order matters: JSP file expects following fields in the following order
  44     private String name;
  45     private String staticRoute; // A.B.C.D/MM  Where A.B.C.D is the Default Gateway IP (L3) or ARP Querier IP (L2)
  46     private String nextHop; // NextHop IP-Address (or) datapath ID/port list: xx:xx:xx:xx:xx:xx:xx:xx/a,b,c-m,r-t,y
  47
  48     /**
  49      * Create a static route configuration  with no specific information.
  50      */
  51     public StaticRouteConfig() {
  52         super();
  53         nextHopType = StaticRoute.NextHopType.IPADDRESS.toString();
  54     }
  55
  56     /**
  57      * Create a static route configuration with all the information.
  58      * @param name The name (String) of the static route config
  59      * @param staticRoute The string representation of the route. e.g. 192.168.1.1/24
  60      * @param nextHop The string representation of the next hop IP address. e.g. 10.10.1.1
  61      */
  62     public StaticRouteConfig(String name, String staticRoute, String nextHop) {
  63         super();
  64         this.name = name;
  65         this.staticRoute = staticRoute;
  66         this.nextHop = nextHop;
  67     }
  68
  69     /**
  70      * Get the name of the StaticRouteConfig.
  71      * @return: The name
  72      */
  73     public String getName() {
  74         return name;
  75     }
  76
  77     /**
  78      * Set the name of the StaticRouteConfig.
  79      * @param name The name to set
  80      */
  81     public void setName(String name) {
  82         this.name = name;
  83     }
  84
  85     /**
  86      * Get the string representation of the static route.
  87      * @return The string representation of the static route
  88      */
  89     public String getStaticRoute() {
  90         return staticRoute;
  91     }
  92
  93     /**
  94      * Set the static route of the StaticRouteConfig.
  95      * @param staticRoute The string representation of the static route
  96      */
  97     public void setStaticRoute(String staticRoute) {
  98         this.staticRoute = staticRoute;
  99     }
 100
 101     /**
 102      * Get the string representation of the next hop address type.
 103      * @return The string representation of the next hop address type
 104      */
 105     public String getNextHopType() {
 106         if (nextHopType == null) {
 107             return StaticRoute.NextHopType.IPADDRESS.toString();
 108         }
 109         return nextHopType;
 110     }
 111
 112     /**
 113      * Set the next hop address type.
 114      * @param nextHopType The string representation of the next hop address type
 115      */
 116     public void setNextHopType(String nextHopType) {
 117         this.nextHopType = nextHopType;
 118     }
 119
 120     /**
 121      * Get all the supported next hop address types.
 122      * @return The list of supported next hop address types
 123      */
 124     public static List<String> getSupportedNextHopTypes() {
 125         List<String> s = new ArrayList<String>();
 126         for (StaticRoute.NextHopType nh : StaticRoute.NextHopType.values()) {
 127             s.add(nh.toString());
 128         }
 129         return s;
 130     }
 131
 132     /**
 133      * Get the next hop address
 134      * @return The string represenation of the next hop address
 135      */
 136     public String getNextHop() {
 137         return nextHop;
 138     }
 139
 140     /**
 141      * Set the next hop address.
 142      * @param nextHop: The string representation of the next hop address to be set
 143      */
 144     public void setNextHop(String nextHop) {
 145         this.nextHop = nextHop;
 146     }
 147
 148     /**
 149      * Return a string with text indicating if the config is valid.
 150      * @return SUCCESS if the config is valid
 151      */
 152     public Status isValid() {
 153         if ((name == null) || (name.trim().length() < 1)) {
 154             return new Status(StatusCode.BADREQUEST,
 155                         "Invalid Static Route name");
 156         }
 157         if (!isValidStaticRouteEntry()) {
 158             return new Status(StatusCode.BADREQUEST,
 159                         "Invalid Static Route entry. Please use the " +
 160                         "IPAddress/mask format. Default gateway " +
 161                         "(0.0.0.0/0) is NOT supported.");
 162         }
 163         if (!isValidNextHop()) {
 164             return new Status(StatusCode.BADREQUEST,
 165                         "Invalid NextHop IP Address configuration. " +
 166                                         "Please use the X.X.X.X format.");
 167         }
 168
 169         return new Status(StatusCode.SUCCESS, null);
 170     }
 171
 172     private boolean isValidAddress(String address) {
 173         if ((address != null) && address.matches(regexIP)) {
 174             return true;
 175         }
 176         return false;
 177     }
 178
 179     private boolean isValidStaticRouteEntry() {
 180         if ((staticRoute != null) && staticRoute.matches(regexSubnet)) {
 181             return true;
 182         }
 183         return false;
 184     }
 185
 186     private boolean isValidNextHop() {
 187         if (getNextHopType().equalsIgnoreCase(
 188                 StaticRoute.NextHopType.IPADDRESS.toString())) {
 189             return isValidNextHopIP();
 190         } else if (getNextHopType().equalsIgnoreCase(
 191                 StaticRoute.NextHopType.SWITCHPORT.toString())) {
 192             return isValidSwitchId();
 193         }
 194         return false;
 195     }
 196
 197     private boolean isValidNextHopIP() {
 198         return isValidAddress(nextHop);
 199     }
 200
 201     private boolean isValidSwitchId(String switchId) {
 202         return (switchId != null && (switchId.matches(regexDatapathID) || switchId
 203                 .matches(regexDatapathIDLong)));
 204     }
 205
 206     private boolean isValidSwitchId() {
 207         if (getNextHopType().equalsIgnoreCase(
 208                 StaticRoute.NextHopType.SWITCHPORT.toString())) {
 209             String pieces[] = nextHop.split("/");
 210             if (pieces.length < 2)
 211                 return false;
 212             return isValidSwitchId(pieces[0]);
 213         }
 214         return false;
 215     }
 216
 217     /**
 218      * Return the IP address of the static route.
 219      * @return The IP address
 220      */
 221     public InetAddress getStaticRouteIP() {
 222         if (!isValidStaticRouteEntry()) {
 223             return null;
 224         }
 225         InetAddress ip = null;
 226         try {
 227             ip = InetAddress.getByName(staticRoute.split("/")[0]);
 228         } catch (UnknownHostException e1) {
 229             return null;
 230         }
 231         return ip;
 232     }
 233
 234     /**
 235      * Return the bit-mask length of the static route.
 236      * @return The bit-mask length
 237      */
 238     public Short getStaticRouteMask() {
 239         Short maskLen = 0;
 240         if (isValidStaticRouteEntry()) {
 241             String[] s = staticRoute.split("/");
 242             maskLen = (s.length == 2) ? Short.valueOf(s[1]) : 32;
 243         }
 244         return maskLen;
 245     }
 246
 247     /**
 248      * Return the IP address of the next hop.
 249      * @return the IP address
 250      */
 251     public InetAddress getNextHopIP() {
 252         if ((getNextHopType()
 253                 .equalsIgnoreCase(StaticRoute.NextHopType.IPADDRESS.toString()))
 254                 && isValidNextHopIP()) {
 255             InetAddress ip = null;
 256             try {
 257                 ip = InetAddress.getByName(nextHop);
 258             } catch (UnknownHostException e1) {
 259                 return null;
 260             }
 261             return ip;
 262         }
 263         return null;
 264     }
 265
 266 /**
 267  * Return the switch ID and the port ID of the next hop address.
 268  * @return The switchID (Long) and PortID (Short) in the map
 269  */
 270     public Map<Long, Short> getNextHopSwitchPorts() {
 271         // codedSwitchPorts = xx:xx:xx:xx:xx:xx:xx:xx/port-number
 272         if (getNextHopType().equalsIgnoreCase(
 273                 StaticRoute.NextHopType.SWITCHPORT.toString())) {
 274             Map<Long, Short> sp = new HashMap<Long, Short>(1);
 275             String pieces[] = nextHop.split("/");
 276             sp.put(getSwitchIDLong(pieces[0]), Short.valueOf(pieces[1]));
 277             return sp;
 278         }
 279         return null;
 280     }
 281
 282     private long getSwitchIDLong(String switchId) {
 283         int radix = 16;
 284         String switchString = "0";
 285
 286         if (isValidSwitchId(switchId)) {
 287             if (switchId.contains(":")) {
 288                 // Handle the 00:00:AA:BB:CC:DD:EE:FF notation
 289                 switchString = switchId.replace(":", "");
 290             } else if (switchId.contains("-")) {
 291                 // Handle the 00-00-AA-BB-CC-DD-EE-FF notation
 292                 switchString = switchId.replace("-", "");
 293             } else {
 294                 // Handle the 0123456789ABCDEF notation
 295                 switchString = switchId;
 296             }
 297         }
 298         return Long.parseLong(switchString, radix);
 299     }
 300
 301     /**
 302      * Return all the field names of the config.
 303      * @return The list containing all the field names
 304      */
 305     public static List<String> getFieldsNames() {
 306         List<String> fieldList = new ArrayList<String>();
 307         for (Field fld : StaticRouteConfig.class.getDeclaredFields()) {
 308             fieldList.add(fld.getName());
 309         }
 310         //remove the 6 static fields + NextHopType
 311         for (short i = 0; i < 7; i++) {
 312             fieldList.remove(0);
 313         }
 314         return fieldList;
 315     }
 316
 317     /**
 318      * Return all the GUI field names of the config.
 319      * @return The list containing all the GUI field names
 320      */
 321     public static List<String> getGuiFieldsNames() {
 322         List<String> fieldList = new ArrayList<String>();
 323         for (String str : prettyFields) {
 324             fieldList.add(str);
 325         }
 326         return fieldList;
 327     }
 328
 329     @Override
 330     public int hashCode() {
 331         final int prime = 31;
 332         int result = 1;
 333         result = prime * result + ((name == null) ? 0 : name.hashCode());
 334         result = prime * result + ((nextHop == null) ? 0 : nextHop.hashCode());
 335         result = prime * result
 336                 + ((staticRoute == null) ? 0 : staticRoute.hashCode());
 337         return result;
 338     }
 339
 340     @Override
 341     public boolean equals(Object obj) {
 342         if (this == obj) {
 343             return true;
 344         }
 345         if (obj == null) {
 346             return false;
 347         }
 348         if (getClass() != obj.getClass()) {
 349             return false;
 350         }
 351         StaticRouteConfig other = (StaticRouteConfig) obj;
 352         if (name == null) {
 353             if (other.name != null)
 354                 return false;
 355         } else if (!name.equals(other.name))
 356             return false;
 357         if (nextHop == null) {
 358             if (other.nextHop != null)
 359                 return false;
 360         } else if (!nextHop.equals(other.nextHop))
 361             return false;
 362         if (staticRoute == null) {
 363             if (other.staticRoute != null)
 364                 return false;
 365         } else if (!staticRoute.equals(other.staticRoute))
 366             return false;
 367         return true;
 368     }
 369
 370     @Override
 371     public String toString() {
 372         return "StaticRouteConfig [name=" + name + ", staticRoute="
 373                 + staticRoute + ", nextHopType=" + nextHopType + ", nextHop="
 374                 + nextHop + "]";
 375     }
 376 }