Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 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 | */ |
Jonathan Hart | 9bb32ab | 2015-05-05 18:17:31 -0700 | [diff] [blame] | 16 | package org.onosproject.rest.resources; |
| 17 | |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 18 | import com.fasterxml.jackson.databind.JsonNode; |
Jian Li | 43c956b | 2015-11-26 03:02:46 -0800 | [diff] [blame] | 19 | import com.fasterxml.jackson.databind.ObjectMapper; |
Jonathan Hart | 9bb32ab | 2015-05-05 18:17:31 -0700 | [diff] [blame] | 20 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 21 | import org.onlab.packet.IpAddress; |
| 22 | import org.onlab.packet.MacAddress; |
| 23 | import org.onlab.packet.VlanId; |
| 24 | import org.onosproject.net.ConnectPoint; |
| 25 | import org.onosproject.net.DefaultAnnotations; |
Jonathan Hart | 9bb32ab | 2015-05-05 18:17:31 -0700 | [diff] [blame] | 26 | import org.onosproject.net.Host; |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 27 | import org.onosproject.net.HostId; |
| 28 | import org.onosproject.net.HostLocation; |
| 29 | import org.onosproject.net.SparseAnnotations; |
| 30 | import org.onosproject.net.host.DefaultHostDescription; |
Thomas Vachuska | 58a7c34 | 2016-12-13 01:10:56 -0800 | [diff] [blame] | 31 | import org.onosproject.net.host.HostAdminService; |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 32 | import org.onosproject.net.host.HostProvider; |
| 33 | import org.onosproject.net.host.HostProviderRegistry; |
| 34 | import org.onosproject.net.host.HostProviderService; |
Jonathan Hart | 9bb32ab | 2015-05-05 18:17:31 -0700 | [diff] [blame] | 35 | import org.onosproject.net.host.HostService; |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 36 | import org.onosproject.net.provider.ProviderId; |
Jonathan Hart | 9bb32ab | 2015-05-05 18:17:31 -0700 | [diff] [blame] | 37 | import org.onosproject.rest.AbstractWebResource; |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 38 | |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 39 | import javax.ws.rs.Consumes; |
Thomas Vachuska | 58a7c34 | 2016-12-13 01:10:56 -0800 | [diff] [blame] | 40 | import javax.ws.rs.DELETE; |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 41 | import javax.ws.rs.GET; |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 42 | import javax.ws.rs.POST; |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 43 | import javax.ws.rs.Path; |
| 44 | import javax.ws.rs.PathParam; |
| 45 | import javax.ws.rs.Produces; |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 46 | import javax.ws.rs.core.Context; |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 47 | import javax.ws.rs.core.MediaType; |
| 48 | import javax.ws.rs.core.Response; |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 49 | import javax.ws.rs.core.UriBuilder; |
| 50 | import javax.ws.rs.core.UriInfo; |
| 51 | import java.io.IOException; |
| 52 | import java.io.InputStream; |
| 53 | import java.net.URI; |
| 54 | import java.util.HashSet; |
| 55 | import java.util.Iterator; |
Jian Li | 43c956b | 2015-11-26 03:02:46 -0800 | [diff] [blame] | 56 | import java.util.Map; |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 57 | import java.util.Set; |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 58 | |
Thomas Vachuska | f8cac48 | 2015-04-08 19:40:12 -0700 | [diff] [blame] | 59 | import static org.onlab.util.Tools.nullIsNotFound; |
Ray Milkey | 86ee5e8 | 2018-04-02 15:33:07 -0700 | [diff] [blame] | 60 | import static org.onlab.util.Tools.readTreeFromStream; |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 61 | import static org.onosproject.net.HostId.hostId; |
| 62 | |
| 63 | /** |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 64 | * Manage inventory of end-station hosts. |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 65 | */ |
| 66 | @Path("hosts") |
| 67 | public class HostsWebResource extends AbstractWebResource { |
| 68 | |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 69 | @Context |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 70 | private UriInfo uriInfo; |
| 71 | private static final String HOST_NOT_FOUND = "Host is not found"; |
Charles Chan | cd06c69 | 2017-04-27 20:46:06 -0700 | [diff] [blame] | 72 | private static final String[] REMOVAL_KEYS = {"mac", "vlan", "locations", "ipAddresses"}; |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 73 | |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 74 | /** |
| 75 | * Get all end-station hosts. |
| 76 | * Returns array of all known end-station hosts. |
| 77 | * |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 78 | * @return 200 OK with array of all known end-station hosts. |
Andrea Campanella | 10c4adc | 2015-12-03 15:27:54 -0800 | [diff] [blame] | 79 | * @onos.rsModel Hosts |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 80 | */ |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 81 | @GET |
| 82 | @Produces(MediaType.APPLICATION_JSON) |
| 83 | public Response getHosts() { |
| 84 | final Iterable<Host> hosts = get(HostService.class).getHosts(); |
| 85 | final ObjectNode root = encodeArray(Host.class, "hosts", hosts); |
Ray Milkey | 3f02569 | 2015-01-26 11:15:41 -0800 | [diff] [blame] | 86 | return ok(root).build(); |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 87 | } |
| 88 | |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 89 | /** |
| 90 | * Get details of end-station host. |
| 91 | * Returns detailed properties of the specified end-station host. |
| 92 | * |
| 93 | * @param id host identifier |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 94 | * @return 200 OK with detailed properties of the specified end-station host |
Andrea Campanella | 10c4adc | 2015-12-03 15:27:54 -0800 | [diff] [blame] | 95 | * @onos.rsModel Host |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 96 | */ |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 97 | @GET |
| 98 | @Produces(MediaType.APPLICATION_JSON) |
| 99 | @Path("{id}") |
| 100 | public Response getHostById(@PathParam("id") String id) { |
| 101 | final Host host = nullIsNotFound(get(HostService.class).getHost(hostId(id)), |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 102 | HOST_NOT_FOUND); |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 103 | final ObjectNode root = codec(Host.class).encode(host, this); |
Ray Milkey | 3f02569 | 2015-01-26 11:15:41 -0800 | [diff] [blame] | 104 | return ok(root).build(); |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 105 | } |
| 106 | |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 107 | /** |
| 108 | * Get details of end-station host with MAC/VLAN. |
| 109 | * Returns detailed properties of the specified end-station host. |
| 110 | * |
| 111 | * @param mac host MAC address |
| 112 | * @param vlan host VLAN identifier |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 113 | * @return 200 OK with detailed properties of the specified end-station host |
Andrea Campanella | 10c4adc | 2015-12-03 15:27:54 -0800 | [diff] [blame] | 114 | * @onos.rsModel Host |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 115 | */ |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 116 | @GET |
| 117 | @Produces(MediaType.APPLICATION_JSON) |
| 118 | @Path("{mac}/{vlan}") |
| 119 | public Response getHostByMacAndVlan(@PathParam("mac") String mac, |
| 120 | @PathParam("vlan") String vlan) { |
| 121 | final Host host = nullIsNotFound(get(HostService.class).getHost(hostId(mac + "/" + vlan)), |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 122 | HOST_NOT_FOUND); |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 123 | final ObjectNode root = codec(Host.class).encode(host, this); |
Ray Milkey | 3f02569 | 2015-01-26 11:15:41 -0800 | [diff] [blame] | 124 | return ok(root).build(); |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 125 | } |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 126 | |
| 127 | /** |
| 128 | * Creates a new host based on JSON input and adds it to the current |
| 129 | * host inventory. |
| 130 | * |
| 131 | * @param stream input JSON |
| 132 | * @return status of the request - CREATED if the JSON is correct, |
| 133 | * BAD_REQUEST if the JSON is invalid |
Andrea Campanella | 10c4adc | 2015-12-03 15:27:54 -0800 | [diff] [blame] | 134 | * @onos.rsModel HostPut |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 135 | */ |
| 136 | @POST |
| 137 | @Consumes(MediaType.APPLICATION_JSON) |
| 138 | @Produces(MediaType.APPLICATION_JSON) |
| 139 | public Response createAndAddHost(InputStream stream) { |
| 140 | URI location; |
| 141 | try { |
| 142 | // Parse the input stream |
Ray Milkey | 86ee5e8 | 2018-04-02 15:33:07 -0700 | [diff] [blame] | 143 | ObjectNode root = readTreeFromStream(mapper(), stream); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 144 | |
| 145 | HostProviderRegistry hostProviderRegistry = get(HostProviderRegistry.class); |
Kedar Gupta | 7c4d196 | 2015-08-03 10:46:04 -0700 | [diff] [blame] | 146 | InternalHostProvider hostProvider = new InternalHostProvider(); |
| 147 | HostProviderService hostProviderService = hostProviderRegistry.register(hostProvider); |
| 148 | hostProvider.setHostProviderService(hostProviderService); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 149 | HostId hostId = hostProvider.parseHost(root); |
| 150 | |
| 151 | UriBuilder locationBuilder = uriInfo.getBaseUriBuilder() |
| 152 | .path("hosts") |
| 153 | .path(hostId.mac().toString()) |
| 154 | .path(hostId.vlanId().toString()); |
| 155 | location = locationBuilder.build(); |
Kedar Gupta | 7c4d196 | 2015-08-03 10:46:04 -0700 | [diff] [blame] | 156 | hostProviderRegistry.unregister(hostProvider); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 157 | |
| 158 | } catch (IOException ex) { |
Ray Milkey | 5d915f4 | 2015-08-13 10:27:53 -0700 | [diff] [blame] | 159 | throw new IllegalArgumentException(ex); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 160 | } |
| 161 | return Response |
| 162 | .created(location) |
| 163 | .build(); |
| 164 | } |
| 165 | |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 166 | /** |
Thomas Vachuska | 58a7c34 | 2016-12-13 01:10:56 -0800 | [diff] [blame] | 167 | * Removes infrastructure device. |
| 168 | * Administratively deletes the specified device from the inventory of |
| 169 | * known devices. |
| 170 | * |
| 171 | * @param mac host MAC address |
| 172 | * @param vlan host VLAN identifier |
| 173 | * @return 204 OK |
| 174 | * @onos.rsModel Host |
| 175 | */ |
| 176 | @DELETE |
| 177 | @Path("{mac}/{vlan}") |
| 178 | @Produces(MediaType.APPLICATION_JSON) |
| 179 | public Response removeHost(@PathParam("mac") String mac, |
| 180 | @PathParam("vlan") String vlan) { |
| 181 | get(HostAdminService.class).removeHost(hostId(mac + "/" + vlan)); |
| 182 | return Response.noContent().build(); |
| 183 | } |
| 184 | |
| 185 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 186 | * Internal host provider that provides host events. |
| 187 | */ |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 188 | private final class InternalHostProvider implements HostProvider { |
| 189 | private final ProviderId providerId = |
| 190 | new ProviderId("host", "org.onosproject.rest", true); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 191 | private HostProviderService hostProviderService; |
| 192 | |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 193 | /** |
| 194 | * Prevents from instantiation. |
| 195 | */ |
Ray Milkey | 5d915f4 | 2015-08-13 10:27:53 -0700 | [diff] [blame] | 196 | private InternalHostProvider() { |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 197 | } |
| 198 | |
Ray Milkey | 5d915f4 | 2015-08-13 10:27:53 -0700 | [diff] [blame] | 199 | public void triggerProbe(Host host) { |
| 200 | // Not implemented since there is no need to check for hosts on network |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 201 | } |
| 202 | |
Kedar Gupta | 7c4d196 | 2015-08-03 10:46:04 -0700 | [diff] [blame] | 203 | public void setHostProviderService(HostProviderService service) { |
| 204 | this.hostProviderService = service; |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 205 | } |
| 206 | |
Ray Milkey | 5d915f4 | 2015-08-13 10:27:53 -0700 | [diff] [blame] | 207 | /* |
| 208 | * Return the ProviderId of "this" |
| 209 | */ |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 210 | public ProviderId id() { |
| 211 | return providerId; |
| 212 | } |
| 213 | |
| 214 | /** |
| 215 | * Creates and adds new host based on given data and returns its host ID. |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 216 | * |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 217 | * @param node JsonNode containing host information |
| 218 | * @return host ID of new host created |
| 219 | */ |
| 220 | private HostId parseHost(JsonNode node) { |
| 221 | MacAddress mac = MacAddress.valueOf(node.get("mac").asText()); |
Ray Milkey | 5d915f4 | 2015-08-13 10:27:53 -0700 | [diff] [blame] | 222 | VlanId vlanId = VlanId.vlanId((short) node.get("vlan").asInt(VlanId.UNTAGGED)); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 223 | |
Charles Chan | cd06c69 | 2017-04-27 20:46:06 -0700 | [diff] [blame] | 224 | Iterator<JsonNode> locationNodes = node.get("locations").elements(); |
| 225 | Set<HostLocation> locations = new HashSet<>(); |
| 226 | while (locationNodes.hasNext()) { |
| 227 | JsonNode locationNode = locationNodes.next(); |
| 228 | String deviceAndPort = locationNode.get("elementId").asText() + "/" + |
| 229 | locationNode.get("port").asText(); |
| 230 | HostLocation hostLocation = new HostLocation(ConnectPoint.deviceConnectPoint(deviceAndPort), 0); |
| 231 | locations.add(hostLocation); |
| 232 | } |
| 233 | |
| 234 | Iterator<JsonNode> ipNodes = node.get("ipAddresses").elements(); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 235 | Set<IpAddress> ips = new HashSet<>(); |
Charles Chan | cd06c69 | 2017-04-27 20:46:06 -0700 | [diff] [blame] | 236 | while (ipNodes.hasNext()) { |
| 237 | ips.add(IpAddress.valueOf(ipNodes.next().asText())); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 238 | } |
Jian Li | 43c956b | 2015-11-26 03:02:46 -0800 | [diff] [blame] | 239 | |
| 240 | // try to remove elements from json node after reading them |
| 241 | SparseAnnotations annotations = annotations(removeElements(node, REMOVAL_KEYS)); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 242 | // Update host inventory |
| 243 | |
| 244 | HostId hostId = HostId.hostId(mac, vlanId); |
Charles Chan | cd06c69 | 2017-04-27 20:46:06 -0700 | [diff] [blame] | 245 | DefaultHostDescription desc = new DefaultHostDescription(mac, vlanId, locations, ips, true, annotations); |
Ray Milkey | dc08344 | 2016-02-22 11:27:57 -0800 | [diff] [blame] | 246 | hostProviderService.hostDetected(hostId, desc, false); |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 247 | return hostId; |
| 248 | } |
Kedar Gupta | 7c4d196 | 2015-08-03 10:46:04 -0700 | [diff] [blame] | 249 | |
| 250 | /** |
Jian Li | 43c956b | 2015-11-26 03:02:46 -0800 | [diff] [blame] | 251 | * Remove a set of elements from JsonNode by specifying keys. |
| 252 | * |
| 253 | * @param node JsonNode containing host information |
| 254 | * @param removalKeys key of elements that need to be removed |
| 255 | * @return removal keys |
| 256 | */ |
| 257 | private JsonNode removeElements(JsonNode node, String[] removalKeys) { |
| 258 | ObjectMapper mapper = new ObjectMapper(); |
| 259 | Map<String, Object> map = mapper.convertValue(node, Map.class); |
| 260 | for (String key : removalKeys) { |
| 261 | map.remove(key); |
| 262 | } |
| 263 | return mapper.convertValue(map, JsonNode.class); |
| 264 | } |
| 265 | |
| 266 | /** |
Kedar Gupta | 7c4d196 | 2015-08-03 10:46:04 -0700 | [diff] [blame] | 267 | * Produces annotations from specified JsonNode. Copied from the ConfigProvider |
| 268 | * class for use in the POST method. |
| 269 | * |
| 270 | * @param node node to be annotated |
| 271 | * @return SparseAnnotations object with information about node |
| 272 | */ |
| 273 | private SparseAnnotations annotations(JsonNode node) { |
| 274 | if (node == null) { |
| 275 | return DefaultAnnotations.EMPTY; |
| 276 | } |
| 277 | |
| 278 | DefaultAnnotations.Builder builder = DefaultAnnotations.builder(); |
| 279 | Iterator<String> it = node.fieldNames(); |
| 280 | while (it.hasNext()) { |
| 281 | String k = it.next(); |
| 282 | builder.set(k, node.get(k).asText()); |
| 283 | } |
| 284 | return builder.build(); |
| 285 | } |
| 286 | |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 287 | } |
Ray Milkey | 1f95bd3 | 2014-12-10 11:11:00 -0800 | [diff] [blame] | 288 | } |
| 289 | |