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.intent; |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 17 | |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableSet; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 19 | import org.onosproject.core.ApplicationId; |
| 20 | import org.onosproject.net.Link; |
| 21 | import org.onosproject.net.NetworkResource; |
| 22 | import org.onosproject.net.flow.TrafficSelector; |
| 23 | import org.onosproject.net.flow.TrafficTreatment; |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 24 | |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 25 | import java.util.Collection; |
Sho SHIMIZU | c3df36b | 2014-11-11 18:19:29 -0800 | [diff] [blame] | 26 | import java.util.Collections; |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 27 | import java.util.List; |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 28 | |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 29 | import static com.google.common.base.Preconditions.checkNotNull; |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 30 | |
| 31 | /** |
| 32 | * Abstraction of connectivity intent for traffic matching some criteria. |
| 33 | */ |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 34 | public abstract class ConnectivityIntent extends Intent { |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 35 | |
| 36 | // TODO: other forms of intents should be considered for this family: |
| 37 | // point-to-point with constraints (waypoints/obstacles) |
| 38 | // multi-to-single point with constraints (waypoints/obstacles) |
| 39 | // single-to-multi point with constraints (waypoints/obstacles) |
| 40 | // concrete path (with alternate) |
| 41 | // ... |
| 42 | |
| 43 | private final TrafficSelector selector; |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 44 | private final TrafficTreatment treatment; |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 45 | private final List<Constraint> constraints; |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 46 | |
| 47 | /** |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 48 | * Creates a connectivity intent that matches on the specified selector |
| 49 | * and applies the specified treatment. |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 50 | * <p> |
| 51 | * Path will be chosen without any constraints. |
| 52 | * </p> |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 53 | * |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 54 | * @param appId application identifier |
| 55 | * @param resources required network resources (optional) |
| 56 | * @param selector traffic selector |
| 57 | * @param treatment treatment |
Ray Milkey | e1dfb50 | 2015-01-13 16:35:46 -0800 | [diff] [blame] | 58 | * @throws NullPointerException if the selector or treatment is null |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 59 | */ |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 60 | protected ConnectivityIntent(ApplicationId appId, |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 61 | Collection<NetworkResource> resources, |
| 62 | TrafficSelector selector, |
| 63 | TrafficTreatment treatment) { |
Ray Milkey | 5b3717e | 2015-02-05 11:44:08 -0800 | [diff] [blame] | 64 | this(appId, null, resources, selector, treatment, Collections.emptyList()); |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Creates a connectivity intent that matches on the specified selector |
| 69 | * and applies the specified treatment. |
| 70 | * <p> |
| 71 | * Path will be chosen without any constraints. |
| 72 | * </p> |
| 73 | * |
| 74 | * @param appId application identifier |
| 75 | * @param key intent key |
| 76 | * @param resources required network resources (optional) |
| 77 | * @param selector traffic selector |
| 78 | * @param treatment treatment |
| 79 | * @throws NullPointerException if the selector or treatment is null |
| 80 | */ |
| 81 | protected ConnectivityIntent(ApplicationId appId, |
| 82 | Key key, |
| 83 | Collection<NetworkResource> resources, |
| 84 | TrafficSelector selector, |
| 85 | TrafficTreatment treatment) { |
| 86 | this(appId, key, resources, selector, treatment, Collections.emptyList()); |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Creates a connectivity intent that matches on the specified selector |
| 91 | * and applies the specified treatment. |
| 92 | * <p> |
| 93 | * Path will be optimized based on the first constraint if one is given. |
| 94 | * </p> |
| 95 | * |
| 96 | * @param appId application identifier |
| 97 | * @param key explicit key to use for intent |
| 98 | * @param resources required network resources (optional) |
| 99 | * @param selector traffic selector |
| 100 | * @param treatment treatment |
| 101 | * @param constraints optional prioritized list of constraints |
| 102 | * @throws NullPointerException if the selector or treatment is null |
| 103 | */ |
| 104 | |
| 105 | protected ConnectivityIntent(ApplicationId appId, |
| 106 | Key key, |
| 107 | Collection<NetworkResource> resources, |
| 108 | TrafficSelector selector, |
| 109 | TrafficTreatment treatment, |
| 110 | List<Constraint> constraints) { |
| 111 | super(appId, key, resources); |
| 112 | this.selector = checkNotNull(selector); |
| 113 | this.treatment = checkNotNull(treatment); |
| 114 | this.constraints = checkNotNull(constraints); |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Creates a connectivity intent that matches on the specified selector |
| 119 | * and applies the specified treatment. |
| 120 | * <p> |
| 121 | * Path will be optimized based on the first constraint if one is given. |
| 122 | * </p> |
| 123 | * |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 124 | * @param appId application identifier |
| 125 | * @param resources required network resources (optional) |
| 126 | * @param selector traffic selector |
| 127 | * @param treatment treatment |
| 128 | * @param constraints optional prioritized list of constraints |
Ray Milkey | e1dfb50 | 2015-01-13 16:35:46 -0800 | [diff] [blame] | 129 | * @throws NullPointerException if the selector or treatment is null |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 130 | */ |
Ray Milkey | 5b3717e | 2015-02-05 11:44:08 -0800 | [diff] [blame] | 131 | |
Brian O'Connor | 520c052 | 2014-11-23 23:50:47 -0800 | [diff] [blame] | 132 | protected ConnectivityIntent(ApplicationId appId, |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 133 | Collection<NetworkResource> resources, |
| 134 | TrafficSelector selector, |
| 135 | TrafficTreatment treatment, |
| 136 | List<Constraint> constraints) { |
Ray Milkey | 5b3717e | 2015-02-05 11:44:08 -0800 | [diff] [blame] | 137 | super(appId, null, resources); |
tom | a1d16b6 | 2014-10-02 23:45:11 -0700 | [diff] [blame] | 138 | this.selector = checkNotNull(selector); |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 139 | this.treatment = checkNotNull(treatment); |
Sho SHIMIZU | c3df36b | 2014-11-11 18:19:29 -0800 | [diff] [blame] | 140 | this.constraints = checkNotNull(constraints); |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 141 | } |
| 142 | |
| 143 | /** |
| 144 | * Constructor for serializer. |
| 145 | */ |
| 146 | protected ConnectivityIntent() { |
| 147 | super(); |
| 148 | this.selector = null; |
| 149 | this.treatment = null; |
Sho SHIMIZU | c3df36b | 2014-11-11 18:19:29 -0800 | [diff] [blame] | 150 | this.constraints = Collections.emptyList(); |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | /** |
| 154 | * Returns the match specifying the type of traffic. |
| 155 | * |
| 156 | * @return traffic match |
| 157 | */ |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 158 | public TrafficSelector selector() { |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 159 | return selector; |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Returns the action applied to the traffic. |
| 164 | * |
| 165 | * @return applied action |
| 166 | */ |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 167 | public TrafficTreatment treatment() { |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 168 | return treatment; |
| 169 | } |
| 170 | |
Thomas Vachuska | e291c84 | 2014-10-21 02:52:38 -0700 | [diff] [blame] | 171 | /** |
Thomas Vachuska | edc944c | 2014-11-04 15:42:25 -0800 | [diff] [blame] | 172 | * Returns the set of connectivity constraints. |
| 173 | * |
| 174 | * @return list of intent constraints |
| 175 | */ |
| 176 | public List<Constraint> constraints() { |
| 177 | return constraints; |
| 178 | } |
| 179 | |
| 180 | /** |
Thomas Vachuska | e291c84 | 2014-10-21 02:52:38 -0700 | [diff] [blame] | 181 | * Produces a collection of network resources from the given links. |
| 182 | * |
| 183 | * @param links collection of links |
| 184 | * @return collection of link resources |
| 185 | */ |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 186 | protected static Collection<NetworkResource> resources(Collection<Link> links) { |
Sho SHIMIZU | f4dbc726 | 2014-11-04 18:49:02 -0800 | [diff] [blame] | 187 | return ImmutableSet.copyOf(links); |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 188 | } |
| 189 | |
| 190 | } |