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