ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60

Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd

1 files changed, 113 insertions, 0 deletions

diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/intent/constraint/AnnotationConstraint.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/intent/constraint/AnnotationConstraint.java
new file mode 100644
index 00000000..f5439efd
--- /dev/null
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/intent/constraint/AnnotationConstraint.java
@@ -0,0 +1,113 @@
+/*
+ * Copyright 2014 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.constraint;
+
+import com.google.common.annotations.Beta;
+import com.google.common.base.MoreObjects;
+import org.onosproject.net.Link;
+import org.onosproject.net.resource.link.LinkResourceService;
+
+import java.util.Objects;
+
+import static org.onosproject.net.AnnotationKeys.getAnnotatedValue;
+
+/**
+ * Constraint that evaluates an arbitrary link annotated value is under the specified threshold.
+ */
+@Beta
+public class AnnotationConstraint extends BooleanConstraint {
+
+    private final String key;
+    private final double threshold;
+
+    /**
+     * Creates a new constraint to keep the value for the specified key
+     * of link annotation under the threshold.
+     *
+     * @param key key of link annotation
+     * @param threshold threshold value of the specified link annotation
+     */
+    public AnnotationConstraint(String key, double threshold) {
+        this.key = key;
+        this.threshold = threshold;
+    }
+
+    // Constructor for serialization
+    private AnnotationConstraint() {
+        this.key = "";
+        this.threshold = 0;
+    }
+
+    /**
+     * Returns the key of link annotation this constraint designates.
+     * @return key of link annotation
+     */
+    public String key() {
+        return key;
+    }
+
+    /**
+     * Returns the threshold this constraint ensures as link annotated value.
+     *
+     * @return threshold as link annotated value
+     */
+    public double threshold() {
+        return threshold;
+    }
+
+    @Override
+    public boolean isValid(Link link, LinkResourceService resourceService) {
+        double value = getAnnotatedValue(link, key);
+
+        return value <= threshold;
+    }
+
+    @Override
+    public double cost(Link link, LinkResourceService resourceService) {
+        if (isValid(link, resourceService)) {
+            return getAnnotatedValue(link, key);
+        } else {
+            return -1;
+        }
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(key, threshold);
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+
+        if (!(obj instanceof AnnotationConstraint)) {
+            return false;
+        }
+
+        final AnnotationConstraint other = (AnnotationConstraint) obj;
+        return Objects.equals(this.key, other.key) && Objects.equals(this.threshold, other.threshold);
+    }
+
+    @Override
+    public String toString() {
+        return MoreObjects.toStringHelper(this)
+                .add("key", key)
+                .add("threshold", threshold)
+                .toString();
+    }
+}