Thomas Vachuska | 96d55b1 | 2015-05-11 08:52:03 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
Thomas Vachuska | 96d55b1 | 2015-05-11 08:52:03 -0700 | [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 | */ |
Thomas Vachuska | 4998caa | 2015-08-26 13:28:38 -0700 | [diff] [blame] | 16 | package org.onosproject.net.config.basics; |
Thomas Vachuska | 96d55b1 | 2015-05-11 08:52:03 -0700 | [diff] [blame] | 17 | |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 18 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 19 | import org.onlab.packet.IpAddress; |
| 20 | import org.onosproject.net.ConnectPoint; |
Thomas Vachuska | 96d55b1 | 2015-05-11 08:52:03 -0700 | [diff] [blame] | 21 | import org.onosproject.net.HostId; |
Charles Chan | 61fc0d8 | 2017-04-28 14:13:36 -0700 | [diff] [blame] | 22 | import org.onosproject.net.HostLocation; |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 23 | |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 24 | import java.util.HashSet; |
| 25 | import java.util.Set; |
Thomas Vachuska | 96d55b1 | 2015-05-11 08:52:03 -0700 | [diff] [blame] | 26 | |
| 27 | /** |
| 28 | * Basic configuration for network end-station hosts. |
| 29 | */ |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 30 | public final class BasicHostConfig extends BasicElementConfig<HostId> { |
| 31 | |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 32 | private static final String IPS = "ips"; |
Charles Chan | 61fc0d8 | 2017-04-28 14:13:36 -0700 | [diff] [blame] | 33 | private static final String LOCATIONS = "locations"; |
Simon Hunt | 10618f6 | 2017-06-15 19:30:52 -0700 | [diff] [blame^] | 34 | private static final String DASH = "-"; |
Thomas Vachuska | 96d55b1 | 2015-05-11 08:52:03 -0700 | [diff] [blame] | 35 | |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 36 | @Override |
| 37 | public boolean isValid() { |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 38 | // Location and IP addresses can be absent, but if present must be valid. |
Charles Chan | 61fc0d8 | 2017-04-28 14:13:36 -0700 | [diff] [blame] | 39 | this.locations(); |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 40 | this.ipAddresses(); |
Simon Hunt | bc30e68 | 2017-02-15 18:39:23 -0800 | [diff] [blame] | 41 | return hasOnlyFields(ALLOWED, NAME, LOC_TYPE, LATITUDE, LONGITUDE, |
Charles Chan | 61fc0d8 | 2017-04-28 14:13:36 -0700 | [diff] [blame] | 42 | GRID_Y, GRID_Y, UI_TYPE, RACK_ADDRESS, OWNER, IPS, LOCATIONS); |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 43 | } |
Thomas Vachuska | 96d55b1 | 2015-05-11 08:52:03 -0700 | [diff] [blame] | 44 | |
Simon Hunt | 10618f6 | 2017-06-15 19:30:52 -0700 | [diff] [blame^] | 45 | @Override |
| 46 | public String name() { |
| 47 | // NOTE: |
| 48 | // We don't want to default to host ID if friendly name is not set; |
| 49 | // (it isn't particularly friendly, e.g. "00:00:00:00:00:01/None"). |
| 50 | // We'd prefer to clear the annotation, but if we pass null, then the |
| 51 | // value won't get set (see BasicElementOperator). So, instead we will |
| 52 | // return a DASH to signify "use the default friendly name". |
| 53 | return get(NAME, DASH); |
| 54 | } |
| 55 | |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 56 | /** |
Simon Hunt | 1e20dae | 2016-10-28 11:26:26 -0700 | [diff] [blame] | 57 | * Returns the location of the host. |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 58 | * |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 59 | * @return location of the host or null if not set |
| 60 | * @throws IllegalArgumentException if not specified with correct format |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 61 | */ |
Charles Chan | 61fc0d8 | 2017-04-28 14:13:36 -0700 | [diff] [blame] | 62 | public Set<HostLocation> locations() { |
| 63 | HashSet<HostLocation> locations = new HashSet<>(); |
| 64 | if (object.has(LOCATIONS)) { |
| 65 | ArrayNode locationNodes = (ArrayNode) object.path(LOCATIONS); |
| 66 | locationNodes.forEach(n -> { |
| 67 | ConnectPoint cp = ConnectPoint.deviceConnectPoint((n.asText())); |
| 68 | locations.add(new HostLocation(cp, 0)); |
| 69 | }); |
| 70 | return locations; |
| 71 | } |
| 72 | return null; |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Sets the location of the host. |
| 77 | * |
Charles Chan | 61fc0d8 | 2017-04-28 14:13:36 -0700 | [diff] [blame] | 78 | * @param locations location of the host or null to unset |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 79 | * @return the config of the host |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 80 | */ |
Charles Chan | 61fc0d8 | 2017-04-28 14:13:36 -0700 | [diff] [blame] | 81 | public BasicHostConfig setLocations(Set<HostLocation> locations) { |
| 82 | return (BasicHostConfig) setOrClear(LOCATIONS, locations); |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 83 | } |
| 84 | |
| 85 | /** |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 86 | * Returns IP addresses of the host. |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 87 | * |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 88 | * @return IP addresses of the host or null if not set |
| 89 | * @throws IllegalArgumentException if not specified with correct format |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 90 | */ |
| 91 | public Set<IpAddress> ipAddresses() { |
| 92 | HashSet<IpAddress> ipAddresses = new HashSet<>(); |
| 93 | if (object.has(IPS)) { |
| 94 | ArrayNode ipNodes = (ArrayNode) object.path(IPS); |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 95 | ipNodes.forEach(n -> ipAddresses.add(IpAddress.valueOf(n.asText()))); |
| 96 | return ipAddresses; |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 97 | } |
| 98 | return null; |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * Sets the IP addresses of the host. |
| 103 | * |
Thomas Vachuska | 3600846 | 2016-01-07 15:38:20 -0800 | [diff] [blame] | 104 | * @param ipAddresses IP addresses of the host or null to unset |
| 105 | * @return the config of the host |
Charles Chan | d6d581a | 2015-11-18 16:51:08 -0800 | [diff] [blame] | 106 | */ |
| 107 | public BasicHostConfig setIps(Set<IpAddress> ipAddresses) { |
| 108 | return (BasicHostConfig) setOrClear(IPS, ipAddresses); |
| 109 | } |
Thomas Vachuska | 96d55b1 | 2015-05-11 08:52:03 -0700 | [diff] [blame] | 110 | } |