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 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;
  12
  13 public interface OtnDeviceOperations {
  14
  15     /**
  16      * This method checks if the client port can be used or not.
  17      *
  18      * @param nodeID unique identifier of a device
  19      * @param circuitPackName circuit pack name of the client port
  20      * @param portName port name of the client port
  21      * @param capacity rate of the service needed
  22      * @return String which states whether the client port is valid or not
  23      */
  24     String validateClientPort(String nodeID, String circuitPackName, String portName, String capacity);
  25
  26     /**
  27      * This method retrieves the possible network ports.
  28      *
  29      *<p>
  30      *     checks for the possible network ports in odu-switching-pool
  31      *</p>
  32      * @param circuitPackName Circuit pack name of the client port
  33      * @param portName port name of the client port
  34      * @return List of all possible network ports
  35      */
  36     List<PortList> getPossibleNetworkPorts(String circuitPackName, String portName);
  37
  38
  39 }