Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2021-present Open Networking Foundation |
| 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 | */ |
| 16 | package org.onosproject.kubevirtnetworking.api; |
| 17 | |
| 18 | import com.google.common.base.MoreObjects; |
| 19 | import com.google.common.collect.ImmutableMap; |
| 20 | import com.google.common.collect.ImmutableSet; |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 21 | import org.onlab.packet.MacAddress; |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 22 | |
| 23 | import java.util.HashMap; |
| 24 | import java.util.HashSet; |
| 25 | import java.util.Map; |
| 26 | import java.util.Objects; |
| 27 | import java.util.Set; |
| 28 | |
| 29 | import static com.google.common.base.Preconditions.checkArgument; |
| 30 | |
| 31 | /** |
| 32 | * Default implementation class of kubevirt router. |
| 33 | */ |
| 34 | public final class DefaultKubevirtRouter implements KubevirtRouter { |
| 35 | |
| 36 | private static final String NOT_NULL_MSG = "Router % cannot be null"; |
| 37 | |
| 38 | private final String name; |
| 39 | private final String description; |
| 40 | private final boolean enableSnat; |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 41 | private final MacAddress mac; |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 42 | private final Set<String> internal; |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame] | 43 | private final Map<String, String> external; |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 44 | private final KubevirtPeerRouter peerRouter; |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 45 | private final String gateway; |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 46 | |
| 47 | /** |
| 48 | * A default constructor. |
| 49 | * |
| 50 | * @param name router name |
| 51 | * @param description router description |
| 52 | * @param enableSnat snat use indicator |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 53 | * @param mac MAC address |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 54 | * @param internal internal networks |
| 55 | * @param external external network |
| 56 | * @param peerRouter external peer router |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 57 | * @param gateway elected gateway node id |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 58 | */ |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 59 | public DefaultKubevirtRouter(String name, String description, |
| 60 | boolean enableSnat, MacAddress mac, |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 61 | Set<String> internal, |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame] | 62 | Map<String, String> external, |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 63 | KubevirtPeerRouter peerRouter, |
| 64 | String gateway) { |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 65 | this.name = name; |
| 66 | this.description = description; |
| 67 | this.enableSnat = enableSnat; |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 68 | this.mac = mac; |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 69 | this.internal = internal; |
| 70 | this.external = external; |
| 71 | this.peerRouter = peerRouter; |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 72 | this.gateway = gateway; |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 73 | } |
| 74 | |
| 75 | @Override |
| 76 | public String name() { |
| 77 | return name; |
| 78 | } |
| 79 | |
| 80 | @Override |
| 81 | public String description() { |
| 82 | return description; |
| 83 | } |
| 84 | |
| 85 | @Override |
| 86 | public boolean enableSnat() { |
| 87 | return enableSnat; |
| 88 | } |
| 89 | |
| 90 | @Override |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 91 | public MacAddress mac() { |
| 92 | return mac; |
| 93 | } |
| 94 | |
| 95 | @Override |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 96 | public Set<String> internal() { |
Jian Li | b636f70 | 2021-03-03 14:46:50 +0900 | [diff] [blame] | 97 | if (internal == null) { |
| 98 | return ImmutableSet.of(); |
| 99 | } else { |
| 100 | return ImmutableSet.copyOf(internal); |
| 101 | } |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | @Override |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame] | 105 | public Map<String, String> external() { |
Jian Li | b636f70 | 2021-03-03 14:46:50 +0900 | [diff] [blame] | 106 | if (external == null) { |
| 107 | return ImmutableMap.of(); |
| 108 | } else { |
| 109 | return ImmutableMap.copyOf(external); |
| 110 | } |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | @Override |
| 114 | public KubevirtPeerRouter peerRouter() { |
| 115 | return peerRouter; |
| 116 | } |
| 117 | |
| 118 | @Override |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 119 | public String electedGateway() { |
| 120 | return gateway; |
| 121 | } |
| 122 | |
| 123 | @Override |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame] | 124 | public KubevirtRouter updatePeerRouter(KubevirtPeerRouter updated) { |
| 125 | return DefaultKubevirtRouter.builder() |
| 126 | .name(name) |
| 127 | .enableSnat(enableSnat) |
| 128 | .description(description) |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 129 | .mac(mac) |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame] | 130 | .internal(internal) |
| 131 | .external(external) |
| 132 | .peerRouter(updated) |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 133 | .electedGateway(gateway) |
| 134 | .build(); |
| 135 | } |
| 136 | |
| 137 | @Override |
| 138 | public KubevirtRouter updatedElectedGateway(String updated) { |
| 139 | return DefaultKubevirtRouter.builder() |
| 140 | .name(name) |
| 141 | .enableSnat(enableSnat) |
| 142 | .description(description) |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 143 | .mac(mac) |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 144 | .internal(internal) |
| 145 | .external(external) |
| 146 | .peerRouter(peerRouter) |
| 147 | .electedGateway(updated) |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame] | 148 | .build(); |
| 149 | } |
| 150 | |
| 151 | @Override |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 152 | public boolean equals(Object o) { |
| 153 | if (this == o) { |
| 154 | return true; |
| 155 | } |
| 156 | if (o == null || getClass() != o.getClass()) { |
| 157 | return false; |
| 158 | } |
| 159 | DefaultKubevirtRouter that = (DefaultKubevirtRouter) o; |
| 160 | return enableSnat == that.enableSnat && name.equals(that.name) && |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 161 | description.equals(that.description) && mac.equals(that.mac) && |
| 162 | internal.equals(that.internal) && external.equals(that.external) && |
| 163 | peerRouter.equals(that.peerRouter) && gateway.equals(that.electedGateway()); |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 164 | } |
| 165 | |
| 166 | @Override |
| 167 | public int hashCode() { |
Daniel Park | a5ba88d | 2021-05-28 15:46:46 +0900 | [diff] [blame^] | 168 | return Objects.hash(name, description, mac); |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | @Override |
| 172 | public String toString() { |
| 173 | return MoreObjects.toStringHelper(this) |
| 174 | .add("name", name) |
| 175 | .add("description", description) |
| 176 | .add("enableSnat", enableSnat) |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 177 | .add("mac", mac) |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 178 | .add("internal", internal) |
| 179 | .add("external", external) |
| 180 | .add("peerRouter", peerRouter) |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 181 | .add("electedGateway", gateway) |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 182 | .toString(); |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * Returns new builder instance. |
| 187 | * |
| 188 | * @return kubevirt router builder |
| 189 | */ |
| 190 | public static Builder builder() { |
| 191 | return new Builder(); |
| 192 | } |
| 193 | |
| 194 | public static final class Builder implements KubevirtRouter.Builder { |
| 195 | |
| 196 | private String name; |
| 197 | private String description; |
| 198 | private boolean enableSnat; |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 199 | private MacAddress mac; |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 200 | private Set<String> internal; |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame] | 201 | private Map<String, String> external; |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 202 | private KubevirtPeerRouter peerRouter; |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 203 | private String gateway; |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 204 | |
| 205 | @Override |
| 206 | public KubevirtRouter build() { |
| 207 | checkArgument(name != null, NOT_NULL_MSG, "name"); |
| 208 | |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 209 | return new DefaultKubevirtRouter(name, description, enableSnat, mac, |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 210 | internal, external, peerRouter, gateway); |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 211 | } |
| 212 | |
| 213 | @Override |
| 214 | public Builder name(String name) { |
| 215 | this.name = name; |
| 216 | return this; |
| 217 | } |
| 218 | |
| 219 | @Override |
| 220 | public Builder description(String description) { |
| 221 | this.description = description; |
| 222 | return this; |
| 223 | } |
| 224 | |
| 225 | @Override |
| 226 | public Builder enableSnat(boolean flag) { |
| 227 | this.enableSnat = flag; |
| 228 | return this; |
| 229 | } |
| 230 | |
| 231 | @Override |
Jian Li | 9756cec | 2021-03-16 16:06:33 +0900 | [diff] [blame] | 232 | public Builder mac(MacAddress mac) { |
| 233 | this.mac = mac; |
| 234 | return this; |
| 235 | } |
| 236 | |
| 237 | @Override |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 238 | public Builder internal(Set<String> internal) { |
| 239 | this.internal = Objects.requireNonNullElseGet(internal, HashSet::new); |
| 240 | return this; |
| 241 | } |
| 242 | |
| 243 | @Override |
Jian Li | 810f58c | 2021-02-27 01:10:50 +0900 | [diff] [blame] | 244 | public Builder external(Map<String, String> external) { |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 245 | this.external = Objects.requireNonNullElseGet(external, HashMap::new); |
| 246 | return this; |
| 247 | } |
| 248 | |
| 249 | @Override |
| 250 | public Builder peerRouter(KubevirtPeerRouter router) { |
| 251 | this.peerRouter = router; |
| 252 | return this; |
| 253 | } |
Daniel Park | 2884b23 | 2021-03-04 18:58:47 +0900 | [diff] [blame] | 254 | |
| 255 | @Override |
| 256 | public Builder electedGateway(String gateway) { |
| 257 | this.gateway = gateway; |
| 258 | return this; |
| 259 | } |
Jian Li | caa0392 | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 260 | } |
| 261 | } |