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 | /** |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 51 | * The VLAN tag on this entity, or null if untagged. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 52 | */ |
| 53 | private Short vlan; |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 54 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 55 | /** |
| 56 | * The DPID of the switch for the ingress point for this entity, |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 57 | * or null if not present. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 58 | */ |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 59 | private Long switchDPID; |
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 port number 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 switchPort; |
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 | /** |
Ray Milkey | b41100a | 2014-04-10 10:42:15 -0700 | [diff] [blame] | 68 | * The last time we observed this entity on the network. |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 69 | */ |
| 70 | private Date lastSeenTimestamp; |
| 71 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 72 | private int hashCode = 0; |
| 73 | |
| 74 | // ************ |
| 75 | // Constructors |
| 76 | // ************ |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 77 | protected Host() { |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 78 | } |
| 79 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 80 | /** |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 81 | * Create a new host and its information. |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 82 | * |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 83 | * @param macAddress mac address of this host |
| 84 | * @param vlan vlan ID of this host |
| 85 | * @param switchDPID switch DPID where the host is attached |
| 86 | * @param switchPort port number where the host is attached |
| 87 | * @param lastSeenTimestamp last packet-in time of this host |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 88 | */ |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 89 | public Host(MACAddress macAddress, Short vlan, Long switchDPID, |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 90 | Long switchPort, Date lastSeenTimestamp) { |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 91 | this.macAddress = macAddress; |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 92 | this.vlan = vlan; |
| 93 | this.switchDPID = switchDPID; |
| 94 | this.switchPort = switchPort; |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 95 | if (lastSeenTimestamp != null) { |
| 96 | this.lastSeenTimestamp = new Date(lastSeenTimestamp.getTime()); |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 97 | } else { |
| 98 | this.lastSeenTimestamp = null; |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 99 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | // *************** |
| 103 | // Getters/Setters |
| 104 | // *************** |
| 105 | |
| 106 | public MACAddress getMacAddress() { |
| 107 | return macAddress; |
| 108 | } |
| 109 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 110 | public Short getVlan() { |
| 111 | return vlan; |
| 112 | } |
| 113 | |
| 114 | public Long getSwitchDPID() { |
| 115 | return switchDPID; |
| 116 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 117 | |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 118 | public Long getSwitchPort() { |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 119 | return switchPort; |
| 120 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 121 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 122 | public Date getLastSeenTimestamp() { |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 123 | if (this.lastSeenTimestamp == null) { |
| 124 | return null; |
| 125 | } |
| 126 | return new Date(this.lastSeenTimestamp.getTime()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 127 | } |
| 128 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 129 | public void setLastSeenTimestamp(Date lastSeenTimestamp) { |
Pavlin Radoslavov | 0a9d5c3 | 2014-04-15 17:45:23 -0700 | [diff] [blame] | 130 | this.lastSeenTimestamp = new Date(lastSeenTimestamp.getTime()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 131 | } |
| 132 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 133 | @Override |
| 134 | public int hashCode() { |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 135 | final int prime = 31; |
| 136 | hashCode = 1; |
TeruU | 80ce506 | 2014-03-03 17:16:13 -0800 | [diff] [blame] | 137 | hashCode = prime * hashCode + (int) (macAddress.toLong() ^ (macAddress.toLong() >>> 32)); |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 138 | hashCode = prime * hashCode + ((switchDPID == null) ? 0 : switchDPID.hashCode()); |
| 139 | hashCode = prime * hashCode + ((switchPort == null) ? 0 : switchPort.hashCode()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 140 | hashCode = prime * hashCode + ((vlan == null) ? 0 : vlan.hashCode()); |
| 141 | return hashCode; |
| 142 | } |
| 143 | |
| 144 | @Override |
| 145 | public boolean equals(Object obj) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 146 | if (this == obj) { |
| 147 | return true; |
| 148 | } |
| 149 | if (obj == null) { |
| 150 | return false; |
| 151 | } |
| 152 | if (getClass() != obj.getClass()) { |
| 153 | return false; |
| 154 | } |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 155 | Host other = (Host) obj; |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 156 | if (hashCode() != other.hashCode()) { |
| 157 | return false; |
| 158 | } |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 159 | if (!Objects.equals(macAddress, other.macAddress)) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 160 | return false; |
| 161 | } |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 162 | if (!Objects.equals(switchDPID, other.switchDPID)) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 163 | return false; |
| 164 | } |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 165 | if (!Objects.equals(switchPort, other.switchPort)) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 166 | return false; |
| 167 | } |
TeruU | 5d2c939 | 2014-06-09 20:02:02 -0700 | [diff] [blame] | 168 | if (!Objects.equals(vlan, other.vlan)) { |
Ray Milkey | b29e626 | 2014-04-09 16:02:14 -0700 | [diff] [blame] | 169 | return false; |
| 170 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 171 | return true; |
| 172 | } |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 173 | |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 174 | @Override |
| 175 | public String toString() { |
| 176 | StringBuilder builder = new StringBuilder(); |
Jonathan Hart | 0310213 | 2014-07-01 23:22:04 -0700 | [diff] [blame] | 177 | builder.append("Host [macAddress="); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 178 | builder.append(macAddress.toString()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 179 | builder.append(", vlan="); |
| 180 | builder.append(vlan); |
| 181 | builder.append(", switchDPID="); |
| 182 | builder.append(switchDPID); |
| 183 | builder.append(", switchPort="); |
| 184 | builder.append(switchPort); |
| 185 | builder.append(", lastSeenTimestamp="); |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 186 | builder.append(lastSeenTimestamp == null ? "null" : lastSeenTimestamp.getTime()); |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 187 | builder.append("]"); |
| 188 | return builder.toString(); |
| 189 | } |
Jonathan Hart | d857ad6 | 2013-12-14 18:08:17 -0800 | [diff] [blame] | 190 | } |