Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 1 | /** |
Jonathan Hart | ac15d93 | 2014-06-01 22:59:35 -0700 | [diff] [blame^] | 2 | * Copyright 2011,2012, Big Switch Networks, Inc. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 3 | * Originally created by David Erickson, Stanford University |
| 4 | * |
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 6 | * not use this file except in compliance with the License. You may obtain |
| 7 | * a copy of the License at |
| 8 | * |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 14 | * License for the specific language governing permissions and limitations |
| 15 | * under the License. |
| 16 | **/ |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 17 | |
Jonathan Hart | 23701d1 | 2014-04-03 10:45:48 -0700 | [diff] [blame] | 18 | package net.onrc.onos.core.devicemanager; |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 19 | |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 20 | import java.io.Serializable; |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 21 | import java.util.Date; |
| 22 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 23 | import net.floodlightcontroller.util.MACAddress; |
| 24 | |
| 25 | /** |
| 26 | * An entity on the network is a visible trace of a device that corresponds |
| 27 | * to a packet received from a particular interface on the edge of a network, |
| 28 | * with a particular VLAN tag, and a particular MAC address, along with any |
| 29 | * other packet characteristics we might want to consider as helpful for |
| 30 | * disambiguating devices. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 31 | * <p/> |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 32 | * Entities are the most basic element of devices; devices consist of one or |
| 33 | * more entities. Entities are immutable once created, except for the last |
| 34 | * seen timestamp. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 35 | * |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 36 | * @author readams |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 37 | */ |
Jonathan Hart | ac15d93 | 2014-06-01 22:59:35 -0700 | [diff] [blame^] | 38 | public class OnosDevice implements Serializable { |
Jonathan Hart | 96892d1 | 2014-03-26 20:21:29 -0700 | [diff] [blame] | 39 | |
Jonathan Hart | ac15d93 | 2014-06-01 22:59:35 -0700 | [diff] [blame^] | 40 | private static final long serialVersionUID = 1L; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 41 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 42 | /** |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 43 | * The MAC address associated with this entity. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 44 | */ |
| 45 | private MACAddress macAddress; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 46 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 47 | /** |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 48 | * The VLAN tag on this entity, or null if untagged. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 49 | */ |
| 50 | private Short vlan; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 51 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 52 | /** |
| 53 | * The DPID of the switch for the ingress point for this entity, |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 54 | * or null if not present. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 55 | */ |
| 56 | private long switchDPID; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 57 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 58 | /** |
| 59 | * The port number of the switch for the ingress point for this entity, |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 60 | * or null if not present. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 61 | */ |
| 62 | private short switchPort; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 63 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 64 | /** |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 65 | * The last time we observed this entity on the network. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 66 | */ |
| 67 | private Date lastSeenTimestamp; |
| 68 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 69 | private int hashCode = 0; |
| 70 | |
| 71 | // ************ |
| 72 | // Constructors |
| 73 | // ************ |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 74 | protected OnosDevice() { |
| 75 | } |
| 76 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 77 | /** |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 78 | * Create a new entity. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 79 | * |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 80 | * @param macAddress |
| 81 | * @param vlan |
| 82 | * @param ipv4Address |
| 83 | * @param switchDPID |
| 84 | * @param switchPort |
| 85 | * @param lastSeenTimestamp |
| 86 | */ |
Jonathan Hart | ac15d93 | 2014-06-01 22:59:35 -0700 | [diff] [blame^] | 87 | public OnosDevice(MACAddress macAddress, Short vlan, Long switchDPID, |
| 88 | short switchPort, Date lastSeenTimestamp) { |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 89 | this.macAddress = macAddress; |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 90 | this.vlan = vlan; |
| 91 | this.switchDPID = switchDPID; |
| 92 | this.switchPort = switchPort; |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 93 | if (lastSeenTimestamp != null) { |
| 94 | this.lastSeenTimestamp = new Date(lastSeenTimestamp.getTime()); |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 95 | } else { |
| 96 | this.lastSeenTimestamp = null; |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 97 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 98 | } |
| 99 | |
| 100 | // *************** |
| 101 | // Getters/Setters |
| 102 | // *************** |
| 103 | |
| 104 | public MACAddress getMacAddress() { |
| 105 | return macAddress; |
| 106 | } |
| 107 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 108 | public Short getVlan() { |
| 109 | return vlan; |
| 110 | } |
| 111 | |
| 112 | public Long getSwitchDPID() { |
| 113 | return switchDPID; |
| 114 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 115 | |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 116 | public void setSwitchDPID(long dpid) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 117 | this.switchDPID = dpid; |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 118 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 119 | |
| 120 | public short getSwitchPort() { |
| 121 | return switchPort; |
| 122 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 123 | |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 124 | public void setSwitchPort(short port) { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 125 | this.switchPort = port; |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 126 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 127 | |
| 128 | public Date getLastSeenTimestamp() { |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 129 | if (this.lastSeenTimestamp == null) { |
| 130 | return null; |
| 131 | } |
| 132 | return new Date(this.lastSeenTimestamp.getTime()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 133 | } |
| 134 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 135 | public void setLastSeenTimestamp(Date lastSeenTimestamp) { |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 136 | this.lastSeenTimestamp = new Date(lastSeenTimestamp.getTime()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 137 | } |
| 138 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 139 | @Override |
| 140 | public int hashCode() { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 141 | if (hashCode != 0) { |
| 142 | return hashCode; |
| 143 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 144 | final int prime = 31; |
| 145 | hashCode = 1; |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 146 | hashCode = prime * hashCode + (int) (macAddress.toLong() ^ (macAddress.toLong() >>> 32)); |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 147 | hashCode = prime * hashCode + (int) switchDPID; |
| 148 | hashCode = prime * hashCode + (int) switchPort; |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 149 | hashCode = prime * hashCode + ((vlan == null) ? 0 : vlan.hashCode()); |
| 150 | return hashCode; |
| 151 | } |
| 152 | |
| 153 | @Override |
| 154 | public boolean equals(Object obj) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 155 | if (this == obj) { |
| 156 | return true; |
| 157 | } |
| 158 | if (obj == null) { |
| 159 | return false; |
| 160 | } |
| 161 | if (getClass() != obj.getClass()) { |
| 162 | return false; |
| 163 | } |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 164 | OnosDevice other = (OnosDevice) obj; |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 165 | if (hashCode() != other.hashCode()) { |
| 166 | return false; |
| 167 | } |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 168 | if (macAddress == null) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 169 | if (other.macAddress != null) { |
| 170 | return false; |
| 171 | } |
| 172 | } else if (!macAddress.equals(other.macAddress)) { |
| 173 | return false; |
| 174 | } |
| 175 | if (switchDPID != other.switchDPID) { |
| 176 | return false; |
| 177 | } |
| 178 | if (switchPort != other.switchPort) { |
| 179 | return false; |
| 180 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 181 | if (vlan == null) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 182 | if (other.vlan != null) { |
| 183 | return false; |
| 184 | } |
| 185 | } else if (!vlan.equals(other.vlan)) { |
| 186 | return false; |
| 187 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 188 | return true; |
| 189 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 190 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 191 | @Override |
| 192 | public String toString() { |
| 193 | StringBuilder builder = new StringBuilder(); |
| 194 | builder.append("Entity [macAddress="); |
| 195 | builder.append(macAddress.toString()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 196 | builder.append(", vlan="); |
| 197 | builder.append(vlan); |
| 198 | builder.append(", switchDPID="); |
| 199 | builder.append(switchDPID); |
| 200 | builder.append(", switchPort="); |
| 201 | builder.append(switchPort); |
| 202 | builder.append(", lastSeenTimestamp="); |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 203 | builder.append(lastSeenTimestamp == null ? "null" : lastSeenTimestamp.getTime()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 204 | builder.append("]"); |
| 205 | return builder.toString(); |
| 206 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 207 | } |