Use builders when available. Harmonized CE packet node service API.

Change-Id: Ibf5e7de179eed122397ede63789d749520112926

Author: Marc De Leenheer

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/api/CarrierEthernetPacketNodeService.java

@@ -57,10 +57,10 @@ void setNodeForwarding(CarrierEthernetForwardingConstruct fc, CarrierEthernetNet
     /**
      * Removes the meters associated with a specific UNI of an FC.
      *
-     * @param fcId the forwarding construct id
+     * @param fc the forwarding construct
      * @param uni the user to network interface
      */
-    void removeBandwidthProfileResources(String fcId, CarrierEthernetUni uni);
+    void removeBandwidthProfileResources(CarrierEthernetForwardingConstruct fc, CarrierEthernetUni uni);
 
     /**
      * Removes all installed flow objectives associated with a specific FC.

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/app/CarrierEthernetBandwidthProfile.java

@@ -24,7 +24,7 @@
  * Bandwidth profile for a CE UNI.
  */
 // TODO: Methods to associate a CE BWP to a generic BWP and a Meter
-public class CarrierEthernetBandwidthProfile {
+public final class CarrierEthernetBandwidthProfile {
 
     public enum Type {
         INTERFACE, EVC, COS
@@ -39,9 +39,7 @@ public enum Type {
     protected long ebs;
 
     // TODO: Remove id from constructor - should be generated by some manager
-    // TODO: Make constructor private when SCA/NRP API apps are migrated
-    @Deprecated
-    public CarrierEthernetBandwidthProfile(String id, String cfgId, Type type,
+    private CarrierEthernetBandwidthProfile(String id, String cfgId, Type type,
                                             Bandwidth cir, Bandwidth eir,
                                             long cbs, long ebs) {
         checkNotNull(cir, "BW Profile must have an associated CIR");
@@ -255,14 +253,12 @@ public Builder ebs(long ebs) {
         }
 
         /**
-         * Builds a new CarrierEthernetBandwidthProfile instance.
-         * based on this builder's parameters
+         * Builds a new CarrierEthernetBandwidthProfile instance based on this builder's parameters.
          *
          * @return a new CarrierEthernetBandwidthProfile instance
          */
         public CarrierEthernetBandwidthProfile build() {
-            return new CarrierEthernetBandwidthProfile(id, cfgId, type,
-                                                       cir, eir, cbs, ebs);
+            return new CarrierEthernetBandwidthProfile(id, cfgId, type, cir, eir, cbs, ebs);
         }
     }
 }

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/app/CarrierEthernetEnni.java

@@ -21,19 +21,18 @@
 import org.onosproject.net.ConnectPoint;
 import org.slf4j.Logger;
 
+import java.util.Set;
 
 import static com.google.common.base.MoreObjects.toStringHelper;
 import static org.slf4j.LoggerFactory.getLogger;
 
-import java.util.Set;
-
 /**
  * Representation of a Carrier Ethernet ENNI.
  * Class can be used in different two ways:
  * 1. As a global ENNI descriptor containing one or more S-VLAN tags
  * 2. As a service-specific ENNI descriptor containing a single S-VLAN tag and including a role (e.g. hub, spoke)
  */
-public class CarrierEthernetEnni extends CarrierEthernetNetworkInterface<CarrierEthernetEnni> {
+public final class CarrierEthernetEnni extends CarrierEthernetNetworkInterface<CarrierEthernetEnni> {
 
     private final Logger log = getLogger(getClass());
 
@@ -61,9 +60,7 @@ public String toString() {
     protected Set<VlanId> sVlanIdSet;
     String tpid;
 
-    // TODO: Make constructor private when SCA/NRP API apps are migrated
-    @Deprecated
-    public CarrierEthernetEnni(ConnectPoint cp, String uniCfgId,
+    private CarrierEthernetEnni(ConnectPoint cp, String uniCfgId,
                                 Role role, VlanId sVlanId, String tpid,
                                 Bandwidth usedCapacity) {
         super(cp, Type.ENNI, uniCfgId);
@@ -307,8 +304,7 @@ public Builder usedCapacity(Bandwidth usedCapacity) {
          * @return a new CarrierEthernetEnni instance
          */
         public CarrierEthernetEnni build() {
-            return new CarrierEthernetEnni(cp, cfgId, role,
-                                           sVlanId, tpid, usedCapacity);
+            return new CarrierEthernetEnni(cp, cfgId, role, sVlanId, tpid, usedCapacity);
         }
     }
 }

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/app/CarrierEthernetForwardingConstruct.java

@@ -32,7 +32,7 @@
 /**
  * Representation of a CE Forwarding Construct.
  */
-public class CarrierEthernetForwardingConstruct extends CarrierEthernetConnection {
+public final class CarrierEthernetForwardingConstruct extends CarrierEthernetConnection {
 
     private Set<CarrierEthernetLogicalTerminationPoint> ltpSet;
     private VlanId vlanId;
@@ -42,9 +42,7 @@ public class CarrierEthernetForwardingConstruct extends CarrierEthernetConnectio
 
     // TODO: Remove id from constructor - currently used only when updating FC
     // TODO: Add congruentPaths flag to constructor and Builder
-    // TODO: Make constructor private when SCA/NRP API apps are migrated
-    @Deprecated
-    public CarrierEthernetForwardingConstruct(String id, String cfgId, Type type,
+    private CarrierEthernetForwardingConstruct(String id, String cfgId, Type type,
                                               Set<CarrierEthernetLogicalTerminationPoint> ltpSet,
                                               Duration maxLatency) {
         super(id, cfgId, type, maxLatency);
@@ -179,7 +177,6 @@ public static final class Builder {
         private Type type;
         private Duration maxLatency;
         private Set<CarrierEthernetLogicalTerminationPoint> ltpSet;
-        private boolean congruentPaths;
 
         /**
          * Sets the id of this builder.
@@ -246,8 +243,8 @@ public CarrierEthernetForwardingConstruct build() {
             checkNotNull(type, "FC must have a type");
             checkArgument(ltpSet != null && ltpSet.size() > 1,
                           "FC must include at least two LTPs");
-            return new CarrierEthernetForwardingConstruct(id, cfgId, type,
-                                                          ltpSet, maxLatency);
+
+            return new CarrierEthernetForwardingConstruct(id, cfgId, type, ltpSet, maxLatency);
         }
     }
 }

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/app/CarrierEthernetInni.java

@@ -22,19 +22,18 @@
 import org.onosproject.net.ConnectPoint;
 import org.slf4j.Logger;
 
+import java.util.Set;
 
 import static com.google.common.base.MoreObjects.toStringHelper;
 import static org.slf4j.LoggerFactory.getLogger;
 
-import java.util.Set;
-
 /**
  * Representation of a Carrier Ethernet INNI.
  * Class can be used in different two ways:
  * 1. As a global INNI descriptor containing one or more S-VLAN tags
  * 2. As a service-specific INNI descriptor containing a single S-VLAN tag and including a role (e.g. hub, spoke)
  */
-public class CarrierEthernetInni extends CarrierEthernetNetworkInterface<CarrierEthernetInni> {
+public final class CarrierEthernetInni extends CarrierEthernetNetworkInterface<CarrierEthernetInni> {
 
     private final Logger log = getLogger(getClass());
 
@@ -66,9 +65,7 @@ public String toString() {
     protected String tpid;
 
     // TODO: Change sVlanId to Collection<VlanId>
-    // TODO: Make constructor private when SCA/NRP API apps are migrated
-    @Deprecated
-    public CarrierEthernetInni(ConnectPoint connectPoint, String uniCfgId,
+    private CarrierEthernetInni(ConnectPoint connectPoint, String uniCfgId,
                                Role role, VlanId sVlanId, String tpid,
                                Bandwidth usedCapacity) {
 
@@ -313,8 +310,7 @@ public Builder usedCapacity(Bandwidth usedCapacity) {
          * @return a new CarrierEthernetInni instance
          */
         public CarrierEthernetInni build() {
-            return new CarrierEthernetInni(cp, cfgId, role,
-                                          sVlanId, tpid, usedCapacity);
+            return new CarrierEthernetInni(cp, cfgId, role, sVlanId, tpid, usedCapacity);
         }
     }
 }

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/app/CarrierEthernetManager.java

@@ -992,7 +992,10 @@ public CarrierEthernetUni generateUni(ConnectPoint cp) {
             return null;
         }
 
-        return new CarrierEthernetUni(cp, uniId);
+        return CarrierEthernetUni.builder()
+                .cp(cp)
+                .cfgId(uniId)
+                .build();
     }
 
     @Override

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/app/CarrierEthernetPacketNodeManager.java

@@ -413,19 +413,19 @@ private FlowRule addMetersToFlowRule(FlowRule flowRule, Set<DeviceMeterId> devic
     }
 
     @Override
-    public void removeBandwidthProfileResources(String fcId, CarrierEthernetUni uni) {
-        removeMeters(fcId, uni);
+    public void removeBandwidthProfileResources(CarrierEthernetForwardingConstruct fc, CarrierEthernetUni uni) {
+        removeMeters(fc, uni);
     }
 
     /**
      * Removes the meters associated with a specific UNI of an FC.
      *
-     * @param fcId the EVC ID
+     * @param fc the forwarding construct
      * @param uni the UNI descriptor
      * */
-    private void removeMeters(String fcId, CarrierEthernetUni uni) {
+    private void removeMeters(CarrierEthernetForwardingConstruct fc, CarrierEthernetUni uni) {
 
-        Set<DeviceMeterId> newDeviceMeterIdSet = deviceMeterIdMap.get(fcId);
+        Set<DeviceMeterId> newDeviceMeterIdSet = deviceMeterIdMap.get(fc.id());
         DeviceMeterId tmpDeviceMeterId;
 
         Collection<Meter> meters = meterService.getMeters(uni.cp().deviceId());
@@ -435,7 +435,7 @@ private void removeMeters(String fcId, CarrierEthernetUni uni) {
             Meter meter = it.next();
             tmpDeviceMeterId = new DeviceMeterId(uni.cp().deviceId(), meter.id());
             if (meter.appId().equals(appId) &&
-                    deviceMeterIdMap.get(fcId).contains(tmpDeviceMeterId)) {
+                    deviceMeterIdMap.get(fc.id()).contains(tmpDeviceMeterId)) {
                 MeterRequest.Builder mBuilder;
                 mBuilder = DefaultMeterRequest.builder()
                         .fromApp(meter.appId())
@@ -450,7 +450,7 @@ private void removeMeters(String fcId, CarrierEthernetUni uni) {
             }
         }
 
-        deviceMeterIdMap.put(fcId, newDeviceMeterIdSet);
+        deviceMeterIdMap.put(fc.id(), newDeviceMeterIdSet);
     }
 
     @Override

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/app/CarrierEthernetProvisioner.java

@@ -53,8 +53,11 @@
 
 import static org.slf4j.LoggerFactory.getLogger;
 
+/**
+ * Carrier Ethernet provisioner of connectivity for forwarding constructs and bandwidth profiles.
+ */
 @Component(immediate = true)
-@Service ()
+@Service
 public class CarrierEthernetProvisioner implements CarrierEthernetProvisionerService {
 
     private final Logger log = getLogger(getClass());
@@ -350,7 +353,7 @@ public void removeBandwidthProfiles(CarrierEthernetForwardingConstruct fc) {
         //  TODO: Select node manager depending on device protocol
         fc.ltpSet().forEach((ltp -> {
             if (ltp.ni().type().equals(CarrierEthernetNetworkInterface.Type.UNI)) {
-                cePktNodeService.removeBandwidthProfileResources(fc.id(), (CarrierEthernetUni) ltp.ni());
+                cePktNodeService.removeBandwidthProfileResources(fc, (CarrierEthernetUni) ltp.ni());
             }
         }));
     }

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/app/CarrierEthernetUni.java

@@ -22,23 +22,22 @@
 import org.onosproject.net.ConnectPoint;
 import org.slf4j.Logger;
 
-
-import static com.google.common.base.MoreObjects.toStringHelper;
-import static org.slf4j.LoggerFactory.getLogger;
-
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Set;
 
+import static com.google.common.base.MoreObjects.toStringHelper;
+import static org.slf4j.LoggerFactory.getLogger;
+
 /**
  * Representation of a Carrier Ethernet UNI.
  * Class can be used in different two ways:
  * 1. As a global UNI descriptor containing one or more BW profiles
  * 2. As a service-specific UNI descriptor containing a single BW profile and including a type (root, leaf)
  */
-public class CarrierEthernetUni extends CarrierEthernetNetworkInterface<CarrierEthernetUni> {
+public final class CarrierEthernetUni extends CarrierEthernetNetworkInterface<CarrierEthernetUni> {
 
     private final Logger log = getLogger(getClass());
 
@@ -68,9 +67,7 @@ public String toString() {
 
     // TODO: May be needed to add refCount for CoS BWPs - only applicable to global UNIs
     // TODO: Change ceVlanId to Collection<VlanId>
-    // TODO: Make constructor private when SCA/NRP API apps are migrated
-    @Deprecated
-    public CarrierEthernetUni(ConnectPoint cp, String uniCfgId, Role role,
+    private CarrierEthernetUni(ConnectPoint cp, String uniCfgId, Role role,
                                VlanId ceVlanId,
                                CarrierEthernetBandwidthProfile bwp) {
         super(cp, Type.UNI, uniCfgId);
@@ -104,14 +101,6 @@ public CarrierEthernetUni(ConnectPoint cp, String uniCfgId, Role role,
         }
     }
 
-    public CarrierEthernetUni(ConnectPoint cp, String uniCfgId) {
-        super(cp, Type.UNI, uniCfgId);
-        this.scope = Scope.GLOBAL;
-        for (CarrierEthernetBandwidthProfile.Type bwpType : CarrierEthernetBandwidthProfile.Type.values()) {
-            this.bwpMap.put(bwpType, new HashMap<>());
-        }
-    }
-
     /**
      * Adds a BW profile to a UNI.
      *

carrierethernet/src/main/java/org/onosproject/ecord/carrierethernet/app/CarrierEthernetVirtualConnection.java

@@ -28,7 +28,7 @@
 /**
  * Representation of a Carrier Ethernet EVC.
  */
-public class CarrierEthernetVirtualConnection extends CarrierEthernetConnection {
+public final class CarrierEthernetVirtualConnection extends CarrierEthernetConnection {
 
     private Short shortId;
     private Set<CarrierEthernetUni> uniSet;
@@ -40,9 +40,7 @@ public class CarrierEthernetVirtualConnection extends CarrierEthernetConnection
     public static final Integer MAX_NUM_UNI = 1000;
 
     // TODO: Remove id from constructor - currently used only when updating EVC
-    // TODO: Make constructor private when SCA/NRP API apps are migrated
-    @Deprecated
-    public CarrierEthernetVirtualConnection(String id, String cfgId, Type type,
+    private CarrierEthernetVirtualConnection(String id, String cfgId, Type type,
                                             Integer maxNumUni,
                                             Set<CarrierEthernetUni> uniSet,
                                             Duration maxLatency) {
@@ -245,9 +243,7 @@ public CarrierEthernetVirtualConnection build() {
             checkNotNull(type, "EVC must have a type");
             checkArgument(uniSet != null && uniSet.size() > 1,
                           "EVC must include at least two UNIs");
-            return new CarrierEthernetVirtualConnection(id, cfgId, type,
-                                                        maxNumUni, uniSet,
-                                                        maxLatency);
+            return new CarrierEthernetVirtualConnection(id, cfgId, type, maxNumUni, uniSet, maxLatency);
         }
     }
 }