Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 16 | package org.onlab.onos.net.device; |
| 17 | |
| 18 | import org.onlab.onos.event.AbstractEvent; |
| 19 | import org.onlab.onos.net.Device; |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 20 | import org.onlab.onos.net.Port; |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 21 | |
Pavlin Radoslavov | 156c2ff | 2014-10-22 22:00:15 -0700 | [diff] [blame] | 22 | import static com.google.common.base.MoreObjects.toStringHelper; |
| 23 | |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 24 | /** |
| 25 | * Describes infrastructure device event. |
| 26 | */ |
| 27 | public class DeviceEvent extends AbstractEvent<DeviceEvent.Type, Device> { |
| 28 | |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 29 | private final Port port; |
| 30 | |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 31 | /** |
| 32 | * Type of device events. |
| 33 | */ |
| 34 | public enum Type { |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 35 | /** |
| 36 | * Signifies that a new device has been detected. |
| 37 | */ |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 38 | DEVICE_ADDED, |
| 39 | |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 40 | /** |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 41 | * Signifies that some device attributes have changed; excludes |
| 42 | * availability changes. |
| 43 | */ |
| 44 | DEVICE_UPDATED, |
| 45 | |
| 46 | /** |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 47 | * Signifies that a device has been removed. |
| 48 | */ |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 49 | DEVICE_REMOVED, |
| 50 | |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 51 | /** |
| 52 | * Signifies that a device has been administratively suspended. |
| 53 | */ |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 54 | DEVICE_SUSPENDED, |
| 55 | |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 56 | /** |
| 57 | * Signifies that a device has come online or has gone offline. |
| 58 | */ |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 59 | DEVICE_AVAILABILITY_CHANGED, |
| 60 | |
| 61 | /** |
| 62 | * Signifies that the current controller instance relationship has |
| 63 | * changed with respect to a device. |
| 64 | */ |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 65 | DEVICE_MASTERSHIP_CHANGED, |
| 66 | |
| 67 | /** |
| 68 | * Signifies that a port has been added. |
| 69 | */ |
| 70 | PORT_ADDED, |
| 71 | |
| 72 | /** |
| 73 | * Signifies that a port has been updated. |
| 74 | */ |
| 75 | PORT_UPDATED, |
| 76 | |
| 77 | /** |
| 78 | * Signifies that a port has been removed. |
| 79 | */ |
| 80 | PORT_REMOVED |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 81 | } |
| 82 | |
| 83 | /** |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 84 | * Creates an event of a given type and for the specified device and the |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 85 | * current time. |
| 86 | * |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 87 | * @param type device event type |
| 88 | * @param device event device subject |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 89 | */ |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 90 | public DeviceEvent(Type type, Device device) { |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 91 | this(type, device, null); |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * Creates an event of a given type and for the specified device, port |
| 96 | * and the current time. |
| 97 | * |
| 98 | * @param type device event type |
| 99 | * @param device event device subject |
| 100 | * @param port optional port subject |
| 101 | */ |
| 102 | public DeviceEvent(Type type, Device device, Port port) { |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 103 | super(type, device); |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 104 | this.port = port; |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | /** |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 108 | * Creates an event of a given type and for the specified device and time. |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 109 | * |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 110 | * @param type device event type |
| 111 | * @param device event device subject |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 112 | * @param port optional port subject |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 113 | * @param time occurrence time |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 114 | */ |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 115 | public DeviceEvent(Type type, Device device, Port port, long time) { |
tom | 64b7aac | 2014-08-26 00:18:21 -0700 | [diff] [blame] | 116 | super(type, device, time); |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 117 | this.port = port; |
| 118 | } |
| 119 | |
| 120 | /** |
| 121 | * Returns the port subject. |
| 122 | * |
| 123 | * @return port subject or null if the event is not port specific. |
| 124 | */ |
tom | 0efbb1d | 2014-09-09 11:54:28 -0700 | [diff] [blame] | 125 | public Port port() { |
tom | 29df6f4 | 2014-09-05 08:14:14 -0700 | [diff] [blame] | 126 | return port; |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 127 | } |
| 128 | |
Pavlin Radoslavov | 156c2ff | 2014-10-22 22:00:15 -0700 | [diff] [blame] | 129 | @Override |
| 130 | public String toString() { |
| 131 | if (port == null) { |
| 132 | return super.toString(); |
| 133 | } |
| 134 | return toStringHelper(this).add("time", time()).add("type", type()) |
| 135 | .add("subject", subject()).add("port", port).toString(); |
| 136 | } |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 137 | } |