Thomas Vachuska | 83e090e | 2014-10-22 14:25:35 -0700 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 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; |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 17 | |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 18 | import java.util.Set; |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 19 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 20 | import org.onosproject.net.PortNumber; |
Saurav Das | ffc5bbc | 2015-08-18 23:30:19 -0700 | [diff] [blame^] | 21 | import org.onosproject.net.flow.DefaultTrafficSelector.Builder; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 22 | import org.onosproject.net.flow.criteria.Criterion; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 23 | import org.onlab.packet.IpPrefix; |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 24 | import org.onlab.packet.Ip6Address; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 25 | import org.onlab.packet.MacAddress; |
Michele Santuari | 4b6019e | 2014-12-19 11:31:45 +0100 | [diff] [blame] | 26 | import org.onlab.packet.MplsLabel; |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 27 | import org.onlab.packet.VlanId; |
alshabib | 7410fea | 2014-09-16 13:48:39 -0700 | [diff] [blame] | 28 | |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 29 | /** |
| 30 | * Abstraction of a slice of network traffic. |
| 31 | */ |
| 32 | public interface TrafficSelector { |
| 33 | |
| 34 | /** |
| 35 | * Returns selection criteria as an ordered list. |
| 36 | * |
| 37 | * @return list of criteria |
| 38 | */ |
alshabib | ba5ac48 | 2014-10-02 17:15:20 -0700 | [diff] [blame] | 39 | Set<Criterion> criteria(); |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 40 | |
| 41 | /** |
Jonathan Hart | 936c49d | 2014-10-23 16:38:59 -0700 | [diff] [blame] | 42 | * Returns the selection criterion for a particular type, if it exists in |
| 43 | * this traffic selector. |
| 44 | * |
| 45 | * @param type criterion type to look up |
| 46 | * @return the criterion of the specified type if one exists, otherwise null |
| 47 | */ |
| 48 | Criterion getCriterion(Criterion.Type type); |
| 49 | |
| 50 | /** |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 51 | * Builder of traffic selector entities. |
| 52 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 53 | interface Builder { |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 54 | |
| 55 | /** |
| 56 | * Adds a traffic selection criterion. If a same type criterion has |
| 57 | * already been added, it will be replaced by this one. |
| 58 | * |
| 59 | * @param criterion new criterion |
alshabib | 369d294 | 2014-09-12 17:59:35 -0700 | [diff] [blame] | 60 | * @return self |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 61 | */ |
alshabib | 369d294 | 2014-09-12 17:59:35 -0700 | [diff] [blame] | 62 | Builder add(Criterion criterion); |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 63 | |
| 64 | /** |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 65 | * Matches an inport. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 66 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 67 | * @param port the inport |
| 68 | * @return a selection builder |
| 69 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 70 | Builder matchInPort(PortNumber port); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 71 | |
| 72 | /** |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 73 | * Matches a physical inport. |
| 74 | * |
| 75 | * @param port the physical inport |
| 76 | * @return a selection builder |
| 77 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 78 | Builder matchInPhyPort(PortNumber port); |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 79 | |
| 80 | /** |
| 81 | * Matches a metadata. |
| 82 | * |
| 83 | * @param metadata the metadata |
| 84 | * @return a selection builder |
| 85 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 86 | Builder matchMetadata(long metadata); |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 87 | |
| 88 | /** |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 89 | * Matches a l2 dst address. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 90 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 91 | * @param addr a l2 address |
| 92 | * @return a selection builder |
| 93 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 94 | Builder matchEthDst(MacAddress addr); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 95 | |
| 96 | /** |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 97 | * Matches a l2 src address. |
| 98 | * |
| 99 | * @param addr a l2 address |
| 100 | * @return a selection builder |
| 101 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 102 | Builder matchEthSrc(MacAddress addr); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 103 | |
| 104 | /** |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 105 | * Matches the ethernet type. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 106 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 107 | * @param ethType an ethernet type |
| 108 | * @return a selection builder |
| 109 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 110 | Builder matchEthType(short ethType); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 111 | |
| 112 | /** |
| 113 | * Matches the vlan id. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 114 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 115 | * @param vlanId a vlan id |
| 116 | * @return a selection builder |
| 117 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 118 | Builder matchVlanId(VlanId vlanId); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 119 | |
| 120 | /** |
| 121 | * Matches a vlan priority. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 122 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 123 | * @param vlanPcp a vlan priority |
| 124 | * @return a selection builder |
| 125 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 126 | Builder matchVlanPcp(byte vlanPcp); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 127 | |
| 128 | /** |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 129 | * Matches an IP DSCP (6 bits in ToS field). |
| 130 | * |
| 131 | * @param ipDscp an IP DSCP value |
| 132 | * @return a selection builder |
| 133 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 134 | Builder matchIPDscp(byte ipDscp); |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 135 | |
| 136 | /** |
| 137 | * Matches an IP ECN (2 bits in ToS field). |
| 138 | * |
| 139 | * @param ipEcn an IP ECN value |
| 140 | * @return a selection builder |
| 141 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 142 | Builder matchIPEcn(byte ipEcn); |
Pavlin Radoslavov | d0fd841 | 2015-02-04 13:57:00 -0800 | [diff] [blame] | 143 | |
| 144 | /** |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 145 | * Matches the l3 protocol. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 146 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 147 | * @param proto a l3 protocol |
| 148 | * @return a selection builder |
| 149 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 150 | Builder matchIPProtocol(byte proto); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 151 | |
| 152 | /** |
Charles M.C. Chan | 52fae7d | 2015-01-17 00:35:53 +0800 | [diff] [blame] | 153 | * Matches a l3 IPv4 address. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 154 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 155 | * @param ip a l3 address |
| 156 | * @return a selection builder |
| 157 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 158 | Builder matchIPSrc(IpPrefix ip); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 159 | |
| 160 | /** |
Charles M.C. Chan | 52fae7d | 2015-01-17 00:35:53 +0800 | [diff] [blame] | 161 | * Matches a l3 IPv4 address. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 162 | * |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 163 | * @param ip a l3 address |
| 164 | * @return a selection builder |
| 165 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 166 | Builder matchIPDst(IpPrefix ip); |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 167 | |
| 168 | /** |
Toshio Koide | 9c44c9a | 2014-10-09 11:44:36 -0700 | [diff] [blame] | 169 | * Matches a TCP source port number. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 170 | * |
Toshio Koide | 9c44c9a | 2014-10-09 11:44:36 -0700 | [diff] [blame] | 171 | * @param tcpPort a TCP source port number |
| 172 | * @return a selection builder |
| 173 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 174 | Builder matchTcpSrc(short tcpPort); |
Toshio Koide | 9c44c9a | 2014-10-09 11:44:36 -0700 | [diff] [blame] | 175 | |
| 176 | /** |
| 177 | * Matches a TCP destination port number. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 178 | * |
Toshio Koide | 9c44c9a | 2014-10-09 11:44:36 -0700 | [diff] [blame] | 179 | * @param tcpPort a TCP destination port number |
| 180 | * @return a selection builder |
| 181 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 182 | Builder matchTcpDst(short tcpPort); |
Toshio Koide | 9c44c9a | 2014-10-09 11:44:36 -0700 | [diff] [blame] | 183 | |
Charles M.C. Chan | 52fae7d | 2015-01-17 00:35:53 +0800 | [diff] [blame] | 184 | /** |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 185 | * Matches an UDP source port number. |
| 186 | * |
| 187 | * @param udpPort an UDP source port number |
| 188 | * @return a selection builder |
| 189 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 190 | Builder matchUdpSrc(short udpPort); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 191 | |
| 192 | /** |
| 193 | * Matches an UDP destination port number. |
| 194 | * |
| 195 | * @param udpPort an UDP destination port number |
| 196 | * @return a selection builder |
| 197 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 198 | Builder matchUdpDst(short udpPort); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 199 | |
| 200 | /** |
| 201 | * Matches a SCTP source port number. |
| 202 | * |
| 203 | * @param sctpPort a SCTP source port number |
| 204 | * @return a selection builder |
| 205 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 206 | Builder matchSctpSrc(short sctpPort); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 207 | |
| 208 | /** |
| 209 | * Matches a SCTP destination port number. |
| 210 | * |
| 211 | * @param sctpPort a SCTP destination port number |
| 212 | * @return a selection builder |
| 213 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 214 | Builder matchSctpDst(short sctpPort); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 215 | |
| 216 | /** |
| 217 | * Matches an ICMP type. |
| 218 | * |
| 219 | * @param icmpType an ICMP type |
| 220 | * @return a selection builder |
| 221 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 222 | Builder matchIcmpType(byte icmpType); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 223 | |
| 224 | /** |
| 225 | * Matches an ICMP code. |
| 226 | * |
| 227 | * @param icmpCode an ICMP code |
| 228 | * @return a selection builder |
| 229 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 230 | Builder matchIcmpCode(byte icmpCode); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 231 | |
| 232 | /** |
Charles M.C. Chan | 52fae7d | 2015-01-17 00:35:53 +0800 | [diff] [blame] | 233 | * Matches a l3 IPv6 address. |
| 234 | * |
| 235 | * @param ip a l3 IPv6 address |
| 236 | * @return a selection builder |
| 237 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 238 | Builder matchIPv6Src(IpPrefix ip); |
Charles M.C. Chan | 52fae7d | 2015-01-17 00:35:53 +0800 | [diff] [blame] | 239 | |
| 240 | /** |
| 241 | * Matches a l3 IPv6 address. |
| 242 | * |
| 243 | * @param ip a l3 IPv6 address |
| 244 | * @return a selection builder |
| 245 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 246 | Builder matchIPv6Dst(IpPrefix ip); |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 247 | |
| 248 | /** |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 249 | * Matches an IPv6 flow label. |
Kunihiro Ishiguro | 0f9aba8 | 2015-01-15 17:14:17 -0800 | [diff] [blame] | 250 | * |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 251 | * @param flowLabel an IPv6 flow label |
| 252 | * @return a selection builder |
| 253 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 254 | Builder matchIPv6FlowLabel(int flowLabel); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 255 | |
| 256 | /** |
| 257 | * Matches an ICMPv6 type. |
| 258 | * |
| 259 | * @param icmpv6Type an ICMPv6 type |
Kunihiro Ishiguro | 0f9aba8 | 2015-01-15 17:14:17 -0800 | [diff] [blame] | 260 | * @return a selection builder |
| 261 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 262 | Builder matchIcmpv6Type(byte icmpv6Type); |
Kunihiro Ishiguro | 0f9aba8 | 2015-01-15 17:14:17 -0800 | [diff] [blame] | 263 | |
| 264 | /** |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 265 | * Matches an ICMPv6 code. |
Kunihiro Ishiguro | 0f9aba8 | 2015-01-15 17:14:17 -0800 | [diff] [blame] | 266 | * |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 267 | * @param icmpv6Code an ICMPv6 code |
Kunihiro Ishiguro | 0f9aba8 | 2015-01-15 17:14:17 -0800 | [diff] [blame] | 268 | * @return a selection builder |
| 269 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 270 | Builder matchIcmpv6Code(byte icmpv6Code); |
Kunihiro Ishiguro | 0f9aba8 | 2015-01-15 17:14:17 -0800 | [diff] [blame] | 271 | |
| 272 | /** |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 273 | * Matches an IPv6 Neighbor Discovery target address. |
| 274 | * |
| 275 | * @param targetAddress an IPv6 Neighbor Discovery target address |
| 276 | * @return a selection builder |
| 277 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 278 | Builder matchIPv6NDTargetAddress(Ip6Address targetAddress); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 279 | |
| 280 | /** |
| 281 | * Matches an IPv6 Neighbor Discovery source link-layer address. |
| 282 | * |
| 283 | * @param mac an IPv6 Neighbor Discovery source link-layer address |
| 284 | * @return a selection builder |
| 285 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 286 | Builder matchIPv6NDSourceLinkLayerAddress(MacAddress mac); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 287 | |
| 288 | /** |
| 289 | * Matches an IPv6 Neighbor Discovery target link-layer address. |
| 290 | * |
| 291 | * @param mac an IPv6 Neighbor Discovery target link-layer address |
| 292 | * @return a selection builder |
| 293 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 294 | Builder matchIPv6NDTargetLinkLayerAddress(MacAddress mac); |
Pavlin Radoslavov | 320e6c9 | 2015-02-02 16:51:58 -0800 | [diff] [blame] | 295 | |
| 296 | /** |
| 297 | * Matches on a MPLS label. |
| 298 | * |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 299 | * @param mplsLabel a MPLS label. |
| 300 | * @return a selection builder |
| 301 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 302 | Builder matchMplsLabel(MplsLabel mplsLabel); |
Praseed Balakrishnan | 8c67d17 | 2014-11-10 10:15:41 -0800 | [diff] [blame] | 303 | |
Toshio Koide | 9c44c9a | 2014-10-09 11:44:36 -0700 | [diff] [blame] | 304 | /** |
Saurav Das | ffc5bbc | 2015-08-18 23:30:19 -0700 | [diff] [blame^] | 305 | * Matches on a MPLS Bottom-of-Stack indicator bit. |
| 306 | * |
| 307 | * @param mplsBos boolean value indicating BOS=1 (true) or BOS=0 (false). |
| 308 | * @return a selection builder |
| 309 | */ |
| 310 | Builder matchMplsBos(boolean mplsBos); |
| 311 | |
| 312 | /** |
Hyunsun Moon | a08c5d0 | 2015-07-14 17:53:00 -0700 | [diff] [blame] | 313 | * Matches a tunnel id. |
| 314 | * |
| 315 | * @param tunnelId a tunnel id |
| 316 | * @return a selection builder |
| 317 | */ |
| 318 | Builder matchTunnelId(long tunnelId); |
| 319 | |
| 320 | /** |
Sho SHIMIZU | 60f1214 | 2015-05-06 14:22:03 -0700 | [diff] [blame] | 321 | * Matches on IPv6 Extension Header pseudo-field flags. |
Pavlin Radoslavov | 5e4f754 | 2015-02-06 18:18:21 -0800 | [diff] [blame] | 322 | * |
Sho SHIMIZU | 60f1214 | 2015-05-06 14:22:03 -0700 | [diff] [blame] | 323 | * @param exthdrFlags the IPv6 Extension Header pseudo-field flags |
Pavlin Radoslavov | 5e4f754 | 2015-02-06 18:18:21 -0800 | [diff] [blame] | 324 | * @return a selection builder |
| 325 | */ |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 326 | Builder matchIPv6ExthdrFlags(short exthdrFlags); |
Pavlin Radoslavov | 5e4f754 | 2015-02-06 18:18:21 -0800 | [diff] [blame] | 327 | |
| 328 | /** |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 329 | * Matches an optical signal ID or lambda. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 330 | * |
Sho SHIMIZU | 60f1214 | 2015-05-06 14:22:03 -0700 | [diff] [blame] | 331 | * @param lambda lambda |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 332 | * @return a selection builder |
Sho SHIMIZU | c72c8ea | 2015-05-06 16:01:47 -0700 | [diff] [blame] | 333 | * @deprecated in Cardinal Release. |
| 334 | * Use {@link #add(Criterion)} with an instance created |
| 335 | * by {@link org.onosproject.net.flow.criteria.Criteria#matchLambda(org.onosproject.net.Lambda)}. |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 336 | */ |
Sho SHIMIZU | c72c8ea | 2015-05-06 16:01:47 -0700 | [diff] [blame] | 337 | @Deprecated |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 338 | Builder matchLambda(short lambda); |
Praseed Balakrishnan | 64369da | 2014-10-23 15:55:20 -0700 | [diff] [blame] | 339 | |
| 340 | /** |
| 341 | * Matches an optical Signal Type. |
Sho SHIMIZU | bdaea83 | 2014-11-12 11:29:38 -0800 | [diff] [blame] | 342 | * |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 343 | * @param signalType signalType |
Praseed Balakrishnan | 64369da | 2014-10-23 15:55:20 -0700 | [diff] [blame] | 344 | * @return a selection builder |
Sho SHIMIZU | c72c8ea | 2015-05-06 16:01:47 -0700 | [diff] [blame] | 345 | * @deprecated in Cardinal Release. |
| 346 | * Use {@link #add(Criterion)}} with an instance created |
| 347 | * by {@link org.onosproject.net.flow.criteria.Criteria#matchOchSignalType(org.onosproject.net.OchSignalType)}. |
Praseed Balakrishnan | 64369da | 2014-10-23 15:55:20 -0700 | [diff] [blame] | 348 | */ |
Sho SHIMIZU | c72c8ea | 2015-05-06 16:01:47 -0700 | [diff] [blame] | 349 | @Deprecated |
Sho SHIMIZU | 15c3800 | 2015-04-28 19:00:37 -0700 | [diff] [blame] | 350 | Builder matchOpticalSignalType(short signalType); |
Marc De Leenheer | 4908775 | 2014-10-23 13:54:09 -0700 | [diff] [blame] | 351 | |
| 352 | /** |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 353 | * Builds an immutable traffic selector. |
| 354 | * |
| 355 | * @return traffic selector |
| 356 | */ |
| 357 | TrafficSelector build(); |
| 358 | } |
tom | 8bb1606 | 2014-09-12 14:47:46 -0700 | [diff] [blame] | 359 | } |