2 * Copyright © 2017 AT&T and others. All rights reserved.
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
9 package org.opendaylight.transportpce.common.openroadminterfaces;
11 import java.util.Optional;
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;
16 public interface OpenRoadmInterfaces {
19 * This methods does an edit-config operation on the openROADM device in order
20 * to create the given interface.
23 * Before posting the interface it checks if:
24 * 1. Interface with same name does not exist
25 * 2. If exists then admin state of interface is outOfState/Maintenance
28 * @param nodeId node ID
30 * @param ifBuilder Builder object containing the data to post.
32 * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
35 void postInterface(String nodeId, InterfaceBuilder ifBuilder) throws OpenRoadmInterfaceException;
38 * This private does a get on the interface subtree of the device with the
39 * interface name as the key and return the class corresponding to the interface
42 * @param nodeId node ID
44 * @param interfaceName
45 * Name of the interface
47 * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
49 * @return Optional of Interface from datastore
51 Optional<Interface> getInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException;
54 * This methods does an edit-config operation on the openROADM device in order
55 * to delete the given interface.
58 * Before deleting the method:
59 * 1. Checks if interface exists
60 * 2. If exists then changes the state of interface to outOfService
63 * @param nodeId node ID
65 * @param interfaceName
66 * Name of the interface to delete.
68 * @throws OpenRoadmInterfaceException OpenRoadm Interface Exception
70 void deleteInterface(String nodeId, String interfaceName) throws OpenRoadmInterfaceException;