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