Lambda queries don't rely on driver state, and have separate package.

Lambda query returns unsorted set.

fix for ONOS-3620

Change-Id: Ifffd03271f9c8c02be8897c3891c80148342757e

@@ -21,7 +21,7 @@ import org.onosproject.net.OchSignal;
 import org.onosproject.net.PortNumber;
 import org.onosproject.net.PortNumber;
 import org.onosproject.net.driver.HandlerBehaviour;
 import org.onosproject.net.driver.HandlerBehaviour;
 
 
-import java.util.SortedSet;
+import java.util.Set;
 
 
 /**
 /**
  * A HandlerBehaviour to retrieve available wavelength resources.
  * A HandlerBehaviour to retrieve available wavelength resources.
@@ -29,12 +29,11 @@ import java.util.SortedSet;
 @Beta
 @Beta
 public interface LambdaQuery extends HandlerBehaviour {
 public interface LambdaQuery extends HandlerBehaviour {
 
 
-    // Currently returns set of FLEX GridType ochSignal instances
     /**
     /**
-     * Returns set of Lambda instances which can be used at the port.
+     * Returns set of OchSignal instances which can be used at the port.
      *
      *
      * @param port to be checked for the available resources.
      * @param port to be checked for the available resources.
-     * @return Set of OchSignals which can be used at the port.
+     * @return set of OchSignals which can be used at the port.
      */
      */
-    SortedSet<OchSignal> queryLambdas(PortNumber port);
+    Set<OchSignal> queryLambdas(PortNumber port);
 }
 }

@@ -20,7 +20,6 @@ import com.google.common.collect.Lists;
 import org.onlab.packet.MplsLabel;
 import org.onlab.packet.MplsLabel;
 import org.onlab.packet.VlanId;
 import org.onlab.packet.VlanId;
 import org.onlab.util.ItemNotFoundException;
 import org.onlab.util.ItemNotFoundException;
-import org.onosproject.net.DefaultOchSignalComparator;
 import org.onosproject.net.Device;
 import org.onosproject.net.Device;
 import org.onosproject.net.DeviceId;
 import org.onosproject.net.DeviceId;
 import org.onosproject.net.Port;
 import org.onosproject.net.Port;
@@ -46,7 +45,6 @@ import org.slf4j.LoggerFactory;
 import java.util.Collections;
 import java.util.Collections;
 import java.util.List;
 import java.util.List;
 import java.util.Set;
 import java.util.Set;
-import java.util.SortedSet;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.ExecutorService;
 import java.util.stream.Collectors;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 import java.util.stream.IntStream;
@@ -150,7 +148,7 @@ final class ResourceDeviceListener implements DeviceListener {
             }
             }
 
 
             // for Lambdas
             // for Lambdas
