gerrit.opnfv Code Review - onosfw.git/blob

   1 /*
   2  * Copyright 2014 Open Networking Laboratory
   3  *
   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
   7  *
   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.
  15  */
  16 package org.onosproject.net.intent.constraint;
  17
  18 import com.google.common.annotations.Beta;
  19
  20 import org.onlab.util.DataRateUnit;
  21 import org.onosproject.net.Link;
  22 import org.onosproject.net.resource.link.BandwidthResource;
  23 import org.onosproject.net.resource.link.BandwidthResourceRequest;
  24 import org.onosproject.net.resource.link.LinkResourceService;
  25 import org.onosproject.net.resource.ResourceRequest;
  26 import org.onosproject.net.resource.ResourceType;
  27
  28 import java.util.Objects;
  29
  30 import static com.google.common.base.MoreObjects.toStringHelper;
  31 import static com.google.common.base.Preconditions.checkNotNull;
  32
  33 /**
  34  * Constraint that evaluates links based on available bandwidths.
  35  */
  36 @Beta
  37 public final class BandwidthConstraint extends BooleanConstraint {
  38
  39     private final BandwidthResource bandwidth;
  40
  41     /**
  42      * Creates a new bandwidth constraint.
  43      *
  44      * @param bandwidth required bandwidth
  45      */
  46     public BandwidthConstraint(BandwidthResource bandwidth) {
  47         this.bandwidth = checkNotNull(bandwidth, "Bandwidth cannot be null");
  48     }
  49
  50     /**
  51      * Creates a new bandwidth constraint.
  52      *
  53      * @param v         required amount of bandwidth
  54      * @param unit      {@link DataRateUnit} of {@code v}
  55      * @return  {@link BandwidthConstraint} instance with given bandwidth requirement
  56      */
  57     public static BandwidthConstraint of(double v, DataRateUnit unit) {
  58         return new BandwidthConstraint(BandwidthResource.of(v, unit));
  59     }
  60
  61     // Constructor for serialization
  62     private BandwidthConstraint() {
  63         this.bandwidth = null;
  64     }
  65
  66     @Override
  67     public boolean isValid(Link link, LinkResourceService resourceService) {
  68         for (ResourceRequest request : resourceService.getAvailableResources(link)) {
  69             if (request.type() == ResourceType.BANDWIDTH) {
  70                 BandwidthResourceRequest brr = (BandwidthResourceRequest) request;
  71                 if (brr.bandwidth().toDouble() >= bandwidth.toDouble()) {
  72                     return true;
  73                 }
  74             }
  75         }
  76         return false;
  77     }
  78
  79     /**
  80      * Returns the bandwidth required by this constraint.
  81      *
  82      * @return required bandwidth
  83      */
  84     public BandwidthResource bandwidth() {
  85         return bandwidth;
  86     }
  87
  88     @Override
  89     public int hashCode() {
  90         return bandwidth.hashCode();
  91     }
  92
  93     @Override
  94     public boolean equals(Object obj) {
  95         if (this == obj) {
  96             return true;
  97         }
  98         if (obj == null || getClass() != obj.getClass()) {
  99             return false;
 100         }
 101         final BandwidthConstraint other = (BandwidthConstraint) obj;
 102         return Objects.equals(this.bandwidth, other.bandwidth);
 103     }
 104
 105     @Override
 106     public String toString() {
 107         return toStringHelper(this).add("bandwidth", bandwidth).toString();
 108     }
 109 }