renderer/src/main/java/org/opendaylight/transportpce/renderer/openroadminterface/OpenRoadmInterfaceFactory.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.renderer.openroadminterface;
  10
  11 import java.util.List;
  12
  13 import org.opendaylight.transportpce.common.StringConstants;
  14 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  15 import org.opendaylight.transportpce.common.mapping.MappingUtils;
  16 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
  17 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200128.network.nodes.Mapping;
  18 import org.opendaylight.yang.gen.v1.http.org.openroadm.optical.channel.interfaces.rev161014.OchAttributes;
  19 import org.slf4j.Logger;
  20 import org.slf4j.LoggerFactory;
  21
  22 public class OpenRoadmInterfaceFactory {
  23
  24     private static final String OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG =
  25             "OTN funtions are not supported by Openroadm models 1.2.1";
  26     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmInterfaceFactory.class);
  27     private final MappingUtils mappingUtils;
  28     private final OpenRoadmInterface121 openRoadmInterface121;
  29     private final OpenRoadmInterface221 openRoadmInterface221;
  30     private final OpenRoadmOtnInterface221 openRoadmOtnInterface;
  31
  32     public OpenRoadmInterfaceFactory(MappingUtils mappingUtils, OpenRoadmInterface121 openRoadmInterface121,
  33             OpenRoadmInterface221 openRoadmInterface221, OpenRoadmOtnInterface221 openRoadmOTNInterface) {
  34         this.mappingUtils = mappingUtils;
  35         this.openRoadmInterface121 = openRoadmInterface121;
  36         this.openRoadmInterface221 = openRoadmInterface221;
  37         this.openRoadmOtnInterface = openRoadmOTNInterface;
  38     }
  39
  40     public String createOpenRoadmEthInterface(String nodeId, String logicalConnPoint)
  41             throws OpenRoadmInterfaceException {
  42
  43         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
  44             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
  45                 return openRoadmInterface121.createOpenRoadmEthInterface(nodeId, logicalConnPoint);
  46             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
  47                 return openRoadmInterface221.createOpenRoadmEthInterface(nodeId, logicalConnPoint);
  48             default:
  49                 return null;
  50         }
  51     }
  52
  53
  54     /**
  55      * This methods creates an OCH interface on the given termination point on
  56      * Roadm.
  57      *
  58      * @param nodeId           node ID
  59      * @param logicalConnPoint logical connection point
  60      * @param waveNumber       wavelength number of the OCH interface.
  61      * @return Name of the interface if successful, otherwise return null.
  62      * @throws OpenRoadmInterfaceException OpenRoadm interface exception
  63      */
  64
  65     public List<String> createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber)
  66             throws OpenRoadmInterfaceException {
  67
  68         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
  69             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
  70                 return openRoadmInterface121.createOpenRoadmOchInterface(nodeId, logicalConnPoint, waveNumber);
  71             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
  72                 return openRoadmInterface221.createFlexOCH(nodeId, logicalConnPoint, waveNumber);
  73             default:
  74                 return null;
  75         }
  76     }
  77
  78
  79     public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint, Long waveNumber,
  80         OchAttributes.ModulationFormat format)
  81             throws OpenRoadmInterfaceException {
  82         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
  83             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
  84                 return openRoadmInterface121.createOpenRoadmOchInterface(nodeId, logicalConnPoint, waveNumber, format);
  85             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
  86                 return openRoadmInterface221.createOpenRoadmOchInterface(nodeId, logicalConnPoint, waveNumber);
  87             default:
  88                 return null;
  89         }
  90     }
  91
  92     /**
  93      * This methods creates an ODU interface on the given termination point.
  94      *
  95      * @param nodeId                 node ID
  96      * @param logicalConnPoint       logical connection point
  97      * @param supportingOtuInterface supporting OTU interface
  98      * @return Name of the interface if successful, otherwise return null.
  99      * @throws OpenRoadmInterfaceException OpenRoadm interface exception
 100      */
 101
 102     public String createOpenRoadmOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
 103             throws OpenRoadmInterfaceException {
 104         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 105             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 106                 return openRoadmInterface121.createOpenRoadmOdu4Interface(nodeId, logicalConnPoint,
 107                         supportingOtuInterface);
 108             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 109                 return openRoadmInterface221.createOpenRoadmOdu4Interface(nodeId, logicalConnPoint,
 110                         supportingOtuInterface);
 111             default:
 112                 return null;
 113         }
 114     }
 115
 116     /**
 117      * This methods creates an OTU interface on the given termination point.
 118      *
 119      * @param nodeId              node ID
 120      * @param logicalConnPoint    logical connection point
 121      * @param supportOchInterface supporting OCH interface
 122      * @return Name of the interface if successful, otherwise return null.
 123      * @throws OpenRoadmInterfaceException OpenRoadm interface exception
 124      */
 125
 126     public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
 127             throws OpenRoadmInterfaceException {
 128         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 129             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 130                 return openRoadmInterface121
 131                         .createOpenRoadmOtu4Interface(nodeId, logicalConnPoint, supportOchInterface);
 132             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 133                 return openRoadmInterface221
 134                         .createOpenRoadmOtu4Interface(nodeId, logicalConnPoint, supportOchInterface);
 135             default:
 136                 return null;
 137         }
 138     }
 139
 140     public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, Long waveNumber) {
 141         return logicalConnectionPoint + "-" + waveNumber;
 142     }
 143
 144     public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 145         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 146             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 147                 return openRoadmInterface121.createOpenRoadmOmsInterface(nodeId, mapping);
 148             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 149                 return openRoadmInterface221.createOpenRoadmOmsInterface(nodeId, mapping);
 150             default:
 151                 return null;
 152         }
 153     }
 154
 155     public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 156         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 157             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 158                 return openRoadmInterface121.createOpenRoadmOtsInterface(nodeId, mapping);
 159             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 160                 return openRoadmInterface221.createOpenRoadmOtsInterface(nodeId, mapping);
 161             default:
 162                 return null;
 163         }
 164     }
 165
 166     public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
 167                               DeviceTransactionManager deviceTransactionManager) {
 168         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 169             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 170                 return openRoadmInterface121.isUsedByXc(nodeId, interfaceName, xc, deviceTransactionManager);
 171             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 172                 return openRoadmInterface221.isUsedByXc(nodeId, interfaceName, xc, deviceTransactionManager);
 173             default:
 174                 return false;
 175         }
 176     }
 177
 178     public boolean isUsedByOtnXc(String nodeId, String interfaceName, String xc,
 179         DeviceTransactionManager deviceTransactionManager) {
 180         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 181             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 182                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 183                 return false;
 184             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 185                 return openRoadmInterface221.isUsedByOtnXc(nodeId, interfaceName, xc, deviceTransactionManager);
 186             default:
 187                 return false;
 188         }
 189     }
 190
 191     public String createOpenRoadmEth1GInterface(String nodeId,
 192                                                 String logicalConnPoint) throws OpenRoadmInterfaceException {
 193         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 194             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 195                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 196                 return null;
 197             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 198                 return openRoadmOtnInterface.createOpenRoadmEth1GInterface(nodeId, logicalConnPoint);
 199             default:
 200                 return null;
 201         }
 202     }
 203
 204     public String createOpenRoadmEth10GInterface(String nodeId,
 205                                                  String logicalConnPoint) throws OpenRoadmInterfaceException {
 206         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 207             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 208                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 209                 return null;
 210             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 211                 return openRoadmOtnInterface.createOpenRoadmEth10GInterface(nodeId, logicalConnPoint);
 212             default:
 213                 return null;
 214         }
 215
 216     }
 217
 218     public String createOpenRoadmOdu0Interface(String nodeId, String logicalConnPoint, String servicename,
 219             String payLoad, boolean isNetworkPort, int tribPortNumber, int tribSlot)
 220             throws OpenRoadmInterfaceException {
 221         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 222             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 223                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 224                 return null;
 225             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 226                 return openRoadmOtnInterface.createOpenRoadmOdu0Interface(
 227                     nodeId, logicalConnPoint, servicename, payLoad, isNetworkPort, tribPortNumber, tribSlot);
 228             default:
 229                 return null;
 230         }
 231     }
 232
 233     public String createOpenRoadmOdu2Interface(String nodeId, String logicalConnPoint, String servicename,
 234             String payLoad, boolean isNetworkPort, int tribPortNumber, int tribSlotIndex)
 235             throws OpenRoadmInterfaceException {
 236         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 237             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 238                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 239                 return null;
 240             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 241                 return openRoadmOtnInterface.createOpenRoadmOdu2Interface(
 242                     nodeId, logicalConnPoint, servicename, payLoad, isNetworkPort, tribPortNumber, tribSlotIndex);
 243             default:
 244                 return null;
 245         }
 246     }
 247
 248     public String createOpenRoadmOdu2eInterface(String nodeId, String logicalConnPoint, String servicename,
 249             String payLoad, boolean isNetworkPort, int tribPortNumber, int tribSlotIndex)
 250             throws OpenRoadmInterfaceException {
 251         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 252             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 253                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 254                 return null;
 255             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 256                 return openRoadmOtnInterface.createOpenRoadmOdu2eInterface(
 257                         nodeId, logicalConnPoint, servicename, payLoad, isNetworkPort, tribPortNumber, tribSlotIndex);
 258             default:
 259                 return null;
 260         }
 261
 262     }
 263
 264     public String createOpenRoadmOtnOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
 265             throws OpenRoadmInterfaceException {
 266         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 267             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 268                 return openRoadmInterface221
 269                         .createOpenRoadmOtnOdu4Interface(nodeId, logicalConnPoint, supportingOtuInterface);
 270             default:
 271                 return null;
 272         }
 273     }
 274 }