-            SortedSet<OchSignal> lambdas = queryLambdas(device.id(), port.number());
+            Set<OchSignal> lambdas = queryLambdas(device.id(), port.number());
             if (!lambdas.isEmpty()) {
             if (!lambdas.isEmpty()) {
                 adminService.registerResources(lambdas.stream()
                 adminService.registerResources(lambdas.stream()
                                                .map(portPath::child)
                                                .map(portPath::child)
@@ -188,28 +186,28 @@ final class ResourceDeviceListener implements DeviceListener {
         executor.submit(() -> adminService.unregisterResources(resource));
         executor.submit(() -> adminService.unregisterResources(resource));
     }
     }
 
 
-    private SortedSet<OchSignal> queryLambdas(DeviceId did, PortNumber port) {
+    private Set<OchSignal> queryLambdas(DeviceId did, PortNumber port) {
         try {
         try {
             // DriverHandler does not provide a way to check if a
             // DriverHandler does not provide a way to check if a
             // behaviour is supported.
             // behaviour is supported.
             Driver driver = driverService.getDriver(did);
             Driver driver = driverService.getDriver(did);
             if (driver == null || !driver.hasBehaviour(LambdaQuery.class)) {
             if (driver == null || !driver.hasBehaviour(LambdaQuery.class)) {
-                return Collections.emptySortedSet();
+                return Collections.emptySet();
             }
             }
             DriverHandler handler = driverService.createHandler(did);
             DriverHandler handler = driverService.createHandler(did);
             if (handler == null) {
             if (handler == null) {
-                return Collections.emptySortedSet();
+                return Collections.emptySet();
             }
             }
             LambdaQuery query = handler.behaviour(LambdaQuery.class);
             LambdaQuery query = handler.behaviour(LambdaQuery.class);
             if (query != null) {
             if (query != null) {
                 return query.queryLambdas(port).stream()
                 return query.queryLambdas(port).stream()
                         .flatMap(x -> OchSignal.toFlexGrid(x).stream())
                         .flatMap(x -> OchSignal.toFlexGrid(x).stream())
-                        .collect(Collectors.toCollection(DefaultOchSignalComparator::newOchSignalTreeSet));
+                        .collect(Collectors.toSet());
             } else {
             } else {
-                return Collections.emptySortedSet();
+                return Collections.emptySet();
             }
             }
         } catch (ItemNotFoundException e) {
         } catch (ItemNotFoundException e) {
-            return Collections.emptySortedSet();
+            return Collections.emptySet();
         }
         }
     }
     }
 
 

@@ -17,14 +17,7 @@ package org.onosproject.driver.handshaker;
 
 
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.ImmutableSet;
-import org.onlab.util.Spectrum;
-import org.onosproject.net.ChannelSpacing;
-import org.onosproject.net.DefaultOchSignalComparator;
 import org.onosproject.net.Device;
 import org.onosproject.net.Device;
-import org.onosproject.net.GridType;
-import org.onosproject.net.OchSignal;
-import org.onosproject.net.PortNumber;
-import org.onosproject.net.behaviour.LambdaQuery;
 import org.onosproject.openflow.controller.OpenFlowOpticalSwitch;
 import org.onosproject.openflow.controller.OpenFlowOpticalSwitch;
 import org.onosproject.openflow.controller.PortDescPropertyType;
 import org.onosproject.openflow.controller.PortDescPropertyType;
 import org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch;
 import org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch;
@@ -48,10 +41,7 @@ import java.io.IOException;
 import java.util.ArrayList;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.List;
 import java.util.Set;
 import java.util.Set;
-import java.util.SortedSet;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicBoolean;
-import java.util.stream.Collectors;
-import java.util.stream.IntStream;
 
 
 /**
 /**
  * Driver for Calient S160 Optical Circuit Switch. Untested on Calient S320 but probably works ok.
  * Driver for Calient S160 Optical Circuit Switch. Untested on Calient S320 but probably works ok.
@@ -59,12 +49,9 @@ import java.util.stream.IntStream;
  * Driver implements custom handshaker, and rewrites flow stats as expected by the device. Port stats are currently
  * Driver implements custom handshaker, and rewrites flow stats as expected by the device. Port stats are currently
  * not supported.
  * not supported.
  *
  *
- * The device consists of OMS ports only, and each port exposes lambda resources covering the whole
- * usable optical spectrum (U to O band, see {@link Spectrum} for spectrum definitions).
+ * The device consists of OMS ports only.
  */
  */
-public class CalientFiberSwitchHandshaker
-        extends AbstractOpenFlowSwitch
-        implements OpenFlowOpticalSwitch, LambdaQuery {
+public class CalientFiberSwitchHandshaker extends AbstractOpenFlowSwitch implements OpenFlowOpticalSwitch {
 
 
     private final AtomicBoolean driverHandshakeComplete = new AtomicBoolean(false);
     private final AtomicBoolean driverHandshakeComplete = new AtomicBoolean(false);
     private List<OFCalientPortDescStatsEntry> fiberPorts = new ArrayList<>();
     private List<OFCalientPortDescStatsEntry> fiberPorts = new ArrayList<>();
@@ -198,20 +185,4 @@ public class CalientFiberSwitchHandshaker
 
 
         super.sendMsg(newMsg);
         super.sendMsg(newMsg);
     }
     }
-
-    @Override
-    public SortedSet<OchSignal> queryLambdas(PortNumber port) {
-        // S160 data sheet
-        // Wavelength range: 1260 - 1630 nm
-        long startSpacingMultiplier = Spectrum.U_BAND_MIN.subtract(Spectrum.CENTER_FREQUENCY).asHz() /
-                ChannelSpacing.CHL_12P5GHZ.frequency().asHz();
-        long stopSpacingMultiplier = Spectrum.O_BAND_MAX.subtract(Spectrum.CENTER_FREQUENCY).asHz() /
-                ChannelSpacing.CHL_12P5GHZ.frequency().asHz();
-
-        // Only consider odd values for the multiplier (for easy mapping to fixed grid)
-        return IntStream.rangeClosed((int) startSpacingMultiplier, (int) stopSpacingMultiplier)
-                .filter(i -> i % 2 == 1)
-                .mapToObj(i -> new OchSignal(GridType.FLEX, ChannelSpacing.CHL_6P25GHZ, i, 1))
-                .collect(Collectors.toCollection(DefaultOchSignalComparator::newOchSignalTreeSet));
-    }
 }
 }

@@ -16,13 +16,7 @@
 package org.onosproject.driver.handshaker;
 package org.onosproject.driver.handshaker;
 
 
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.ImmutableSet;
-import org.onosproject.net.ChannelSpacing;
-import org.onosproject.net.DefaultOchSignalComparator;
 import org.onosproject.net.Device;
 import org.onosproject.net.Device;
-import org.onosproject.net.GridType;
-import org.onosproject.net.OchSignal;
-import org.onosproject.net.PortNumber;
-import org.onosproject.net.behaviour.LambdaQuery;
 import org.onosproject.openflow.controller.OpenFlowOpticalSwitch;
 import org.onosproject.openflow.controller.OpenFlowOpticalSwitch;
 import org.onosproject.openflow.controller.PortDescPropertyType;
 import org.onosproject.openflow.controller.PortDescPropertyType;
 import org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch;
 import org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch;
@@ -56,10 +50,7 @@ import java.util.Collections;
 import java.util.LinkedList;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.List;
 import java.util.Set;
 import java.util.Set;
-import java.util.SortedSet;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicBoolean;
-import java.util.stream.Collectors;
-import java.util.stream.IntStream;
 
 
 /**
 /**
  * LINC-OE Optical Emulator switch class.
  * LINC-OE Optical Emulator switch class.
@@ -72,14 +63,9 @@ import java.util.stream.IntStream;
  *
  *
  * As LINC implements custom OF optical extensions (in contrast to the final standard as specified in
  * As LINC implements custom OF optical extensions (in contrast to the final standard as specified in
  * ONF TS-022 (March 15, 2015), we need to rewrite flow stat requests and flow mods in {@link #sendMsg(OFMessage)}.
  * ONF TS-022 (March 15, 2015), we need to rewrite flow stat requests and flow mods in {@link #sendMsg(OFMessage)}.
- *
- * LINC exposes OchSignal resources: 80 lambdas of 50 GHz (fixed grid) around ITU-T G.694.1 center frequency 193.1 GHz.
- *
  */
  */
-public class OfOpticalSwitchImplLinc13
- extends AbstractOpenFlowSwitch implements OpenFlowOpticalSwitch, LambdaQuery {
+public class OfOpticalSwitchImplLinc13 extends AbstractOpenFlowSwitch implements OpenFlowOpticalSwitch {
 
 
-    private static final int LAMBDA_COUNT = 80;
     private final AtomicBoolean driverHandshakeComplete = new AtomicBoolean(false);
     private final AtomicBoolean driverHandshakeComplete = new AtomicBoolean(false);
     private long barrierXidToWaitFor = -1;
     private long barrierXidToWaitFor = -1;
 
 
@@ -361,17 +347,4 @@ public class OfOpticalSwitchImplLinc13
     public Set<PortDescPropertyType> getPortTypes() {
     public Set<PortDescPropertyType> getPortTypes() {
         return ImmutableSet.of(PortDescPropertyType.OPTICAL_TRANSPORT);
         return ImmutableSet.of(PortDescPropertyType.OPTICAL_TRANSPORT);
     }
     }
-
-    @Override
-    public SortedSet<OchSignal> queryLambdas(PortNumber port) {
-        // OCh ports don't have lambdas
-        if (isOChPort(port.toLong())) {
-            return Collections.emptySortedSet();
-        }
-
-        // OMS ports expose 80 fixed grid lambdas of 50GHz width, centered around the ITU-T center frequency 193.1 THz.
-        return IntStream.range(0, LAMBDA_COUNT)
-                .mapToObj(x -> new OchSignal(GridType.DWDM, ChannelSpacing.CHL_50GHZ, x - (LAMBDA_COUNT / 2), 4))
-                .collect(Collectors.toCollection(DefaultOchSignalComparator::newOchSignalTreeSet));
-    }
 }
 }

+/*
+ * Copyright 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.driver.query;
+
+import org.onlab.util.Spectrum;
+import org.onosproject.net.ChannelSpacing;
+import org.onosproject.net.GridType;
+import org.onosproject.net.OchSignal;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.behaviour.LambdaQuery;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+
+/**
+ * Lambda query implementation for Calient S160 and S320 Optical Circuit Switch.
+ *
+ * The device consists of OMS ports only, and each port exposes lambda resources covering the whole
+ * usable optical spectrum (U to O band, see {@link Spectrum} for spectrum definitions).
+ */
+public class CalientLambdaQuery extends AbstractHandlerBehaviour implements LambdaQuery {
+
+    @Override
+    public Set<OchSignal> queryLambdas(PortNumber port) {
+        // S160 data sheet
+        // Wavelength range: 1260 - 1630 nm
+        long startSpacingMultiplier = Spectrum.U_BAND_MIN.subtract(Spectrum.CENTER_FREQUENCY).asHz() /
+                ChannelSpacing.CHL_12P5GHZ.frequency().asHz();
+        long stopSpacingMultiplier = Spectrum.O_BAND_MAX.subtract(Spectrum.CENTER_FREQUENCY).asHz() /
+                ChannelSpacing.CHL_12P5GHZ.frequency().asHz();
+
+        // Only consider odd values for the multiplier (for easy mapping to fixed grid)
+        return IntStream.rangeClosed((int) startSpacingMultiplier, (int) stopSpacingMultiplier)
+                .filter(i -> i % 2 == 1)
+                .mapToObj(i -> new OchSignal(GridType.FLEX, ChannelSpacing.CHL_6P25GHZ, i, 1))
+                .collect(Collectors.toSet());
+    }
+}

+/*
+ * Copyright 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.driver.query;
+
+import org.onosproject.net.ChannelSpacing;
+import org.onosproject.net.GridType;
+import org.onosproject.net.OchSignal;
+import org.onosproject.net.Port;
+import org.onosproject.net.PortNumber;
+import org.onosproject.net.behaviour.LambdaQuery;
+import org.onosproject.net.device.DeviceService;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+
+import java.util.Collections;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+
+/**
+ * Lambda query implementation for LINC-OE Optical Emulator switch.
+ *
+ * The LINC ROADM emulator exposes two types of ports: OCh ports connect to ports in the packet layer,
+ * while OMS ports connect to an OMS port on a neighbouring ROADM.
+ *
+ * LINC exposes OchSignal resources: 80 lambdas of 50 GHz (fixed grid) around ITU-T G.694.1 center frequency 193.1 GHz.
+ */
+
+public class LincOELambdaQuery extends AbstractHandlerBehaviour implements LambdaQuery {
+
+    private static final int LAMBDA_COUNT = 80;
+
+    @Override
+    public Set<OchSignal> queryLambdas(PortNumber port) {
+        DeviceService deviceService = this.handler().get(DeviceService.class);
+        Port p = deviceService.getPort(this.data().deviceId(), port);
+
+        // OCh ports don't expose lambda resources
+        if (!p.type().equals(Port.Type.OMS)) {
+            return Collections.emptySet();
+        }
+
+        // OMS ports expose 80 fixed grid lambdas of 50GHz width, centered around the ITU-T center frequency 193.1 THz.
+        return IntStream.range(0, LAMBDA_COUNT)
+                .mapToObj(x -> new OchSignal(GridType.DWDM, ChannelSpacing.CHL_50GHZ, x - (LAMBDA_COUNT / 2), 4))
+                .collect(Collectors.toSet());
+    }
+}

@@ -15,6 +15,6 @@
  */
  */
 
 
 /**
 /**
- * Implementations of the query driver behaviours.
+ * Implementations of the resource query behaviours.
  */
  */
 package org.onosproject.driver.query;
 package org.onosproject.driver.query;

@@ -85,7 +85,7 @@
         <behaviour api="org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver"
         <behaviour api="org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver"
                    impl="org.onosproject.driver.handshaker.OfOpticalSwitchImplLinc13"/>
                    impl="org.onosproject.driver.handshaker.OfOpticalSwitchImplLinc13"/>
         <behaviour api="org.onosproject.net.behaviour.LambdaQuery"
         <behaviour api="org.onosproject.net.behaviour.LambdaQuery"
-                   impl="org.onosproject.driver.handshaker.OfOpticalSwitchImplLinc13"/>
+                   impl="org.onosproject.driver.query.LincOELambdaQuery"/>
     </driver>
     </driver>
     <driver name="corsa"
     <driver name="corsa"
             manufacturer="Corsa" hwVersion="Corsa Element" swVersion="2.3.1">
             manufacturer="Corsa" hwVersion="Corsa Element" swVersion="2.3.1">
@@ -162,7 +162,7 @@
         <behaviour api="org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver"
         <behaviour api="org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver"
                    impl="org.onosproject.driver.handshaker.CalientFiberSwitchHandshaker"/>
                    impl="org.onosproject.driver.handshaker.CalientFiberSwitchHandshaker"/>
         <behaviour api="org.onosproject.net.behaviour.LambdaQuery"
         <behaviour api="org.onosproject.net.behaviour.LambdaQuery"
-                   impl="org.onosproject.driver.handshaker.CalientFiberSwitchHandshaker"/>
+                   impl="org.onosproject.driver.query.CalientLambdaQuery"/>
     </driver>
     </driver>
     <driver name="onosfw" extends="ovs"
     <driver name="onosfw" extends="ovs"
             manufacturer="" hwVersion="" swVersion="">
             manufacturer="" hwVersion="" swVersion="">