package org.opendaylight.transportpce.common.mapping;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.portmapping.rev170228.network.nodes.Mapping;
+
+import java.util.List;
+import java.util.Map;
+import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mapping.Mapping;
+import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.mc.capabilities.McCapabilities;
+import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev220316.network.Nodes;
+import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev200529.org.openroadm.device.container.org.openroadm.device.OduSwitchingPools;
+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;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.Uint16;
+
public interface PortMapping {
+ PortMappingVersion221 getPortMappingVersion221();
+
+ PortMappingVersion710 getPortMappingVersion710();
+
/**
* This method creates logical to physical port mapping for a given device.
- * Instead of parsing all the circuit packs/ports in the device this methods
+ * Instead of parsing all the circuit packs/ports in the device, this methods
* does a selective read operation on degree/srg subtree to get circuit
* packs/ports that map to :
*
*
* @param nodeId
* node ID
+ * @param nodeVersion
+ * node version
*
* @return true/false based on status of operation
*/
- boolean createMappingData(String nodeId);
+ boolean createMappingData(String nodeId, String nodeVersion);
/**
- * This method removes mapping data from the datastore after disconnecting
- * ODL from a Netconf device.
+ * This method removes all mapping data of a given node from the datastore
+ * after disconnecting ODL from a Netconf device.
*
* @param nodeId
* node ID
*/
- void deleteMappingData(String nodeId);
+ void deletePortMappingNode(String nodeId);
/**
- * This method for a given node's termination point returns the Mapping object based on
- * portmapping.yang model stored in the MD-SAL data store which is created when the node is
- * connected for the first time. The mapping object basically contains the following attributes of
- * interest:
+ * This method for a given node's termination point returns the Mapping object
+ * based on portmapping.yang model stored in the MD-SAL data store which is
+ * created when the node is connected for the first time. The mapping object
+ * basically contains the following attributes of interest:
*
* <p>
* 1. Supporting circuit pack
* 2. Supporting port
*
* <p>
- * 3. Supporting OMS interface (if port on ROADM) 4. Supporting OTS interface (if port on ROADM)
+ * 3. Supporting OTS/OMS interface (if port on ROADM)
*
- * @param nodeId Unique Identifier for the node of interest.
- * @param logicalConnPoint Name of the logical point
+ * @param nodeId
+ * Unique Identifier for the node of interest.
+ * @param logicalConnPoint
+ * Name of the logical point
*
* @return Result Mapping object if success otherwise null.
*/
-
Mapping getMapping(String nodeId, String logicalConnPoint);
+
+ /**
+ * This method allows retrieving a Mapping object from the mapping list stored in
+ * the MD-SAL data store. The main interest is to retrieve the
+ * logical-connection-point associated with a given port on a supporting
+ * circuit-pack
+ *
+ * @param nodeId
+ * Unique Identifier for the node of interest.
+ * @param circuitPackName
+ * Name of the supporting circuit-pack
+ * @param portName
+ * Name of the supporting port
+ *
+ * @return Result Mapping object if success otherwise null.
+ */
+ Mapping getMapping(String nodeId, String circuitPackName, String portName);
+
+ /**
+ * This method removes a given mapping data from the mapping list
+ * stored in the datastore while the Netconf device is already
+ * connected to the controller.
+ *
+ * @param nodeId
+ * node ID
+ * @param logicalConnectionPoint
+ * key of the mapping inside the mapping list
+ */
+ void deleteMapping(String nodeId, String logicalConnectionPoint);
+
+ /**
+ * This method, for a given node media channel-capabilities, returns the object
+ * based on portmapping.yang model stored in the MD-SAL data store which is
+ * created when the node is connected for the first time. The mapping object
+ * basically contains the following attributes of interest:
+ *
+ * <p>
+ * 1. slot width granularity
+ *
+ * <p>
+ * 2. center frequency granularity
+ *
+ * <p>
+ * 3. Supporting OMS interface (if port on ROADM)
+ *
+ * <p>
+ * 4. Supporting OTS interface (if port on ROADM)
+ *
+ * @param nodeId
+ * Unique Identifier for the node of interest.
+ * @param mcLcp
+ * Name of the MC-capability
+ *
+ * @return Result McCapabilities.
+ */
+ McCapabilities getMcCapbilities(String nodeId, String mcLcp);
+
+ /**
+ * This method for a given node, allows to update a specific mapping based on
+ * portmapping.yang model already stored in the MD-SAL data store, following
+ * some changes on the device port (creation of interface supported on this
+ * port, change of port admin state, etc).
+ *
+ * @param nodeId
+ * Unique Identifier for the node of interest.
+ * @param mapping
+ * Old mapping to be updated.
+ *
+ * @return Result true/false based on status of operation.
+ */
+ boolean updateMapping(String nodeId, Mapping mapping);
+
+ /**
+ * Returns all Mapping informations for a given ordm device. This method returns
+ * all Mapping informations already stored in the MD-SAL data store for a given
+ * openroadm device. Beyound the list of mappings, it gives access to general
+ * node information as its version or its node type, etc.
+ *
+ * @param nodeId
+ * Unique Identifier for the node of interest.
+ *
+ * @return node data if success otherwise null.
+ */
+ Nodes getNode(String nodeId);
+
+ /**
+ * This method allows to update a port-mapping node with odu-connection-map data.
+ * This method is used for an otn xponder in version 7.1, when a device sends a
+ * change-notification advertising controller that odu-switching-pools containers
+ * have been populated inside its configuration
+ * (appears after creation of an OTSI-Group interface).
+ *
+ * @param nodeId
+ * Unique Identifier for the node of interest.
+ * @param ospIID
+ * Instance Identifier of the odu-switching-pools.
+ * @param nbliidMap
+ * Map containing the non-blocking-list number as key,
+ * and the list of Instance Identifier corresponding to each port-list
+ * as value.
+ *
+ * @return Result true/false based on status of operation.
+ */
+ boolean updatePortMappingWithOduSwitchingPools(String nodeId, InstanceIdentifier<OduSwitchingPools> ospIID,
+ Map<Uint16, List<InstanceIdentifier<PortList>>> nbliidMap);
+
+ /**
+ * This method check the presence or not of a given node inside the PortMapping
+ * datastore.
+ *
+ * @param nodeId
+ * Unique Identifier for the node of interest.
+ *
+ * @return Result true/false based on existance or not of a given node.
+ */
+ boolean isNodeExist(String nodeId);
+
}
Code Review / transportpce.git / blobdiff