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.mapping;
12 import java.util.List;
14 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210426.mapping.Mapping;
15 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210426.mc.capabilities.McCapabilities;
16 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev210426.network.Nodes;
17 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.org.openroadm.device.container.org.openroadm.device.OduSwitchingPools;
18 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.org.openroadm.device.container.org.openroadm.device.odu.switching.pools.non.blocking.list.PortList;
19 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
20 import org.opendaylight.yangtools.yang.common.Uint16;
23 public interface PortMapping {
26 * This method creates logical to physical port mapping for a given device.
27 * Instead of parsing all the circuit packs/ports in the device, this methods
28 * does a selective read operation on degree/srg subtree to get circuit
29 * packs/ports that map to :
32 * 1. DEGn-TTP-TX, DEGn-TTP-RX, DEGn-TTP-TXRX
35 * 2. SRGn-PPp-TX, SRGn-PPp-RX, SRGn-PPp-TXRX
44 * If the port is Mw it also store the OMS, OTS interface provisioned on the
45 * port. It skips the logical ports that are internal. If operation is
46 * successful the mapping gets stored in datastore corresponding to
47 * portmapping.yang data model.
54 * @return true/false based on status of operation
56 boolean createMappingData(String nodeId, String nodeVersion);
59 * This method removes mapping data from the datastore after disconnecting ODL
60 * from a Netconf device.
65 void deleteMappingData(String nodeId);
68 * This method for a given node's termination point returns the Mapping object
69 * based on portmapping.yang model stored in the MD-SAL data store which is
70 * created when the node is connected for the first time. The mapping object
71 * basically contains the following attributes of interest:
74 * 1. Supporting circuit pack
80 * 3. Supporting OTS/OMS interface (if port on ROADM)
83 * Unique Identifier for the node of interest.
84 * @param logicalConnPoint
85 * Name of the logical point
87 * @return Result Mapping object if success otherwise null.
89 Mapping getMapping(String nodeId, String logicalConnPoint);
92 * This method allows retrieving a Mapping object from the mapping list stored in
93 * the MD-SAL data store. The main interest is to retrieve the
94 * logical-connection-point associated with a given port on a supporting
98 * Unique Identifier for the node of interest.
99 * @param circuitPackName
100 * Name of the supporting circuit-pack
102 * Name of the supporting port
104 * @return Result Mapping object if success otherwise null.
106 Mapping getMapping(String nodeId, String circuitPackName, String portName);
109 * This method, for a given node media channel-capabilities, returns the object
110 * based on portmapping.yang model stored in the MD-SAL data store which is
111 * created when the node is connected for the first time. The mapping object
112 * basically contains the following attributes of interest:
115 * 1. slot width granularity
118 * 2. center frequency granularity
121 * 3. Supporting OMS interface (if port on ROADM)
124 * 4. Supporting OTS interface (if port on ROADM)
127 * Unique Identifier for the node of interest.
129 * Name of the MC-capability
131 * @return Result McCapabilities.
133 McCapabilities getMcCapbilities(String nodeId, String mcLcp);
136 * This method for a given node, allows to update a specific mapping based on
137 * portmapping.yang model already stored in the MD-SAL data store, following
138 * some changes on the device port (creation of interface supported on this
139 * port, change of port admin state, etc).
142 * Unique Identifier for the node of interest.
144 * Old mapping to be updated.
146 * @return Result true/false based on status of operation.
148 boolean updateMapping(String nodeId, Mapping mapping);
151 * Returns all Mapping informations for a given ordm device. This method returns
152 * all Mapping informations already stored in the MD-SAL data store for a given
153 * openroadm device. Beyound the list of mappings, it gives access to general
154 * node information as its version or its node type, etc.
157 * Unique Identifier for the node of interest.
159 * @return node data if success otherwise null.
161 Nodes getNode(String nodeId);
164 * This method allows to update a port-mapping node with odu-connection-map data.
165 * This method is used for an otn xponder in version 7.1, when a device sends a
166 * change-notification advertising controller that odu-switching-pools containers
167 * have been populated inside its configuration
168 * (appears after creation of an OTSI-Group interface).
171 * Unique Identifier for the node of interest.
173 * Instance Identifier of the odu-switching-pools.
175 * Map containing the non-blocking-list number as key,
176 * and the list of Instance Identifier corresponding to each port-list
179 * @return Result true/false based on status of operation.
181 boolean updatePortMappingWithOduSwitchingPools(String nodeId, InstanceIdentifier<OduSwitchingPools> ospIID,
182 Map<Uint16, List<InstanceIdentifier<PortList>>> nbliidMap);
185 * This method check the presence or not of a given node inside the PortMapping
189 * Unique Identifier for the node of interest.
191 * @return Result true/false based on existance or not of a given node.
193 boolean isNodeExist(String nodeId);