bug fixes and cosmetic changes about OpticalPathProvisioner:

- removeSink() at deactivate
- added log messages
- wrapped null return value with Optional

Change-Id: Ic5361df3cf82f99af315b2551d33bb84aed241ed

@@ -31,6 +31,9 @@ import org.onosproject.cluster.ClusterService;
 import org.onosproject.cluster.NodeId;
 import org.onosproject.cluster.NodeId;
 import org.onosproject.core.ApplicationId;
 import org.onosproject.core.ApplicationId;
 import org.onosproject.core.CoreService;
 import org.onosproject.core.CoreService;
+import org.onosproject.event.ListenerTracker;
+import org.onosproject.net.optical.OchPort;
+import org.onosproject.net.optical.OduCltPort;
 import org.onosproject.newoptical.api.OpticalConnectivityId;
 import org.onosproject.newoptical.api.OpticalConnectivityId;
 import org.onosproject.newoptical.api.OpticalPathEvent;
 import org.onosproject.newoptical.api.OpticalPathEvent;
 import org.onosproject.newoptical.api.OpticalPathListener;
 import org.onosproject.newoptical.api.OpticalPathListener;
@@ -42,8 +45,6 @@ import org.onosproject.net.ConnectPoint;
 import org.onosproject.net.Device;
 import org.onosproject.net.Device;
 import org.onosproject.net.DeviceId;
 import org.onosproject.net.DeviceId;
 import org.onosproject.net.Link;
 import org.onosproject.net.Link;
-import org.onosproject.net.OchPort;
-import org.onosproject.net.OduCltPort;
 import org.onosproject.net.OduSignalType;
 import org.onosproject.net.OduSignalType;
 import org.onosproject.net.Path;
 import org.onosproject.net.Path;
 import org.onosproject.net.Port;
 import org.onosproject.net.Port;
@@ -138,8 +139,7 @@ public class OpticalPathProvisioner
 
 
     private AtomicCounter idCounter;
     private AtomicCounter idCounter;
 
 
-    private LinkListener linkListener = new InternalLinkListener();
-    private IntentListener intentListener = new InternalIntentListener();
+    private ListenerTracker listeners;
 
 
     private Map<PacketLinkRealizedByOptical, OpticalConnectivity> linkPathMap = new ConcurrentHashMap<>();
     private Map<PacketLinkRealizedByOptical, OpticalConnectivity> linkPathMap = new ConcurrentHashMap<>();
 
 
@@ -161,16 +161,18 @@ public class OpticalPathProvisioner
                 .asAtomicCounter();
                 .asAtomicCounter();
 
 
         eventDispatcher.addSink(OpticalPathEvent.class, listenerRegistry);
         eventDispatcher.addSink(OpticalPathEvent.class, listenerRegistry);
-        linkService.addListener(linkListener);
-        intentService.addListener(intentListener);
+
+        listeners = new ListenerTracker();
+        listeners.addListener(linkService, new InternalLinkListener())
+                .addListener(intentService, new InternalIntentListener());
 
 
         log.info("Started");
         log.info("Started");
     }
     }
 
 
     @Deactivate
     @Deactivate
     protected void deactivate() {
     protected void deactivate() {
-        intentService.removeListener(intentListener);
-        linkService.removeListener(linkListener);
+        listeners.removeListeners();
+        eventDispatcher.removeSink(OpticalPathEvent.class);
 
 
         log.info("Stopped");
         log.info("Stopped");
     }
     }
@@ -200,6 +202,8 @@ public class OpticalPathProvisioner
             }
             }
         }
         }
 
 
+        log.info("setupConnectivity({}, {}, {}, {}) failed.", ingress, egress, bandwidth, latency);
+
         return null;
         return null;
     }
     }
 
 
@@ -212,6 +216,7 @@ public class OpticalPathProvisioner
         List<Pair<ConnectPoint, ConnectPoint>> xcPointPairs = getCrossConnectPoints(path);
         List<Pair<ConnectPoint, ConnectPoint>> xcPointPairs = getCrossConnectPoints(path);
         if (!checkXcPoints(xcPointPairs)) {
         if (!checkXcPoints(xcPointPairs)) {
             // Can't setup path if cross connect points are mismatched
             // Can't setup path if cross connect points are mismatched
+            log.error("Failed to setup path because of mismatched cross connect points.");
             return null;
             return null;
         }
         }
 
 
@@ -261,6 +266,7 @@ public class OpticalPathProvisioner
         OpticalConnectivity connectivity = connectivities.remove(id);
         OpticalConnectivity connectivity = connectivities.remove(id);
 
 
         if (connectivity == null) {
         if (connectivity == null) {
+            log.info("OpticalConnectivity with id {} not found.", id);
             return false;
             return false;
         }
         }
 
 
@@ -274,13 +280,14 @@ public class OpticalPathProvisioner
     }
     }
 
 
     @Override
     @Override
-    public List<Link> getPath(OpticalConnectivityId id) {
+    public Optional<List<Link>> getPath(OpticalConnectivityId id) {
         OpticalConnectivity connectivity = connectivities.get(id);
         OpticalConnectivity connectivity = connectivities.get(id);
         if (connectivity == null) {
         if (connectivity == null) {
-            return null;
+            log.info("OpticalConnectivity with id {} not found.", id);
+            return Optional.empty();
         }
         }
 
 
-        return ImmutableList.copyOf(connectivity.links());
+        return Optional.of(ImmutableList.copyOf(connectivity.links()));
     }
     }
 
 
     /**
     /**
@@ -337,7 +344,7 @@ public class OpticalPathProvisioner
 
 
             // Only support connections between identical port types
             // Only support connections between identical port types
             if (srcType != dstType) {
             if (srcType != dstType) {
-                log.warn("Unsupported mix of cross connect points");
+                log.warn("Unsupported mix of cross connect points : {}, {}", srcType, dstType);
                 return false;
                 return false;
             }
             }
         }
         }
@@ -516,12 +523,12 @@ public class OpticalPathProvisioner
         public double weight(TopologyEdge edge) {
         public double weight(TopologyEdge edge) {
             Link l = edge.link();
             Link l = edge.link();
 
 
-            // Ignore inactive links
+            // Avoid inactive links
             if (l.state() == Link.State.INACTIVE) {
             if (l.state() == Link.State.INACTIVE) {
                 return -1.0;
                 return -1.0;
             }
             }
 
 
-            // Ignore cross connect links with used ports
+            // Avoid cross connect links with used ports
             if (isCrossConnectLink(l) && usedCrossConnectLinks.contains(l)) {
             if (isCrossConnectLink(l) && usedCrossConnectLinks.contains(l)) {
                 return -1.0;
                 return -1.0;
             }
             }

@@ -24,6 +24,7 @@ import org.onosproject.net.Path;
 
 
 import java.time.Duration;
 import java.time.Duration;
 import java.util.List;
 import java.util.List;
+import java.util.Optional;
 
 
 /**
 /**
  * Service to setup optical domain connectivity.
  * Service to setup optical domain connectivity.
@@ -64,7 +65,7 @@ public interface OpticalPathService extends ListenerService<OpticalPathEvent, Op
     /**
     /**
      * Returns path assigned to given ID.
      * Returns path assigned to given ID.
      * @param id ID of connectivity
      * @param id ID of connectivity
-     * @return list of link that compose a path. null if ID is invalid.
+     * @return list of link that compose a path. empty if ID is invalid.
      */
      */
-    List<Link> getPath(OpticalConnectivityId id);
+    Optional<List<Link>> getPath(OpticalConnectivityId id);
 }
 }