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 | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 18 | package net.onrc.onos.core.hostmanager; |
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; |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 22 | import java.util.Objects; |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 23 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 24 | import net.floodlightcontroller.util.MACAddress; |
| 25 | |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 26 | |
| 27 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 28 | /** |
| 29 | * An entity on the network is a visible trace of a device that corresponds |
| 30 | * to a packet received from a particular interface on the edge of a network, |
| 31 | * with a particular VLAN tag, and a particular MAC address, along with any |
| 32 | * other packet characteristics we might want to consider as helpful for |
| 33 | * disambiguating devices. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 34 | * <p/> |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 35 | * Entities are the most basic element of devices; devices consist of one or |
| 36 | * more entities. Entities are immutable once created, except for the last |
| 37 | * seen timestamp. |
Yuta HIGUCHI | aa132f5 | 2014-06-26 10:18:39 -0700 | [diff] [blame] | 38 | * <!-- CHECKSTYLE IGNORE WriteTag FOR NEXT 1 LINES --> |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 39 | * @author readams |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 40 | */ |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 41 | public class Host implements Serializable { |
Jonathan Hart | 96892d1 | 2014-03-26 20:21:29 -0700 | [diff] [blame] | 42 | |
Jonathan Hart | ac15d93 | 2014-06-01 22:59:35 -0700 | [diff] [blame] | 43 | private static final long serialVersionUID = 1L; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 44 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 45 | /** |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 46 | * The MAC address associated with this entity. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 47 | */ |
| 48 | private MACAddress macAddress; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 49 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 50 | /** |
Sangho Shin | 2f26369 | 2014-09-15 14:09:41 -0700 | [diff] [blame] | 51 | * The IP address associated with this entity. |
| 52 | */ |
| 53 | private int ipAddress; |
| 54 | |
| 55 | |
| 56 | /** |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 57 | * The VLAN tag on this entity, or null if untagged. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 58 | */ |
| 59 | private Short vlan; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 60 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 61 | /** |
| 62 | * The DPID of the switch for the ingress point for this entity, |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 63 | * or null if not present. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 64 | */ |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 65 | private Long switchDPID; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 66 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 67 | /** |
| 68 | * 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] | 69 | * or null if not present. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 70 | */ |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 71 | private Long switchPort; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 72 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 73 | /** |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 74 | * The last time we observed this entity on the network. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 75 | */ |
| 76 | private Date lastSeenTimestamp; |
| 77 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 78 | private int hashCode = 0; |
| 79 | |
| 80 | // ************ |
| 81 | // Constructors |
| 82 | // ************ |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 83 | protected Host() { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 84 | } |
| 85 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 86 | /** |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 87 | * Create a new host and its information. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 88 | * |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 89 | * @param macAddress mac address of this host |
Sangho Shin | 2f26369 | 2014-09-15 14:09:41 -0700 | [diff] [blame] | 90 | * @param ipAddress ip address of this host (if any) |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 91 | * @param vlan vlan ID of this host |
| 92 | * @param switchDPID switch DPID where the host is attached |
| 93 | * @param switchPort port number where the host is attached |
| 94 | * @param lastSeenTimestamp last packet-in time of this host |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 95 | */ |
Sangho Shin | 2f26369 | 2014-09-15 14:09:41 -0700 | [diff] [blame] | 96 | public Host(MACAddress macAddress, int ipAddress, Short vlan, Long switchDPID, |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 97 | Long switchPort, Date lastSeenTimestamp) { |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 98 | this.macAddress = macAddress; |
Sangho Shin | 2f26369 | 2014-09-15 14:09:41 -0700 | [diff] [blame] | 99 | this.ipAddress = ipAddress; |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 100 | this.vlan = vlan; |
| 101 | this.switchDPID = switchDPID; |
| 102 | this.switchPort = switchPort; |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 103 | if (lastSeenTimestamp != null) { |
| 104 | this.lastSeenTimestamp = new Date(lastSeenTimestamp.getTime()); |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 105 | } else { |
| 106 | this.lastSeenTimestamp = null; |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 107 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 108 | } |
| 109 | |
| 110 | // *************** |
| 111 | // Getters/Setters |
| 112 | // *************** |
| 113 | |
| 114 | public MACAddress getMacAddress() { |
| 115 | return macAddress; |
| 116 | } |
| 117 | |
Sangho Shin | 2f26369 | 2014-09-15 14:09:41 -0700 | [diff] [blame] | 118 | public int getIpAddress() { |
| 119 | return ipAddress; |
| 120 | } |
| 121 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 122 | public Short getVlan() { |
| 123 | return vlan; |
| 124 | } |
| 125 | |
| 126 | public Long getSwitchDPID() { |
| 127 | return switchDPID; |
| 128 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 129 | |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 130 | public Long getSwitchPort() { |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 131 | return switchPort; |
| 132 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 133 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 134 | public Date getLastSeenTimestamp() { |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 135 | if (this.lastSeenTimestamp == null) { |
| 136 | return null; |
| 137 | } |
| 138 | return new Date(this.lastSeenTimestamp.getTime()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 139 | } |
| 140 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 141 | public void setLastSeenTimestamp(Date lastSeenTimestamp) { |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 142 | this.lastSeenTimestamp = new Date(lastSeenTimestamp.getTime()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 143 | } |
| 144 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 145 | @Override |
| 146 | public int hashCode() { |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 147 | final int prime = 31; |
| 148 | hashCode = 1; |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 149 | hashCode = prime * hashCode + (int) (macAddress.toLong() ^ (macAddress.toLong() >>> 32)); |
Sangho Shin | 2f26369 | 2014-09-15 14:09:41 -0700 | [diff] [blame] | 150 | hashCode = prime * hashCode + ipAddress; |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 151 | hashCode = prime * hashCode + ((switchDPID == null) ? 0 : switchDPID.hashCode()); |
| 152 | hashCode = prime * hashCode + ((switchPort == null) ? 0 : switchPort.hashCode()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 153 | hashCode = prime * hashCode + ((vlan == null) ? 0 : vlan.hashCode()); |
| 154 | return hashCode; |
| 155 | } |
| 156 | |
| 157 | @Override |
| 158 | public boolean equals(Object obj) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 159 | if (this == obj) { |
| 160 | return true; |
| 161 | } |
| 162 | if (obj == null) { |
| 163 | return false; |
| 164 | } |
| 165 | if (getClass() != obj.getClass()) { |
| 166 | return false; |
| 167 | } |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 168 | Host other = (Host) obj; |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 169 | if (hashCode() != other.hashCode()) { |
| 170 | return false; |
| 171 | } |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 172 | if (!Objects.equals(macAddress, other.macAddress)) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 173 | return false; |
| 174 | } |
Sangho Shin | 2f26369 | 2014-09-15 14:09:41 -0700 | [diff] [blame] | 175 | if (!Objects.equals(ipAddress, other.ipAddress)) { |
| 176 | return false; |
| 177 | } |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 178 | if (!Objects.equals(switchDPID, other.switchDPID)) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 179 | return false; |
| 180 | } |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 181 | if (!Objects.equals(switchPort, other.switchPort)) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 182 | return false; |
| 183 | } |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 184 | if (!Objects.equals(vlan, other.vlan)) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 185 | return false; |
| 186 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 187 | return true; |
| 188 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 189 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 190 | @Override |
| 191 | public String toString() { |
| 192 | StringBuilder builder = new StringBuilder(); |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 193 | builder.append("Host [macAddress="); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 194 | builder.append(macAddress.toString()); |
Sangho Shin | 2f26369 | 2014-09-15 14:09:41 -0700 | [diff] [blame] | 195 | builder.append(", ipAddressn="); |
| 196 | builder.append(ipAddress); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 197 | builder.append(", vlan="); |
| 198 | builder.append(vlan); |
| 199 | builder.append(", switchDPID="); |
| 200 | builder.append(switchDPID); |
| 201 | builder.append(", switchPort="); |
| 202 | builder.append(switchPort); |
| 203 | builder.append(", lastSeenTimestamp="); |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 204 | builder.append(lastSeenTimestamp == null ? "null" : lastSeenTimestamp.getTime()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 205 | builder.append("]"); |
| 206 | return builder.toString(); |
| 207 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 208 | } |