samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +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 | */ |
| 16 | package org.onosproject.net.behaviour; |
| 17 | |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 18 | import com.google.common.base.Strings; |
| 19 | import com.google.common.collect.Lists; |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 20 | import org.onosproject.net.DeviceId; |
| 21 | import org.onosproject.net.SparseAnnotations; |
| 22 | |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 23 | import java.util.List; |
| 24 | import java.util.Optional; |
| 25 | |
| 26 | import static com.google.common.base.Preconditions.checkArgument; |
| 27 | import static com.google.common.base.Preconditions.checkNotNull; |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 28 | |
| 29 | /** |
| 30 | * The default implementation of bridge. |
| 31 | */ |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 32 | public final class DefaultBridgeDescription implements BridgeDescription { |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 33 | |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 34 | private final String name; |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 35 | |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 36 | /* Optional OpenFlow configurations */ |
| 37 | private final List<ControllerInfo> controllers; |
| 38 | private final boolean enableLocalController; |
| 39 | private final Optional<FailMode> failMode; |
| 40 | private final Optional<String> datapathId; |
jaegonkim | 80bee53 | 2017-05-15 15:16:38 +0900 | [diff] [blame] | 41 | private final Optional<String> datapathType; |
rohitsharan | a127ba8 | 2018-01-16 02:17:30 +0530 | [diff] [blame] | 42 | private final Optional<List<ControlProtocolVersion>> controlProtocols; |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 43 | private final Optional<Boolean> disableInBand; |
Jian Li | a56dea6 | 2020-12-12 03:54:54 +0900 | [diff] [blame] | 44 | private final Optional<Boolean> mcastSnoopingEnable; |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 45 | |
| 46 | /* Adds more configurations */ |
| 47 | |
| 48 | private DefaultBridgeDescription(String name, |
| 49 | List<ControllerInfo> controllers, |
| 50 | boolean enableLocalController, |
| 51 | Optional<FailMode> failMode, |
| 52 | Optional<String> datapathId, |
jaegonkim | 80bee53 | 2017-05-15 15:16:38 +0900 | [diff] [blame] | 53 | Optional<String> datapathType, |
rohitsharan | a127ba8 | 2018-01-16 02:17:30 +0530 | [diff] [blame] | 54 | Optional<Boolean> disableInBand, |
Jian Li | a56dea6 | 2020-12-12 03:54:54 +0900 | [diff] [blame] | 55 | Optional<Boolean> mcastSnoopingEnable, |
rohitsharan | a127ba8 | 2018-01-16 02:17:30 +0530 | [diff] [blame] | 56 | Optional<List<ControlProtocolVersion>> controlProtocols) { |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 57 | this.name = checkNotNull(name); |
| 58 | this.controllers = controllers; |
| 59 | this.enableLocalController = enableLocalController; |
| 60 | this.failMode = failMode; |
| 61 | this.datapathId = datapathId; |
jaegonkim | 80bee53 | 2017-05-15 15:16:38 +0900 | [diff] [blame] | 62 | this.datapathType = datapathType; |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 63 | this.disableInBand = disableInBand; |
Jian Li | a56dea6 | 2020-12-12 03:54:54 +0900 | [diff] [blame] | 64 | this.mcastSnoopingEnable = mcastSnoopingEnable; |
rohitsharan | a127ba8 | 2018-01-16 02:17:30 +0530 | [diff] [blame] | 65 | this.controlProtocols = controlProtocols; |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 66 | } |
| 67 | |
| 68 | @Override |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 69 | public SparseAnnotations annotations() { |
| 70 | return null; |
| 71 | } |
| 72 | |
| 73 | @Override |
| 74 | public String name() { |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 75 | return name; |
| 76 | } |
| 77 | |
| 78 | @Override |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 79 | public List<ControllerInfo> controllers() { |
| 80 | return controllers; |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 81 | } |
| 82 | |
| 83 | @Override |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 84 | public boolean enableLocalController() { |
| 85 | return enableLocalController; |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 86 | } |
| 87 | |
| 88 | @Override |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 89 | public Optional<FailMode> failMode() { |
| 90 | return failMode; |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 91 | } |
| 92 | |
| 93 | @Override |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 94 | public Optional<String> datapathId() { |
| 95 | return datapathId; |
| 96 | } |
| 97 | |
| 98 | @Override |
jaegonkim | 80bee53 | 2017-05-15 15:16:38 +0900 | [diff] [blame] | 99 | public Optional<String> datapathType() { |
| 100 | return datapathType; |
| 101 | } |
| 102 | |
| 103 | @Override |
rohitsharan | a127ba8 | 2018-01-16 02:17:30 +0530 | [diff] [blame] | 104 | public Optional<List<ControlProtocolVersion>> controlProtocols() { |
| 105 | return controlProtocols; |
| 106 | } |
| 107 | |
| 108 | @Override |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 109 | public Optional<DeviceId> deviceId() { |
| 110 | if (datapathId.isPresent()) { |
| 111 | return Optional.of(DeviceId.deviceId("of:" + datapathId.get())); |
| 112 | } else { |
| 113 | return Optional.empty(); |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 114 | } |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | @Override |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 118 | public Optional<Boolean> disableInBand() { |
| 119 | return disableInBand; |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 120 | } |
| 121 | |
Jian Li | a56dea6 | 2020-12-12 03:54:54 +0900 | [diff] [blame] | 122 | @Override |
| 123 | public Optional<Boolean> mcastSnoopingEnable() { |
| 124 | return mcastSnoopingEnable; |
| 125 | } |
| 126 | |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 127 | /** |
| 128 | * Creates and returns a new builder instance. |
| 129 | * |
| 130 | * @return new builder |
| 131 | */ |
| 132 | public static BridgeDescription.Builder builder() { |
| 133 | return new Builder(); |
| 134 | } |
| 135 | |
| 136 | public static final class Builder implements BridgeDescription.Builder { |
| 137 | |
| 138 | private String name; |
| 139 | private List<ControllerInfo> controllers = Lists.newArrayList(); |
| 140 | private boolean enableLocalController = false; |
| 141 | private Optional<FailMode> failMode = Optional.empty(); |
| 142 | private Optional<String> datapathId = Optional.empty(); |
jaegonkim | 80bee53 | 2017-05-15 15:16:38 +0900 | [diff] [blame] | 143 | private Optional<String> datapathType = Optional.empty(); |
rohitsharan | a127ba8 | 2018-01-16 02:17:30 +0530 | [diff] [blame] | 144 | private Optional<List<ControlProtocolVersion>> controlProtocols = Optional.empty(); |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 145 | private Optional<Boolean> disableInBand = Optional.empty(); |
Jian Li | a56dea6 | 2020-12-12 03:54:54 +0900 | [diff] [blame] | 146 | private Optional<Boolean> mcastSnoopingEnable = Optional.empty(); |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 147 | |
| 148 | private Builder() { |
| 149 | } |
| 150 | |
| 151 | @Override |
| 152 | public BridgeDescription build() { |
| 153 | return new DefaultBridgeDescription(name, controllers, |
| 154 | enableLocalController, |
| 155 | failMode, |
| 156 | datapathId, |
jaegonkim | 80bee53 | 2017-05-15 15:16:38 +0900 | [diff] [blame] | 157 | datapathType, |
rohitsharan | a127ba8 | 2018-01-16 02:17:30 +0530 | [diff] [blame] | 158 | disableInBand, |
Jian Li | a56dea6 | 2020-12-12 03:54:54 +0900 | [diff] [blame] | 159 | mcastSnoopingEnable, |
rohitsharan | a127ba8 | 2018-01-16 02:17:30 +0530 | [diff] [blame] | 160 | controlProtocols); |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 161 | } |
| 162 | |
| 163 | @Override |
| 164 | public Builder name(String name) { |
| 165 | checkArgument(!Strings.isNullOrEmpty(name)); |
| 166 | this.name = name; |
| 167 | return this; |
| 168 | } |
| 169 | |
| 170 | @Override |
| 171 | public Builder controllers(List<ControllerInfo> controllers) { |
| 172 | if (controllers != null) { |
| 173 | this.controllers = Lists.newArrayList(controllers); |
| 174 | } |
| 175 | return this; |
| 176 | } |
| 177 | |
| 178 | @Override |
| 179 | public Builder enableLocalController() { |
| 180 | this.enableLocalController = true; |
| 181 | return this; |
| 182 | } |
| 183 | |
| 184 | @Override |
| 185 | public Builder failMode(FailMode failMode) { |
| 186 | this.failMode = Optional.ofNullable(failMode); |
| 187 | return this; |
| 188 | } |
| 189 | |
| 190 | @Override |
| 191 | public Builder datapathId(String datapathId) { |
| 192 | this.datapathId = Optional.ofNullable(datapathId); |
| 193 | return this; |
| 194 | } |
| 195 | |
| 196 | @Override |
jaegonkim | 80bee53 | 2017-05-15 15:16:38 +0900 | [diff] [blame] | 197 | public Builder datapathType(String datapathType) { |
| 198 | this.datapathType = Optional.ofNullable(datapathType); |
| 199 | return this; |
| 200 | } |
| 201 | |
| 202 | @Override |
rohitsharan | a127ba8 | 2018-01-16 02:17:30 +0530 | [diff] [blame] | 203 | public Builder controlProtocols(List<ControlProtocolVersion> controlProtocols) { |
| 204 | this.controlProtocols = Optional.ofNullable(controlProtocols); |
| 205 | return this; |
| 206 | } |
| 207 | |
| 208 | @Override |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 209 | public Builder disableInBand() { |
| 210 | this.disableInBand = Optional.of(Boolean.TRUE); |
| 211 | return this; |
| 212 | } |
Jian Li | a56dea6 | 2020-12-12 03:54:54 +0900 | [diff] [blame] | 213 | |
| 214 | @Override |
| 215 | public BridgeDescription.Builder mcastSnoopingEnable() { |
| 216 | this.mcastSnoopingEnable = Optional.of(Boolean.TRUE); |
| 217 | return this; |
| 218 | } |
Hyunsun Moon | 1251e19 | 2016-06-07 16:57:05 -0700 | [diff] [blame] | 219 | } |
samuel | 8d6b0a9 | 2015-07-11 13:22:57 +0800 | [diff] [blame] | 220 | } |