Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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 |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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. |
Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.flow; |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 17 | |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 18 | import java.util.HashMap; |
| 19 | import java.util.Map; |
| 20 | import java.util.Objects; |
| 21 | import java.util.Set; |
| 22 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 23 | import org.onosproject.net.PortNumber; |
| 24 | import org.onosproject.net.flow.criteria.Criteria; |
| 25 | import org.onosproject.net.flow.criteria.Criterion; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 26 | import org.onlab.packet.IpPrefix; |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 27 | import org.onlab.packet.Ip6Address; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 28 | import org.onlab.packet.MacAddress; |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 29 | import org.onlab.packet.MplsLabel; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 30 | import org.onlab.packet.VlanId; |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 31 | |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 32 | import com.google.common.base.MoreObjects; |
| 33 | import com.google.common.collect.ImmutableSet; |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 34 | |
| 35 | /** |
| 36 | * Default traffic selector implementation. |
| 37 | */ |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 38 | public final class DefaultTrafficSelector implements TrafficSelector { |
| 39 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 40 | private final Set<Criterion> criteria; |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 41 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 42 | /** |
| 43 | * Creates a new traffic selector with the specified criteria. |
| 44 | * |
| 45 | * @param criteria criteria |
| 46 | */ |
| 47 | private DefaultTrafficSelector(Set<Criterion> criteria) { |
Yuta HIGUCHI | 2809bf3 | 2014-10-20 22:44:12 -0700 | [diff] [blame] | 48 | this.criteria = ImmutableSet.copyOf(criteria); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 49 | } |
| 50 | |
| 51 | @Override |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 52 | public Set<Criterion> criteria() { |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 53 | return criteria; |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 54 | } |
| 55 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 56 | @Override |
Jonathan Hart | 936c49d | 2014-10-23 16:38:59 -0700 | [diff] [blame] | 57 | public Criterion getCriterion(Criterion.Type type) { |
| 58 | for (Criterion c : criteria) { |
| 59 | if (c.type() == type) { |
| 60 | return c; |
| 61 | } |
| 62 | } |
| 63 | return null; |
| 64 | } |
| 65 | |
| 66 | @Override |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 67 | public int hashCode() { |
Thomas Vachuska | 9b2da21 | 2014-11-10 19:30:25 -0800 | [diff] [blame] | 68 | return criteria.hashCode(); |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 69 | } |
| 70 | |
| 71 | @Override |
| 72 | public boolean equals(Object obj) { |
| 73 | if (this == obj) { |
| 74 | return true; |
| 75 | } |
| 76 | if (obj instanceof DefaultTrafficSelector) { |
| 77 | DefaultTrafficSelector that = (DefaultTrafficSelector) obj; |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 78 | return Objects.equals(criteria, that.criteria); |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 79 | |
| 80 | } |
| 81 | return false; |
| 82 | } |
| 83 | |
Jonathan Hart | d87aeca | 2014-10-21 10:42:52 -0700 | [diff] [blame] | 84 | @Override |
| 85 | public String toString() { |
| 86 | return MoreObjects.toStringHelper(getClass()) |
| 87 | .add("criteria", criteria) |
| 88 | .toString(); |
| 89 | } |
| 90 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 91 | /** |
| 92 | * Returns a new traffic selector builder. |
| 93 | * |
| 94 | * @return traffic selector builder |
| 95 | */ |
| 96 | public static TrafficSelector.Builder builder() { |
| 97 | return new Builder(); |
| 98 | } |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 99 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 100 | /** |
| 101 | * Returns a new traffic selector builder primed to produce entities |
| 102 | * patterned after the supplied selector. |
| 103 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 104 | * @param selector base selector |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 105 | * @return traffic selector builder |
| 106 | */ |
| 107 | public static TrafficSelector.Builder builder(TrafficSelector selector) { |
| 108 | return new Builder(selector); |
| 109 | } |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 110 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 111 | /** |
| 112 | * Builder of traffic selector entities. |
| 113 | */ |
| 114 | public static final class Builder implements TrafficSelector.Builder { |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 115 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 116 | private final Map<Criterion.Type, Criterion> selector = new HashMap<>(); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 117 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 118 | private Builder() { |
| 119 | } |
| 120 | |
| 121 | private Builder(TrafficSelector selector) { |
| 122 | for (Criterion c : selector.criteria()) { |
| 123 | add(c); |
| 124 | } |
| 125 | } |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 126 | |
| 127 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 128 | public Builder add(Criterion criterion) { |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 129 | selector.put(criterion.type(), criterion); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 130 | return this; |
| 131 | } |
| 132 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 133 | @Override |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 134 | public Builder matchInPort(PortNumber port) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 135 | return add(Criteria.matchInPort(port)); |
| 136 | } |
| 137 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 138 | @Override |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 139 | public Builder matchInPhyPort(PortNumber port) { |
| 140 | return add(Criteria.matchInPhyPort(port)); |
| 141 | } |
| 142 | |
| 143 | @Override |
| 144 | public Builder matchMetadata(Long metadata) { |
| 145 | return add(Criteria.matchMetadata(metadata)); |
| 146 | } |
| 147 | |
| 148 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 149 | public Builder matchEthDst(MacAddress addr) { |
| 150 | return add(Criteria.matchEthDst(addr)); |
| 151 | } |
| 152 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 153 | @Override |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 154 | public Builder matchEthSrc(MacAddress addr) { |
| 155 | return add(Criteria.matchEthSrc(addr)); |
| 156 | } |
| 157 | |
| 158 | @Override |
| 159 | public Builder matchEthType(Short ethType) { |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 160 | return add(Criteria.matchEthType(ethType)); |
| 161 | } |
| 162 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 163 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 164 | public Builder matchVlanId(VlanId vlanId) { |
| 165 | return add(Criteria.matchVlanId(vlanId)); |
| 166 | } |
| 167 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 168 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 169 | public Builder matchVlanPcp(Byte vlanPcp) { |
| 170 | return add(Criteria.matchVlanPcp(vlanPcp)); |
| 171 | } |
| 172 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 173 | @Override |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 174 | public Builder matchIPDscp(Byte ipDscp) { |
| 175 | return add(Criteria.matchIPDscp(ipDscp)); |
| 176 | } |
| 177 | |
| 178 | @Override |
| 179 | public Builder matchIPEcn(Byte ipEcn) { |
| 180 | return add(Criteria.matchIPEcn(ipEcn)); |
| 181 | } |
| 182 | |
| 183 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 184 | public Builder matchIPProtocol(Byte proto) { |
| 185 | return add(Criteria.matchIPProtocol(proto)); |
| 186 | } |
| 187 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 188 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 189 | public Builder matchIPSrc(IpPrefix ip) { |
| 190 | return add(Criteria.matchIPSrc(ip)); |
| 191 | } |
| 192 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 193 | @Override |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 194 | public Builder matchIPDst(IpPrefix ip) { |
| 195 | return add(Criteria.matchIPDst(ip)); |
| 196 | } |
| 197 | |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 198 | @Override |
Toshio Koide | 9c44c9a | 2014-10-09 11:44:36 -0700 | [diff] [blame] | 199 | public Builder matchTcpSrc(Short tcpPort) { |
| 200 | return add(Criteria.matchTcpSrc(tcpPort)); |
| 201 | } |
| 202 | |
| 203 | @Override |
| 204 | public Builder matchTcpDst(Short tcpPort) { |
| 205 | return add(Criteria.matchTcpDst(tcpPort)); |
| 206 | } |
| 207 | |
| 208 | @Override |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 209 | public Builder matchUdpSrc(Short udpPort) { |
| 210 | return add(Criteria.matchUdpSrc(udpPort)); |
| 211 | } |
| 212 | |
| 213 | @Override |
| 214 | public Builder matchUdpDst(Short udpPort) { |
| 215 | return add(Criteria.matchUdpDst(udpPort)); |
| 216 | } |
| 217 | |
| 218 | @Override |
| 219 | public Builder matchSctpSrc(Short sctpPort) { |
| 220 | return add(Criteria.matchSctpSrc(sctpPort)); |
| 221 | } |
| 222 | |
| 223 | @Override |
| 224 | public Builder matchSctpDst(Short sctpPort) { |
| 225 | return add(Criteria.matchSctpDst(sctpPort)); |
| 226 | } |
| 227 | |
| 228 | @Override |
| 229 | public Builder matchIcmpType(Byte icmpType) { |
| 230 | return add(Criteria.matchIcmpType(icmpType)); |
| 231 | } |
| 232 | |
| 233 | @Override |
| 234 | public Builder matchIcmpCode(Byte icmpCode) { |
| 235 | return add(Criteria.matchIcmpCode(icmpCode)); |
| 236 | } |
| 237 | |
| 238 | @Override |
Charles M.C. Chan | 52fae7d | 2015-01-17 00:35:53 +0800 | [diff] [blame] | 239 | public Builder matchIPv6Src(IpPrefix ip) { |
| 240 | return add(Criteria.matchIPv6Src(ip)); |
| 241 | } |
| 242 | |
| 243 | @Override |
| 244 | public Builder matchIPv6Dst(IpPrefix ip) { |
| 245 | return add(Criteria.matchIPv6Dst(ip)); |
| 246 | } |
| 247 | |
| 248 | @Override |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 249 | public Builder matchIPv6FlowLabel(Integer flowLabel) { |
| 250 | return add(Criteria.matchIPv6FlowLabel(flowLabel)); |
| 251 | } |
| 252 | |
| 253 | @Override |
Kunihiro Ishiguro | 0f9aba8 | 2015-01-15 17:14:17 -0800 | [diff] [blame] | 254 | public Builder matchIcmpv6Type(Byte icmpv6Type) { |
| 255 | return add(Criteria.matchIcmpv6Type(icmpv6Type)); |
| 256 | } |
| 257 | |
| 258 | @Override |
| 259 | public Builder matchIcmpv6Code(Byte icmpv6Code) { |
| 260 | return add(Criteria.matchIcmpv6Code(icmpv6Code)); |
| 261 | } |
| 262 | |
| 263 | @Override |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 264 | public Builder matchIPv6NDTargetAddress(Ip6Address targetAddress) { |
| 265 | return add(Criteria.matchIPv6NDTargetAddress(targetAddress)); |
| 266 | } |
| 267 | |
| 268 | @Override |
| 269 | public Builder matchIPv6NDSourceLinkLayerAddress(MacAddress mac) { |
| 270 | return add(Criteria.matchIPv6NDSourceLinkLayerAddress(mac)); |
| 271 | } |
| 272 | |
| 273 | @Override |
| 274 | public Builder matchIPv6NDTargetLinkLayerAddress(MacAddress mac) { |
| 275 | return add(Criteria.matchIPv6NDTargetLinkLayerAddress(mac)); |
| 276 | } |
| 277 | |
| 278 | @Override |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 279 | public Builder matchMplsLabel(MplsLabel mplsLabel) { |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 280 | return add(Criteria.matchMplsLabel(mplsLabel)); |
| 281 | } |
| 282 | |
| 283 | @Override |
Pavlin Radoslavov | 5e4f754 | 2015-02-06 18:18:21 -0800 | [diff] [blame] | 284 | public Builder matchIPv6ExthdrFlags(Integer exthdrFlags) { |
| 285 | return add(Criteria.matchIPv6ExthdrFlags(exthdrFlags)); |
| 286 | } |
| 287 | |
| 288 | @Override |
Praseed Balakrishnan | 64369da | 2014-10-23 15:55:20 -0700 | [diff] [blame] | 289 | public Builder matchLambda(Short lambda) { |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 290 | return add(Criteria.matchLambda(lambda)); |
| 291 | } |
| 292 | |
| 293 | @Override |
Praseed Balakrishnan | 2dd5abd | 2014-11-03 14:56:28 -0800 | [diff] [blame] | 294 | public Builder matchOpticalSignalType(Short signalType) { |
Praseed Balakrishnan | 64369da | 2014-10-23 15:55:20 -0700 | [diff] [blame] | 295 | return add(Criteria.matchOpticalSignalType(signalType)); |
Praseed Balakrishnan | 64369da | 2014-10-23 15:55:20 -0700 | [diff] [blame] | 296 | } |
| 297 | |
| 298 | @Override |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 299 | public TrafficSelector build() { |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 300 | return new DefaultTrafficSelector(ImmutableSet.copyOf(selector.values())); |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 301 | } |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 302 | } |
alshabib | 7b2748f | 2014-09-16 20:21:11 -0700 | [diff] [blame] | 303 | } |