Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-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.openstackvtap.impl; |
| 17 | |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableSet; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 19 | import org.onosproject.net.AbstractDescription; |
| 20 | import org.onosproject.net.DefaultAnnotations; |
| 21 | import org.onosproject.net.DeviceId; |
| 22 | import org.onosproject.net.SparseAnnotations; |
| 23 | import org.onosproject.openstackvtap.api.OpenstackVtap; |
| 24 | import org.onosproject.openstackvtap.api.OpenstackVtapCriterion; |
| 25 | import org.onosproject.openstackvtap.api.OpenstackVtapId; |
| 26 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 27 | import java.util.Objects; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 28 | import java.util.Set; |
| 29 | |
| 30 | import static com.google.common.base.MoreObjects.toStringHelper; |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 31 | import static com.google.common.base.Preconditions.checkNotNull; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 32 | |
| 33 | /** |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 34 | * Default implementation of an immutable OpenstackVtap. |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 35 | */ |
| 36 | public final class DefaultOpenstackVtap extends AbstractDescription implements OpenstackVtap { |
| 37 | |
| 38 | private final OpenstackVtapId id; |
| 39 | private final Type type; |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 40 | private final OpenstackVtapCriterion vtapCriterion; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 41 | private final Set<DeviceId> txDeviceIds; |
| 42 | private final Set<DeviceId> rxDeviceIds; |
| 43 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 44 | /** |
| 45 | * Creates an DefaultOpenstackVtap using the supplied information. |
| 46 | * |
| 47 | * @param id vtap identifier |
| 48 | * @param type type of vtap (all,rx,tx) |
| 49 | * @param vtapCriterion criterion of vtap |
| 50 | * @param txDeviceIds device identifiers applied by vtap tx |
| 51 | * @param rxDeviceIds device identifiers applied by vtap rx |
| 52 | * @param annotations optional key/value annotations |
| 53 | */ |
| 54 | private DefaultOpenstackVtap(OpenstackVtapId id, |
| 55 | Type type, |
| 56 | OpenstackVtapCriterion vtapCriterion, |
| 57 | Set<DeviceId> txDeviceIds, |
| 58 | Set<DeviceId> rxDeviceIds, |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 59 | SparseAnnotations... annotations) { |
| 60 | super(annotations); |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 61 | this.id = checkNotNull(id); |
| 62 | this.type = checkNotNull(type); |
| 63 | this.vtapCriterion = checkNotNull(vtapCriterion); |
| 64 | this.txDeviceIds = Objects.nonNull(txDeviceIds) ? |
| 65 | ImmutableSet.copyOf(txDeviceIds) : ImmutableSet.of(); |
| 66 | this.rxDeviceIds = Objects.nonNull(rxDeviceIds) ? |
| 67 | ImmutableSet.copyOf(rxDeviceIds) : ImmutableSet.of(); |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 68 | } |
| 69 | |
| 70 | @Override |
| 71 | public OpenstackVtapId id() { |
| 72 | return id; |
| 73 | } |
| 74 | |
| 75 | @Override |
| 76 | public Type type() { |
| 77 | return type; |
| 78 | } |
| 79 | |
| 80 | @Override |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 81 | public OpenstackVtapCriterion vtapCriterion() { |
| 82 | return vtapCriterion; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 83 | } |
| 84 | |
| 85 | @Override |
| 86 | public Set<DeviceId> txDeviceIds() { |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 87 | return txDeviceIds; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 88 | } |
| 89 | |
| 90 | @Override |
| 91 | public Set<DeviceId> rxDeviceIds() { |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 92 | return rxDeviceIds; |
| 93 | } |
| 94 | |
| 95 | @Override |
| 96 | public int hashCode() { |
| 97 | return Objects.hash(id, type, vtapCriterion, txDeviceIds, rxDeviceIds); |
| 98 | } |
| 99 | |
| 100 | @Override |
| 101 | public boolean equals(Object obj) { |
| 102 | if (this == obj) { |
| 103 | return true; |
| 104 | } |
| 105 | if (obj instanceof DefaultOpenstackVtap) { |
| 106 | final DefaultOpenstackVtap other = (DefaultOpenstackVtap) obj; |
| 107 | return Objects.equals(this.id, other.id) && |
| 108 | Objects.equals(this.type, other.type) && |
| 109 | Objects.equals(this.vtapCriterion, other.vtapCriterion) && |
| 110 | Objects.equals(this.txDeviceIds(), other.txDeviceIds()) && |
| 111 | Objects.equals(this.rxDeviceIds(), other.rxDeviceIds()) && |
| 112 | Objects.equals(this.annotations(), other.annotations()); |
| 113 | } |
| 114 | return false; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | @Override |
| 118 | public String toString() { |
| 119 | return toStringHelper(this) |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 120 | .add("id", id()) |
| 121 | .add("type", type()) |
| 122 | .add("vtapCriterion", vtapCriterion()) |
| 123 | .add("txDeviceIds", txDeviceIds()) |
| 124 | .add("rxDeviceIds", rxDeviceIds()) |
| 125 | .add("annotations", annotations()) |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 126 | .toString(); |
| 127 | } |
| 128 | |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 129 | /** |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 130 | * Creates OpenstackVtap builder with default parameters. |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 131 | * |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 132 | * @return builder |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 133 | */ |
| 134 | public static Builder builder() { |
| 135 | return new Builder(); |
| 136 | } |
| 137 | |
| 138 | /** |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 139 | * Creates OpenstackVtap builder inheriting with default parameters, |
| 140 | * from specified OpenstackVtap. |
| 141 | * |
| 142 | * @param vtap to inherit default from |
| 143 | * @return builder |
| 144 | */ |
| 145 | public static Builder builder(OpenstackVtap vtap) { |
| 146 | return new Builder(vtap); |
| 147 | } |
| 148 | |
| 149 | /** |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 150 | * Builder for DefaultOpenstackVtap object. |
| 151 | */ |
| 152 | public static class Builder implements OpenstackVtap.Builder { |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 153 | private OpenstackVtapId id; |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 154 | private Type type = Type.VTAP_ALL; |
| 155 | private OpenstackVtapCriterion vtapCriterion; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 156 | private Set<DeviceId> txDeviceIds; |
| 157 | private Set<DeviceId> rxDeviceIds; |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 158 | private SparseAnnotations annotations = DefaultAnnotations.EMPTY; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 159 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 160 | // Private constructor not intended to use from external |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 161 | Builder() { |
| 162 | } |
| 163 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 164 | Builder(OpenstackVtap description) { |
| 165 | this.id = description.id(); |
| 166 | this.type = description.type(); |
| 167 | this.vtapCriterion = description.vtapCriterion(); |
| 168 | this.type = description.type(); |
| 169 | this.txDeviceIds = description.txDeviceIds(); |
| 170 | this.rxDeviceIds = description.rxDeviceIds(); |
| 171 | this.annotations = (SparseAnnotations) description.annotations(); |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Sets mandatory field id. |
| 176 | * |
| 177 | * @param id to set |
| 178 | * @return self |
| 179 | */ |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 180 | @Override |
| 181 | public Builder id(OpenstackVtapId id) { |
| 182 | this.id = id; |
| 183 | return this; |
| 184 | } |
| 185 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 186 | /** |
| 187 | * Sets mandatory field type. |
| 188 | * |
| 189 | * @param type of the vtap |
| 190 | * @return self |
| 191 | */ |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 192 | @Override |
| 193 | public Builder type(Type type) { |
| 194 | this.type = type; |
| 195 | return this; |
| 196 | } |
| 197 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 198 | /** |
| 199 | * Sets mandatory field criterion. |
| 200 | * |
| 201 | * @param vtapCriterion for the vtap |
| 202 | * @return self |
| 203 | */ |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 204 | @Override |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 205 | public Builder vtapCriterion(OpenstackVtapCriterion vtapCriterion) { |
| 206 | this.vtapCriterion = vtapCriterion; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 207 | return this; |
| 208 | } |
| 209 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 210 | /** |
| 211 | * Sets a tx deviceId set. |
| 212 | * |
| 213 | * @param txDeviceIds deviceId set for tx |
| 214 | * @return builder |
| 215 | */ |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 216 | @Override |
| 217 | public Builder txDeviceIds(Set<DeviceId> txDeviceIds) { |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 218 | this.txDeviceIds = txDeviceIds; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 219 | return this; |
| 220 | } |
| 221 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 222 | /** |
| 223 | * Sets a rx deviceId set. |
| 224 | * |
| 225 | * @param rxDeviceIds deviceId set for rx |
| 226 | * @return builder |
| 227 | */ |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 228 | @Override |
| 229 | public Builder rxDeviceIds(Set<DeviceId> rxDeviceIds) { |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 230 | this.rxDeviceIds = rxDeviceIds; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 231 | return this; |
| 232 | } |
| 233 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 234 | /** |
| 235 | * Sets annotations. |
| 236 | * |
| 237 | * @param annotations of the vtap |
| 238 | * @return self |
| 239 | */ |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 240 | @Override |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 241 | public Builder annotations(SparseAnnotations annotations) { |
| 242 | this.annotations = annotations; |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 243 | return this; |
| 244 | } |
| 245 | |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 246 | /** |
| 247 | * Builds a DefaultOpenstackVtap instance. |
| 248 | * |
| 249 | * @return DefaultOpenstackVtap |
| 250 | */ |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 251 | @Override |
| 252 | public DefaultOpenstackVtap build() { |
Jimo Jung | 14e87bf | 2018-09-03 16:28:13 +0900 | [diff] [blame^] | 253 | return new DefaultOpenstackVtap(checkNotNull(id), |
| 254 | checkNotNull(type), |
| 255 | checkNotNull(vtapCriterion), |
| 256 | txDeviceIds, |
| 257 | rxDeviceIds, |
| 258 | checkNotNull(annotations)); |
Jian Li | 19f2526 | 2018-07-03 22:37:12 +0900 | [diff] [blame] | 259 | } |
| 260 | } |
| 261 | |
| 262 | } |