olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils221.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 package org.opendaylight.transportpce.olm.util;
   9
  10 import com.google.common.base.Strings;
  11 import java.util.ArrayList;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.Optional;
  15 import java.util.stream.Collectors;
  16 import java.util.stream.Stream;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  19 import org.opendaylight.transportpce.common.Timeouts;
  20 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  21 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.GetPmInput;
  22 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.GetPmOutputBuilder;
  23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.get.pm.output.Measurements;
  24 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.get.pm.output.MeasurementsBuilder;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.OrgOpenroadmDeviceData;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.Ports;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.PortsKey;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacks;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacksKey;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.Interface;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.interfaces.grp.InterfaceKey;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.internal.links.InternalLink;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.internal.links.InternalLinkKey;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.OrgOpenroadmDevice;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.Degree;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.DegreeKey;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnections;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.RoadmConnectionsKey;
  39 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.SharedRiskGroup;
  40 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.SharedRiskGroupKey;
  41 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.physical.links.PhysicalLink;
  42 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.physical.links.PhysicalLinkKey;
  43 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.shelves.Shelves;
  44 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.shelves.ShelvesKey;
  45 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.CurrentPmList;
  46 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.group.CurrentPm;
  47 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.list.CurrentPmEntry;
  48 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.list.CurrentPmEntryKey;
  49 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev181019.current.pm.val.group.Measurement;
  50 import org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev161014.ResourceTypeEnum;
  51 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev210930.Direction;
  52 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev210930.Location;
  53 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev210930.PmNamesEnum;
  54 import org.opendaylight.yang.gen.v1.http.org.transportpce.common.types.rev210930.olm.get.pm.input.ResourceIdentifier;
  55 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  56 import org.opendaylight.yangtools.yang.common.Uint16;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 final class OlmUtils221 {
  61
  62     private static final Logger LOG = LoggerFactory.getLogger(OlmUtils221.class);
  63
  64     /**
  65      * This method retrieves list of current PMs for given nodeId,
  66      * resourceType, resourceName and Granularity.Currently vendorExtentions
  67      * are excluded but can be added back based on requirement
  68      *
  69      * <p>
  70      * 1. pmFetch This operation traverse through current PM list and gets PM for
  71      * given NodeId and Resource name
  72      *
  73      * @param input
  74      *            Input parameter from the olm yang model get-pm rpc
  75      * @param deviceTransactionManager
  76      *            Device tx manager
  77      *
  78      * @return Result of the request list of PM readings
  79      */
  80     public static GetPmOutputBuilder pmFetch(GetPmInput input, DeviceTransactionManager deviceTransactionManager) {
  81         LOG.info("Getting PM Data for 2.2.1 NodeId: {} ResourceType: {} ResourceName: {}", input.getNodeId(),
  82                 input.getResourceType(), input.getResourceIdentifier());
  83
  84         GetPmOutputBuilder pmOutputBuilder = new GetPmOutputBuilder();
  85
  86         InstanceIdentifier<?> resourceKeyIID =
  87                 findClassKeyIdentifiers(input.getResourceType(), input.getResourceIdentifier());
  88         if (resourceKeyIID == null) {
  89             return pmOutputBuilder;
  90         }
  91         CurrentPmEntryKey resourceKey = new CurrentPmEntryKey(resourceKeyIID,
  92                 convertResourceTypeEnum(input.getResourceType()),"");
  93         InstanceIdentifier<CurrentPmList> iidCurrentPmList = InstanceIdentifier.create(CurrentPmList.class);
  94
  95         Optional<CurrentPmList> currentPmListOpt = deviceTransactionManager.getDataFromDevice(input.getNodeId(),
  96                 LogicalDatastoreType.OPERATIONAL, iidCurrentPmList, Timeouts.DEVICE_READ_TIMEOUT,
  97                 Timeouts.DEVICE_READ_TIMEOUT_UNIT);
  98         if (currentPmListOpt.isPresent()) {
  99             CurrentPmList currentPmList = currentPmListOpt.get();
 100             @NonNull
 101             Map<CurrentPmEntryKey,CurrentPmEntry> currentPmEntryList = currentPmList.nonnullCurrentPmEntry();
 102             LOG.info("Current PM list exists for node {} and contains {} entries.", input.getNodeId(),
 103                     currentPmEntryList.size());
 104             for (Map.Entry<CurrentPmEntryKey, CurrentPmEntry> entry : currentPmEntryList.entrySet()) {
 105                 CurrentPmEntry cpe = entry.getValue();
 106                 CurrentPmEntryKey cpek = new CurrentPmEntryKey(cpe.getPmResourceInstance(), cpe.getPmResourceType(),
 107                         "");
 108                 if (resourceKey.equals(cpek)) {
 109                     List<CurrentPm> currentPMList = new ArrayList<>(cpe.nonnullCurrentPm().values());
 110                     Stream<CurrentPm> currentPMStream = currentPMList.stream();
 111                     if (input.getPmNameType() != null) {
 112                         currentPMStream = currentPMStream.filter(pm -> pm.getType().getIntValue()
 113                                 == PmNamesEnum.forValue(input.getPmNameType().getIntValue()).getIntValue());
 114                     }
 115                     if (input.getPmExtension() != null) {
 116                         currentPMStream = currentPMStream.filter(pm -> pm.getExtension()
 117                                 .equals(input.getPmExtension()));
 118                     }
 119                     if (input.getLocation() != null) {
 120                         currentPMStream = currentPMStream.filter(pm -> Location.forValue(pm.getLocation()
 121                                 .getIntValue())
 122                                 .equals(Location.forValue(input.getLocation().getIntValue())));
 123                     }
 124                     if (input.getDirection() != null) {
 125                         currentPMStream = currentPMStream.filter(pm -> Direction.forValue(pm.getDirection()
 126                                 .getIntValue())
 127                                 .equals(Direction.forValue((input.getDirection().getIntValue()))));
 128                     }
 129                     List<CurrentPm> filteredPMs = currentPMStream.collect(Collectors.toList());
 130                     List<Measurements> measurements = extractWantedMeasurements(filteredPMs,input.getGranularity());
 131                     if (measurements.isEmpty()) {
 132                         LOG.error(
 133                                 "No Matching PM data found for node: {}, resource type: {}, resource name: {}, "
 134                                         + "pm type: {}, extention: {}, location: {} and direction: {}",
 135                                 input.getNodeId(), input.getResourceType(),
 136                                 getResourceIdentifierAsString(input.getResourceIdentifier()),
 137                                 input.getPmNameType(),input.getPmExtension(),input.getLocation(),
 138                                 input.getDirection());
 139                     } else {
 140                         pmOutputBuilder.setNodeId(input.getNodeId()).setResourceType(input.getResourceType())
 141                                 .setResourceIdentifier(input.getResourceIdentifier()).setGranularity(input
 142                                 .getGranularity())
 143                                 .setMeasurements(measurements);
 144                         LOG.info(
 145                                 "PM data found successfully for node: {}, resource type: {}, resource name: {}, "
 146                                         + "pm type: {}, extention: {}, location: {} and direction: {}",
 147                                 input.getNodeId(), input.getResourceType(),
 148                                 getResourceIdentifierAsString(input.getResourceIdentifier()),
 149                                 input.getPmNameType(),input.getPmExtension(),input.getLocation(),
 150                                 input.getDirection());
 151                     }
 152                 }
 153             }
 154         } else {
 155             LOG.error("Unable to get CurrentPmList for node {}", input.getNodeId());
 156         }
 157         return pmOutputBuilder;
 158     }
 159
 160     private static String getResourceIdentifierAsString(ResourceIdentifier resourceIdentifier) {
 161         if (Strings.isNullOrEmpty(resourceIdentifier.getCircuitPackName())) {
 162             return resourceIdentifier.getResourceName();
 163         } else {
 164             return resourceIdentifier.getResourceName() + ", circuit pack name: "
 165                     + resourceIdentifier.getCircuitPackName();
 166         }
 167     }
 168
 169     private static List<Measurements> extractWantedMeasurements(List<CurrentPm> currentPmList,
 170         org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev161014.PmGranularity wantedGranularity) {
 171         List<Measurements> olmMeasurements = new ArrayList<>();
 172         for (CurrentPm pm : currentPmList) {
 173             for (Measurement measurements: pm.nonnullMeasurement().values()) {
 174                 if (measurements.getGranularity().getIntValue()
 175                         == org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev171215.PmGranularity.forValue(
 176                         wantedGranularity.getIntValue()).getIntValue()) {
 177                     MeasurementsBuilder pmMeasureBuilder = new MeasurementsBuilder();
 178                     pmMeasureBuilder.setPmparameterName(pm.getType().name());
 179                     pmMeasureBuilder.setPmparameterValue(measurements.getPmParameterValue().stringValue());
 180                     olmMeasurements.add(pmMeasureBuilder.build());
 181                 }
 182             }
 183         }
 184         return olmMeasurements;
 185     }
 186
 187     private static InstanceIdentifier<?> findClassKeyIdentifiers(ResourceTypeEnum wantedResourceType,
 188             ResourceIdentifier wantedResourceIdentifier) {
 189         if (wantedResourceIdentifier.getResourceName() == null) {
 190             LOG.debug("resource {} is null", wantedResourceType);
 191             return null;
 192         }
 193         switch (wantedResourceType) {
 194             case Device:
 195                 return InstanceIdentifier
 196                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 197                     .build();
 198             case Degree:
 199                 return InstanceIdentifier
 200                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 201                     .child(Degree.class, new DegreeKey(Uint16.valueOf(wantedResourceIdentifier.getResourceName())))
 202                     .build();
 203             case SharedRiskGroup:
 204                 return InstanceIdentifier
 205                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 206                     .child(
 207                         SharedRiskGroup.class,
 208                         new SharedRiskGroupKey(Uint16.valueOf(wantedResourceIdentifier.getResourceName())))
 209                     .build();
 210             case Connection:
 211                 return InstanceIdentifier
 212                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 213                     .child(RoadmConnections.class, new RoadmConnectionsKey(wantedResourceIdentifier.getResourceName()))
 214                     .build();
 215             case CircuitPack:
 216                 return InstanceIdentifier
 217                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 218                     .child(CircuitPacks.class, new CircuitPacksKey(wantedResourceIdentifier.getResourceName()))
 219                     .build();
 220             case Port:
 221                 return InstanceIdentifier
 222                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 223                     .child(CircuitPacks.class, new CircuitPacksKey(wantedResourceIdentifier.getCircuitPackName()))
 224                     .child(Ports.class, new PortsKey(wantedResourceIdentifier.getResourceName()))
 225                     .build();
 226             case Interface:
 227                 return InstanceIdentifier
 228                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 229                     .child(Interface.class, new InterfaceKey(wantedResourceIdentifier.getResourceName()))
 230                     .build();
 231             case InternalLink:
 232                 return InstanceIdentifier
 233                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 234                     .child(InternalLink.class, new InternalLinkKey(wantedResourceIdentifier.getResourceName()))
 235                     .build();
 236             case PhysicalLink:
 237                 return InstanceIdentifier
 238                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 239                     .child(PhysicalLink.class, new PhysicalLinkKey(wantedResourceIdentifier.getResourceName()))
 240                     .build();
 241             case Shelf:
 242                 return InstanceIdentifier
 243                     .builderOfInherited(OrgOpenroadmDeviceData.class, OrgOpenroadmDevice.class)
 244                     .child(Shelves.class, new ShelvesKey(wantedResourceIdentifier.getResourceName()))
 245                     .build();
 246             default:
 247                 LOG.error("Unknown resource type {}", wantedResourceType);
 248                 return null;
 249         }
 250     }
 251
 252     private static org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum
 253         convertResourceTypeEnum(ResourceTypeEnum wantedResourceType) {
 254         switch (wantedResourceType) {
 255             case Device:
 256                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum.Device;
 257             case Degree:
 258                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum.Degree;
 259             case SharedRiskGroup:
 260                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 261                         .ResourceTypeEnum.SharedRiskGroup;
 262             case Connection:
 263                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 264                         .ResourceTypeEnum.Connection;
 265             case CircuitPack:
 266                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 267                         .ResourceTypeEnum.CircuitPack;
 268             case Port:
 269                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum.Port;
 270             case Interface:
 271                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 272                         .ResourceTypeEnum.Interface;
 273             case InternalLink:
 274                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 275                         .ResourceTypeEnum.InternalLink;
 276             case PhysicalLink:
 277                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 278                         .ResourceTypeEnum.PhysicalLink;
 279             case Shelf:
 280                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum.Shelf;
 281             default:
 282                 LOG.error("Unknown resource type {}", wantedResourceType);
 283                 return null;
 284         }
 285     }
 286
 287     private OlmUtils221() {
 288     }
 289
 290 }