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 import org.opendaylight.transportpce.common.StringConstants;
  13 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  14 import org.opendaylight.transportpce.common.fixedflex.GridConstant;
  15 import org.opendaylight.transportpce.common.fixedflex.SpectrumInformation;
  16 import org.opendaylight.transportpce.common.mapping.MappingUtils;
  17 import org.opendaylight.transportpce.common.openroadminterfaces.OpenRoadmInterfaceException;
  18 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev201012.network.nodes.Mapping;
  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     public List<String> createOpenRoadmOchInterfaces(String nodeId, String logicalConnPoint,
  54             SpectrumInformation spectrumInformation)
  55             throws OpenRoadmInterfaceException {
  56         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
  57             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
  58                 return openRoadmInterface121.createOpenRoadmOchInterfaces(nodeId, logicalConnPoint,
  59                         spectrumInformation);
  60             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
  61                 return openRoadmInterface221.createFlexOCH(nodeId, logicalConnPoint, spectrumInformation);
  62             default:
  63                 return null;
  64         }
  65     }
  66
  67
  68     /**
  69      * This methods creates an OCH interface on the given termination point on Roadm.
  70      *
  71      * @param nodeId           node ID
  72      * @param logicalConnPoint logical connection point
  73      * @param spectrumInformation spectrum information.
  74      * @return Name of the interface if successful, otherwise return null.
  75      * @throws OpenRoadmInterfaceException OpenRoadm interface exception
  76      */
  77     public String createOpenRoadmOchInterface(String nodeId, String logicalConnPoint,
  78             SpectrumInformation spectrumInformation) throws OpenRoadmInterfaceException {
  79         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
  80             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
  81                 return openRoadmInterface121.createOpenRoadmOchInterface(nodeId, logicalConnPoint,
  82                         spectrumInformation);
  83             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
  84                 return openRoadmInterface221.createOpenRoadmOchInterface(nodeId, logicalConnPoint,
  85                         spectrumInformation);
  86
  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 ODU interface on the given termination point.
 118      *
 119      * @param anodeId                 node ID for A side
 120      * @param alogicalConnPoint       logical connection point for A side
 121      * @param asupportingOtuInterface supporting OTU interface
 122      * @param znodeId                 node ID for Z side
 123      * @param zlogicalConnPoint       logical connection point for Z side
 124      * @return Name of the interface if successful, otherwise return null.
 125      * @throws OpenRoadmInterfaceException OpenRoadm interface exception
 126      */
 127
 128     public String createOpenRoadmOdu4Interface(String anodeId, String alogicalConnPoint, String asupportingOtuInterface,
 129             String znodeId, String zlogicalConnPoint)
 130             throws OpenRoadmInterfaceException {
 131         switch (mappingUtils.getOpenRoadmVersion(anodeId)) {
 132             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 133                 return openRoadmInterface121.createOpenRoadmOdu4Interface(anodeId, alogicalConnPoint,
 134                     asupportingOtuInterface);
 135             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 136                 return openRoadmInterface221.createOpenRoadmOdu4Interface(anodeId, alogicalConnPoint,
 137                     asupportingOtuInterface, znodeId, zlogicalConnPoint);
 138             default:
 139                 return null;
 140         }
 141     }
 142
 143     /**
 144      * This methods creates an OTU interface on the given termination point.
 145      *
 146      * @param nodeId              node ID
 147      * @param logicalConnPoint    logical connection point
 148      * @param supportOchInterface supporting OCH interface
 149      * @return Name of the interface if successful, otherwise return null.
 150      * @throws OpenRoadmInterfaceException OpenRoadm interface exception
 151      */
 152
 153     public String createOpenRoadmOtu4Interface(String nodeId, String logicalConnPoint, String supportOchInterface)
 154             throws OpenRoadmInterfaceException {
 155         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 156             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 157                 return openRoadmInterface121
 158                         .createOpenRoadmOtu4Interface(nodeId, logicalConnPoint, supportOchInterface);
 159             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 160                 return openRoadmInterface221
 161                         .createOpenRoadmOtu4Interface(nodeId, logicalConnPoint, supportOchInterface);
 162             default:
 163                 return null;
 164         }
 165     }
 166
 167     /**
 168      * This methods creates an OTU interface on the given termination point.
 169      *
 170      * @param anodeId node ID for A side
 171      * @param alogicalConnPoint logical connection point for A side
 172      * @param asupportOchInterface supporting OCH interface
 173      * @param znodeId node ID for the Z side
 174      * @param zlogicalConnPoint logical connection point for Z side
 175      * @return Name of the interface if successful, otherwise return null.
 176      *
 177      * @throws OpenRoadmInterfaceException OpenRoadm interface exception
 178      */
 179
 180     public String createOpenRoadmOtu4Interface(String anodeId, String alogicalConnPoint, String asupportOchInterface,
 181             String znodeId, String zlogicalConnPoint)
 182             throws OpenRoadmInterfaceException {
 183         switch (mappingUtils.getOpenRoadmVersion(anodeId)) {
 184             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 185                 return openRoadmInterface121.createOpenRoadmOtu4Interface(anodeId,
 186                         alogicalConnPoint, asupportOchInterface);
 187             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 188                 return openRoadmInterface221.createOpenRoadmOtu4Interface(anodeId, alogicalConnPoint,
 189                         asupportOchInterface, znodeId, zlogicalConnPoint);
 190             default:
 191                 return null;
 192         }
 193     }
 194
 195     public String createOpenRoadmOchInterfaceName(String logicalConnectionPoint, String spectralSlotNumber) {
 196         return String.join(GridConstant.NAME_PARAMETERS_SEPARATOR,logicalConnectionPoint, spectralSlotNumber);
 197     }
 198
 199     public String createOpenRoadmOmsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 200         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 201             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 202                 return openRoadmInterface121.createOpenRoadmOmsInterface(nodeId, mapping);
 203             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 204                 return openRoadmInterface221.createOpenRoadmOmsInterface(nodeId, mapping);
 205             default:
 206                 return null;
 207         }
 208     }
 209
 210     public String createOpenRoadmOtsInterface(String nodeId, Mapping mapping) throws OpenRoadmInterfaceException {
 211         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 212             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 213                 return openRoadmInterface121.createOpenRoadmOtsInterface(nodeId, mapping);
 214             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 215                 return openRoadmInterface221.createOpenRoadmOtsInterface(nodeId, mapping);
 216             default:
 217                 return null;
 218         }
 219     }
 220
 221     public boolean isUsedByXc(String nodeId, String interfaceName, String xc,
 222                               DeviceTransactionManager deviceTransactionManager) {
 223         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 224             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 225                 return openRoadmInterface121.isUsedByXc(nodeId, interfaceName, xc, deviceTransactionManager);
 226             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 227                 return openRoadmInterface221.isUsedByXc(nodeId, interfaceName, xc, deviceTransactionManager);
 228             default:
 229                 return false;
 230         }
 231     }
 232
 233     public boolean isUsedByOtnXc(String nodeId, String interfaceName, String xc,
 234             DeviceTransactionManager deviceTransactionManager) {
 235         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 236             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 237                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 238                 return false;
 239             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 240                 return openRoadmInterface221.isUsedByOtnXc(nodeId, interfaceName, xc, deviceTransactionManager);
 241             default:
 242                 return false;
 243         }
 244     }
 245
 246     public String createOpenRoadmEth1GInterface(String nodeId,
 247                                                 String logicalConnPoint) throws OpenRoadmInterfaceException {
 248         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 249             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 250                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 251                 return null;
 252             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 253                 return openRoadmOtnInterface.createOpenRoadmEth1GInterface(nodeId, logicalConnPoint);
 254             default:
 255                 return null;
 256         }
 257     }
 258
 259     public String createOpenRoadmEth10GInterface(String nodeId,
 260                                                  String logicalConnPoint) throws OpenRoadmInterfaceException {
 261         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 262             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 263                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 264                 return null;
 265             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 266                 return openRoadmOtnInterface.createOpenRoadmEth10GInterface(nodeId, logicalConnPoint);
 267             default:
 268                 return null;
 269         }
 270
 271     }
 272
 273     public String createOpenRoadmOdu0Interface(String nodeId, String logicalConnPoint, String servicename,
 274             String payLoad, boolean isNetworkPort, int tribPortNumber, int tribSlot)
 275             throws OpenRoadmInterfaceException {
 276         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 277             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 278                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 279                 return null;
 280             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 281                 return openRoadmOtnInterface.createOpenRoadmOdu0Interface(
 282                     nodeId, logicalConnPoint, servicename, payLoad, isNetworkPort, tribPortNumber, tribSlot);
 283             default:
 284                 return null;
 285         }
 286     }
 287
 288     public String createOpenRoadmOdu2Interface(String nodeId, String logicalConnPoint, String servicename,
 289             String payLoad, boolean isNetworkPort, int tribPortNumber, int tribSlotIndex)
 290             throws OpenRoadmInterfaceException {
 291         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 292             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 293                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 294                 return null;
 295             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 296                 return openRoadmOtnInterface.createOpenRoadmOdu2Interface(
 297                     nodeId, logicalConnPoint, servicename, payLoad, isNetworkPort, tribPortNumber, tribSlotIndex);
 298             default:
 299                 return null;
 300         }
 301     }
 302
 303     public String createOpenRoadmOdu2eInterface(String nodeId, String logicalConnPoint, String servicename,
 304             String payLoad, boolean isNetworkPort, int tribPortNumber, int tribSlotIndex)
 305             throws OpenRoadmInterfaceException {
 306         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 307             case StringConstants.OPENROADM_DEVICE_VERSION_1_2_1:
 308                 LOG.error(OTN_FUNTIONS_ARE_NOT_SUPPORTED_BY_OPENROADM_MODELS_1_2_1_MSG);
 309                 return null;
 310             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 311                 return openRoadmOtnInterface.createOpenRoadmOdu2eInterface(
 312                         nodeId, logicalConnPoint, servicename, payLoad, isNetworkPort, tribPortNumber, tribSlotIndex);
 313             default:
 314                 return null;
 315         }
 316
 317     }
 318
 319     public String createOpenRoadmOtnOdu4Interface(String nodeId, String logicalConnPoint, String supportingOtuInterface)
 320             throws OpenRoadmInterfaceException {
 321         switch (mappingUtils.getOpenRoadmVersion(nodeId)) {
 322             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 323                 return openRoadmInterface221
 324                         .createOpenRoadmOtnOdu4Interface(nodeId, logicalConnPoint, supportingOtuInterface);
 325             default:
 326                 return null;
 327         }
 328     }
 329
 330     public String createOpenRoadmOtnOdu4Interface(String anodeId, String alogicalConnPoint,
 331             String asupportingOtuInterface, String znodeId, String zlogicalConnPoint)
 332             throws OpenRoadmInterfaceException {
 333         switch (mappingUtils.getOpenRoadmVersion(anodeId)) {
 334             case StringConstants.OPENROADM_DEVICE_VERSION_2_2_1:
 335                 return openRoadmInterface221
 336                     .createOpenRoadmOtnOdu4Interface(anodeId, alogicalConnPoint, asupportingOtuInterface,
 337                         znodeId, zlogicalConnPoint);
 338             default:
 339                 return null;
 340         }
 341     }
 342 }