diff options
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/intent/SinglePointToMultiPointIntent.java')
| -rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/intent/SinglePointToMultiPointIntent.java | 219 |
1 files changed, 219 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/intent/SinglePointToMultiPointIntent.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/intent/SinglePointToMultiPointIntent.java new file mode 100644 index 00000000..de555cf0 --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/intent/SinglePointToMultiPointIntent.java @@ -0,0 +1,219 @@ +/* + * Copyright 2014-2015 Open Networking Laboratory + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.onosproject.net.intent; + +import com.google.common.annotations.Beta; +import com.google.common.base.MoreObjects; +import com.google.common.collect.ImmutableSet; + +import org.onosproject.core.ApplicationId; +import org.onosproject.net.ConnectPoint; +import org.onosproject.net.flow.TrafficSelector; +import org.onosproject.net.flow.TrafficTreatment; + +import java.util.Collections; +import java.util.Set; +import java.util.List; + +import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.base.Preconditions.checkNotNull; + +/** + * Abstraction of single source, multiple destination connectivity intent. + */ +@Beta +public final class SinglePointToMultiPointIntent extends ConnectivityIntent { + + private final ConnectPoint ingressPoint; + private final Set<ConnectPoint> egressPoints; + + /** + * Creates a new single-to-multi point connectivity intent. + * + * @param appId application identifier + * @param key intent key + * @param selector traffic selector + * @param treatment treatment + * @param ingressPoint port on which traffic will ingress + * @param egressPoints set of ports on which traffic will egress + * @param constraints constraints to apply to the intent + * @param priority priority to use for flows generated by this intent + * @throws NullPointerException if {@code ingressPoint} or + * {@code egressPoints} is null + * @throws IllegalArgumentException if the size of {@code egressPoints} is + * not more than 1 + */ + private SinglePointToMultiPointIntent(ApplicationId appId, + Key key, + TrafficSelector selector, TrafficTreatment treatment, + ConnectPoint ingressPoint, Set<ConnectPoint> egressPoints, + List<Constraint> constraints, + int priority) { + super(appId, key, Collections.emptyList(), selector, treatment, constraints, + priority); + checkNotNull(egressPoints); + checkNotNull(ingressPoint); + checkArgument(!egressPoints.isEmpty(), "Egress point set cannot be empty"); + checkArgument(!egressPoints.contains(ingressPoint), + "Set of egresses should not contain ingress (ingress: %s)", ingressPoint); + + this.ingressPoint = checkNotNull(ingressPoint); + this.egressPoints = egressPoints; + } + + /** + * Returns a new single point to multi point intent builder. The application id, + * ingress point and egress points are required fields. If they are + * not set by calls to the appropriate methods, an exception will + * be thrown. + * + * @return single point to multi point builder + */ + public static Builder builder() { + return new Builder(); + } + + /** + * Builder of a single point to multi point intent. + */ + public static final class Builder extends ConnectivityIntent.Builder { + ConnectPoint ingressPoint; + Set<ConnectPoint> egressPoints; + + private Builder() { + // Hide constructor + } + + @Override + public Builder appId(ApplicationId appId) { + return (Builder) super.appId(appId); + } + + @Override + public Builder key(Key key) { + return (Builder) super.key(key); + } + + @Override + public Builder selector(TrafficSelector selector) { + return (Builder) super.selector(selector); + } + + @Override + public Builder treatment(TrafficTreatment treatment) { + return (Builder) super.treatment(treatment); + } + + @Override + public Builder constraints(List<Constraint> constraints) { + return (Builder) super.constraints(constraints); + } + + @Override + public Builder priority(int priority) { + return (Builder) super.priority(priority); + } + + /** + * Sets the ingress point of the single point to multi point intent + * that will be built. + * + * @param ingressPoint ingress connect point + * @return this builder + */ + public Builder ingressPoint(ConnectPoint ingressPoint) { + this.ingressPoint = ingressPoint; + return this; + } + + /** + * Sets the egress points of the single point to multi point intent + * that will be built. + * + * @param egressPoints egress connect points + * @return this builder + */ + public Builder egressPoints(Set<ConnectPoint> egressPoints) { + this.egressPoints = ImmutableSet.copyOf(egressPoints); + return this; + } + + /** + * Builds a single point to multi point intent from the + * accumulated parameters. + * + * @return point to point intent + */ + public SinglePointToMultiPointIntent build() { + + return new SinglePointToMultiPointIntent( + appId, + key, + selector, + treatment, + ingressPoint, + egressPoints, + constraints, + priority + ); + } + } + + /** + * Constructor for serializer. + */ + protected SinglePointToMultiPointIntent() { + super(); + this.ingressPoint = null; + this.egressPoints = null; + } + + /** + * Returns the port on which the ingress traffic should be connected to the + * egress. + * + * @return ingress port + */ + public ConnectPoint ingressPoint() { + return ingressPoint; + } + + /** + * Returns the set of ports on which the traffic should egress. + * + * @return set of egress ports + */ + public Set<ConnectPoint> egressPoints() { + return egressPoints; + } + + @Override + public String toString() { + return MoreObjects.toStringHelper(getClass()) + .add("id", id()) + .add("key", key()) + .add("appId", appId()) + .add("priority", priority()) + .add("resources", resources()) + .add("selector", selector()) + .add("treatment", treatment()) + .add("ingress", ingressPoint) + .add("egress", egressPoints) + .add("constraints", constraints()) + .toString(); + } + +} |