renderer/src/main/java/org/opendaylight/transportpce/renderer/provisiondevice/otn/OtnDeviceOperations.java

   1 /*
   2  * Copyright © 2019 AT&T and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.transportpce.renderer.provisiondevice.otn;
   9
  10 import java.util.List;
  11
  12 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.CircuitPacks;
  13 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.OduSwitchingPools;
  14 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.odu.switching.pools.non.blocking.list.PortList;
  15 import org.opendaylight.yang.gen.v1.http.org.openroadm.port.capability.rev181019.port.group.restriction.grp.PortGroupRestriction;
  16
  17 public interface OtnDeviceOperations {
  18
  19     /**
  20      * This method checks if the client port can be used or not.
  21      * @param circuitPackName circuit pack name of the client port
  22      * @param portName port name of the client port
  23      * @param capacity rate of the service needed
  24      * @param portGroupRestriction TODO
  25      *
  26      * @return String which states whether the client port is valid or not
  27      */
  28     String validateClientPort(String circuitPackName, String portName, String capacity,
  29             PortGroupRestriction portGroupRestriction);
  30
  31     /**
  32      * This method retrieves the possible network ports.
  33      *
  34      *<p>
  35      *     checks for the possible network ports in odu-switching-pool
  36      *</p>
  37      * @param circuitPackName Circuit pack name of the client port
  38      * @param portName port name of the client port
  39      * @param oduSwitchingPools TODO
  40      * @param circuitPacks TODO
  41      * @return List of all possible network ports
  42      */
  43     List<PortList> getPossibleNetworkPorts(String circuitPackName, String portName,
  44             OduSwitchingPools oduSwitchingPools, CircuitPacks circuitPacks);
  45
  46
  47 }