common/src/main/java/org/opendaylight/transportpce/common/openroadminterfaces/OpenRoadmInterfaces.java

   1 /*
   2  * Copyright © 2017 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
   9 package org.opendaylight.transportpce.common.openroadminterfaces;
  10
  11 import java.util.Optional;
  12
  13 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.Interface;
  14 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.interfaces.grp.InterfaceBuilder;
  15
  16 public interface OpenRoadmInterfaces {
  17
  18     /**
  19      * This methods does an edit-config operation on the openROADM device in
  20      * order to create the given interface.
  21      *
  22      * <p>
  23      * Before posting the interface it checks if: 1. Interface with same name
  24      * does not exist 2. If exists then admin state of interface is
  25      * outOfState/Maintenance
  26      * </p>
  27      *
  28      * @param nodeId node ID
  29      *
  30      * @param ifBuilder Builder object containing the data to post.
  31      *
  32      * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
  33      *
  34      */
  35     void postInterface(String nodeId, InterfaceBuilder ifBuilder) throws OpenRoadmInterfaceException;
  36
  37     /**
  38      * This methods does an edit-config operation on the openROADM device in
  39      * order to manages the equipment-state status of the circuit pack on which
  40      * OpenRoadmEthernet or OpenRoadmOch interfaces are created, according to
  41      * OpenRoadm whitepaper. Concerns only XPDR node.
  42      *
  43      * @param nodeId node ID
  44      * @param circuitPackName Circtuit-Pack name
  45      * @param activate activate or not
  46      */
  47     void postEquipmentState(String nodeId, String circuitPackName, boolean activate) throws OpenRoadmInterfaceException;
  48
  49     /**
  50      * This private does a get on the interface subtree of the device with the
  51      * interface name as the key and return the class corresponding to the
  52      * interface type.
  53      *
  54      * @param nodeId node ID
  55      *
  56      * @param interfaceName
  57      *            Name of the interface
  58      *
  59      * @return Optional of Interface from datastore
  60      *
  61      * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
  62      */
  63     Optional<Interface> getInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException;
  64
  65     /**
  66      * This methods does an edit-config operation on the openROADM device in
  67      * order to delete the given interface.
  68      *
  69      * <p>
  70      * Before deleting the method: 1. Checks if interface exists 2. If exists
  71      * then changes the state of interface to outOfService
  72      * </p>
  73      *
  74      * @param nodeId node ID
  75      *
  76      * @param interfaceName
  77      *            Name of the interface to delete.
  78      *
  79      * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
  80      */
  81     void deleteInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException;
  82
  83 }