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.intent; |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 17 | |
Ray Milkey | ebc5d22 | 2015-03-18 15:45:36 -0700 | [diff] [blame] | 18 | import java.util.List; |
| 19 | |
Brian O'Connor | 9476fa1 | 2015-06-25 15:17:17 -0400 | [diff] [blame] | 20 | import com.google.common.annotations.Beta; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 21 | import org.onosproject.core.ApplicationId; |
| 22 | import org.onosproject.net.Link; |
| 23 | import org.onosproject.net.Path; |
| 24 | import org.onosproject.net.flow.TrafficSelector; |
| 25 | import org.onosproject.net.flow.TrafficTreatment; |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 26 | |
Ray Milkey | ebc5d22 | 2015-03-18 15:45:36 -0700 | [diff] [blame] | 27 | import com.google.common.base.MoreObjects; |
| 28 | import com.google.common.base.Predicate; |
| 29 | import com.google.common.collect.Iterables; |
Jonathan Hart | 23b5a76 | 2015-01-26 14:47:33 -0800 | [diff] [blame] | 30 | |
Sho SHIMIZU | 3908fde | 2014-11-19 16:30:22 -0800 | [diff] [blame] | 31 | import static com.google.common.base.Preconditions.checkArgument; |
| 32 | |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 33 | /** |
| 34 | * Abstraction of explicitly path specified connectivity intent. |
| 35 | */ |
Brian O'Connor | 9476fa1 | 2015-06-25 15:17:17 -0400 | [diff] [blame] | 36 | @Beta |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 37 | public class PathIntent extends ConnectivityIntent { |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 38 | |
| 39 | private final Path path; |
| 40 | |
| 41 | /** |
| 42 | * Creates a new point-to-point intent with the supplied ingress/egress |
| 43 | * ports and using the specified explicit path. |
| 44 | * |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 45 | * @param appId application identifier |
| 46 | * @param selector traffic selector |
| 47 | * @param treatment treatment |
| 48 | * @param path traversed links |
Ray Milkey | 460f402 | 2014-11-05 15:41:43 -0800 | [diff] [blame] | 49 | * @param constraints optional list of constraints |
Ray Milkey | c24cde3 | 2015-03-10 18:20:18 -0700 | [diff] [blame] | 50 | * @param priority priority to use for the generated flows |
Ray Milkey | 460f402 | 2014-11-05 15:41:43 -0800 | [diff] [blame] | 51 | * @throws NullPointerException {@code path} is null |
| 52 | */ |
Ray Milkey | ebc5d22 | 2015-03-18 15:45:36 -0700 | [diff] [blame] | 53 | protected PathIntent(ApplicationId appId, |
| 54 | TrafficSelector selector, |
| 55 | TrafficTreatment treatment, |
| 56 | Path path, |
| 57 | List<Constraint> constraints, |
| 58 | int priority) { |
| 59 | super(appId, null, resources(path.links()), selector, treatment, constraints, |
Ray Milkey | c24cde3 | 2015-03-10 18:20:18 -0700 | [diff] [blame] | 60 | priority); |
Sho SHIMIZU | 3908fde | 2014-11-19 16:30:22 -0800 | [diff] [blame] | 61 | PathIntent.validate(path.links()); |
Ray Milkey | 460f402 | 2014-11-05 15:41:43 -0800 | [diff] [blame] | 62 | this.path = path; |
| 63 | } |
| 64 | |
| 65 | /** |
Thomas Vachuska | c96058a | 2014-10-20 23:00:16 -0700 | [diff] [blame] | 66 | * Constructor for serializer. |
| 67 | */ |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 68 | protected PathIntent() { |
| 69 | super(); |
| 70 | this.path = null; |
| 71 | } |
| 72 | |
Ray Milkey | ebc5d22 | 2015-03-18 15:45:36 -0700 | [diff] [blame] | 73 | /** |
| 74 | * Returns a new host to host intent builder. |
| 75 | * |
| 76 | * @return host to host intent builder |
| 77 | */ |
| 78 | public static Builder builder() { |
| 79 | return new Builder(); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Builder of a host to host intent. |
| 84 | */ |
| 85 | public static class Builder extends ConnectivityIntent.Builder { |
| 86 | Path path; |
| 87 | |
| 88 | protected Builder() { |
| 89 | // Hide default constructor |
| 90 | } |
| 91 | |
| 92 | @Override |
| 93 | public Builder appId(ApplicationId appId) { |
| 94 | return (Builder) super.appId(appId); |
| 95 | } |
| 96 | |
| 97 | @Override |
| 98 | public Builder key(Key key) { |
| 99 | return (Builder) super.key(key); |
| 100 | } |
| 101 | |
| 102 | @Override |
| 103 | public Builder selector(TrafficSelector selector) { |
| 104 | return (Builder) super.selector(selector); |
| 105 | } |
| 106 | |
| 107 | @Override |
| 108 | public Builder treatment(TrafficTreatment treatment) { |
| 109 | return (Builder) super.treatment(treatment); |
| 110 | } |
| 111 | |
| 112 | @Override |
| 113 | public Builder constraints(List<Constraint> constraints) { |
| 114 | return (Builder) super.constraints(constraints); |
| 115 | } |
| 116 | |
| 117 | @Override |
| 118 | public Builder priority(int priority) { |
| 119 | return (Builder) super.priority(priority); |
| 120 | } |
| 121 | |
| 122 | /** |
| 123 | * Sets the path of the intent that will be built. |
| 124 | * |
| 125 | * @param path path for the intent |
| 126 | * @return this builder |
| 127 | */ |
| 128 | public Builder path(Path path) { |
| 129 | this.path = path; |
| 130 | return this; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Builds a path intent from the accumulated parameters. |
| 135 | * |
| 136 | * @return point to point intent |
| 137 | */ |
| 138 | public PathIntent build() { |
| 139 | |
| 140 | return new PathIntent( |
| 141 | appId, |
| 142 | selector, |
| 143 | treatment, |
| 144 | path, |
| 145 | constraints, |
| 146 | priority |
| 147 | ); |
| 148 | } |
| 149 | } |
| 150 | |
| 151 | |
| 152 | |
Sho SHIMIZU | 3908fde | 2014-11-19 16:30:22 -0800 | [diff] [blame] | 153 | // NOTE: This methods takes linear time with the number of links. |
| 154 | /** |
| 155 | * Validates that source element ID and destination element ID of a link are |
| 156 | * different for the specified all links and that destination element ID of a link and source |
| 157 | * element ID of the next adjacent source element ID are same for the specified all links. |
| 158 | * |
Sho SHIMIZU | 7338ccc | 2014-11-21 15:00:53 -0800 | [diff] [blame] | 159 | * @param links links to be validated |
Sho SHIMIZU | 3908fde | 2014-11-19 16:30:22 -0800 | [diff] [blame] | 160 | */ |
| 161 | public static void validate(List<Link> links) { |
| 162 | checkArgument(Iterables.all(links, new Predicate<Link>() { |
| 163 | @Override |
| 164 | public boolean apply(Link link) { |
| 165 | return !link.src().elementId().equals(link.dst().elementId()); |
| 166 | } |
| 167 | }), "element of src and dst in a link must be different: {}", links); |
| 168 | |
| 169 | boolean adjacentSame = true; |
| 170 | for (int i = 0; i < links.size() - 1; i++) { |
| 171 | if (!links.get(i).dst().elementId().equals(links.get(i + 1).src().elementId())) { |
| 172 | adjacentSame = false; |
| 173 | break; |
| 174 | } |
| 175 | } |
| 176 | checkArgument(adjacentSame, "adjacent links must share the same element: {}", links); |
| 177 | } |
| 178 | |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 179 | /** |
| 180 | * Returns the links which the traffic goes along. |
| 181 | * |
| 182 | * @return traversed links |
| 183 | */ |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 184 | public Path path() { |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 185 | return path; |
| 186 | } |
| 187 | |
| 188 | @Override |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 189 | public String toString() { |
| 190 | return MoreObjects.toStringHelper(getClass()) |
tom | 85258ee | 2014-10-07 00:10:02 -0700 | [diff] [blame] | 191 | .add("id", id()) |
Thomas Vachuska | e291c84 | 2014-10-21 02:52:38 -0700 | [diff] [blame] | 192 | .add("appId", appId()) |
Ray Milkey | c24cde3 | 2015-03-10 18:20:18 -0700 | [diff] [blame] | 193 | .add("priority", priority()) |
Jonathan Hart | 23b5a76 | 2015-01-26 14:47:33 -0800 | [diff] [blame] | 194 | .add("resources", resources()) |
Thomas Vachuska | e291c84 | 2014-10-21 02:52:38 -0700 | [diff] [blame] | 195 | .add("selector", selector()) |
| 196 | .add("treatment", treatment()) |
Ray Milkey | 460f402 | 2014-11-05 15:41:43 -0800 | [diff] [blame] | 197 | .add("constraints", constraints()) |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 198 | .add("path", path) |
| 199 | .toString(); |
| 200 | } |
tom | 95329eb | 2014-10-06 08:40:06 -0700 | [diff] [blame] | 201 | |
Brian O'Connor | b876bf1 | 2014-10-02 14:59:37 -0700 | [diff] [blame] | 202 | } |