olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils22.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 OlmUtils22 {
  60
  61     private static final Logger LOG = LoggerFactory.getLogger(OlmUtils22.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     //LOG.info message length is >120 char and can be difficultly shortened
  80     @SuppressWarnings("checkstyle:linelength")
  81     public static GetPmOutputBuilder pmFetch(GetPmInput input, DeviceTransactionManager deviceTransactionManager) {
  82         LOG.info("Getting PM Data for 2.2.1 NodeId: {} ResourceType: {} ResourceName: {}", input.getNodeId(),
  83             input.getResourceType(), input.getResourceIdentifier());
  84
  85         GetPmOutputBuilder pmOutputBuilder = new GetPmOutputBuilder();
  86
  87         InstanceIdentifier<?> resourceKeyIID =
  88             findClassKeyIdentifiers(input.getResourceType(), input.getResourceIdentifier());
  89         CurrentPmEntryKey resourceKey = new CurrentPmEntryKey(resourceKeyIID,
  90             convertResourceTypeEnum(input.getResourceType()), "");
  91
  92         InstanceIdentifier<CurrentPmList> iidCurrentPmList = InstanceIdentifier.create(CurrentPmList.class);
  93
  94         Optional<CurrentPmList> currentPmListOpt = deviceTransactionManager.getDataFromDevice(input.getNodeId(),
  95             LogicalDatastoreType.OPERATIONAL, iidCurrentPmList, Timeouts.DEVICE_READ_TIMEOUT,
  96             Timeouts.DEVICE_READ_TIMEOUT_UNIT);
  97         if (currentPmListOpt.isPresent()) {
  98             CurrentPmList  currentPmList = currentPmListOpt.get();
  99
 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                     cpe.getPmResourceTypeExtension());
 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().getIntValue())
 121                             .equals(Location.forValue(input.getLocation().getIntValue())));
 122                     }
 123                     if (input.getDirection() != null) {
 124                         currentPMStream = currentPMStream.filter(pm -> Direction.forValue(pm.getDirection().getIntValue())
 125                             .equals(Direction.forValue((input.getDirection().getIntValue()))));
 126                     }
 127                     List<CurrentPm> filteredPMs = currentPMStream.collect(Collectors.toList());
 128                     List<Measurements> measurements = extractWantedMeasurements(filteredPMs,input.getGranularity());
 129                     if (measurements.isEmpty()) {
 130                         LOG.error(
 131                             "No Matching PM data found for node: {}, resource type: {}, resource name: {}, pm type: {}, extention: {}, location: {} and direction: {}",
 132                             input.getNodeId(), input.getResourceType(),
 133                             getResourceIdentifierAsString(input.getResourceIdentifier()),
 134                             input.getPmNameType(),input.getPmExtension(),input.getLocation(),
 135                             input.getDirection());
 136                     } else {
 137                         pmOutputBuilder.setNodeId(input.getNodeId()).setResourceType(input.getResourceType())
 138                             .setResourceIdentifier(input.getResourceIdentifier()).setGranularity(input.getGranularity())
 139                             .setMeasurements(measurements);
 140                         LOG.info(
 141                             "PM data found successfully for node: {}, resource type: {}, resource name: {}, pm type: {}, extention: {}, location: {} and direction: {}",
 142                             input.getNodeId(), input.getResourceType(),
 143                             getResourceIdentifierAsString(input.getResourceIdentifier()),
 144                             input.getPmNameType(),input.getPmExtension(),input.getLocation(),
 145                             input.getDirection());
 146                     }
 147                 }
 148             }
 149         } else {
 150             LOG.error("Unable to get CurrentPmList for node {}", input.getNodeId());
 151         }
 152         return pmOutputBuilder;
 153     }
 154
 155     private static String getResourceIdentifierAsString(ResourceIdentifier resourceIdentifier) {
 156         if (Strings.isNullOrEmpty(resourceIdentifier.getCircuitPackName())) {
 157             return resourceIdentifier.getResourceName();
 158         } else {
 159             return resourceIdentifier.getResourceName() + ", circuit pack name: "
 160                 + resourceIdentifier.getCircuitPackName();
 161         }
 162     }
 163
 164     private static List<Measurements> extractWantedMeasurements(List<CurrentPm> currentPmList,
 165         org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev161014.PmGranularity wantedGranularity) {
 166         List<Measurements> olmMeasurements = new ArrayList<>();
 167         for (CurrentPm pm : currentPmList) {
 168             for (Measurement measurements: pm.nonnullMeasurement().values()) {
 169                 if (measurements.getGranularity().getIntValue() == org.opendaylight.yang.gen.v1.http.org.openroadm.pm
 170                     .types.rev171215.PmGranularity.forValue(wantedGranularity.getIntValue()).getIntValue()) {
 171                     MeasurementsBuilder pmMeasureBuilder = new MeasurementsBuilder();
 172                     pmMeasureBuilder.setPmparameterName(pm.getType().name());
 173                     pmMeasureBuilder.setPmparameterValue(measurements.getPmParameterValue().stringValue());
 174                     olmMeasurements.add(pmMeasureBuilder.build());
 175                 }
 176             }
 177         }
 178         return olmMeasurements;
 179     }
 180
 181     private static InstanceIdentifier<?> findClassKeyIdentifiers(ResourceTypeEnum wantedResourceType,
 182         ResourceIdentifier wantedResourceIdentifier) {
 183         switch (wantedResourceType) {
 184             case Device:
 185                 return InstanceIdentifier.create(OrgOpenroadmDevice.class);
 186             case Degree:
 187                 return InstanceIdentifier.create(OrgOpenroadmDevice.class)
 188                     .child(Degree.class, new DegreeKey(Uint16.valueOf(wantedResourceIdentifier.getResourceName())));
 189             case SharedRiskGroup:
 190                 return InstanceIdentifier.create(OrgOpenroadmDevice.class)
 191                     .child(SharedRiskGroup.class,
 192                         new SharedRiskGroupKey(Uint16.valueOf(wantedResourceIdentifier.getResourceName())));
 193             case Connection:
 194                 return InstanceIdentifier.create(OrgOpenroadmDevice.class)
 195                     .child(RoadmConnections.class, new RoadmConnectionsKey(wantedResourceIdentifier.getResourceName()));
 196             case CircuitPack:
 197                 return InstanceIdentifier.create(OrgOpenroadmDevice.class)
 198                     .child(CircuitPacks.class, new CircuitPacksKey(wantedResourceIdentifier.getResourceName()));
 199             case Port:
 200                 return InstanceIdentifier.create(OrgOpenroadmDevice.class)
 201                     .child(CircuitPacks.class, new CircuitPacksKey(wantedResourceIdentifier.getCircuitPackName()))
 202                     .child(Ports.class, new PortsKey(wantedResourceIdentifier.getResourceName()));
 203             case Interface:
 204                 return InstanceIdentifier.create(OrgOpenroadmDevice.class)
 205                     .child(Interface.class, new InterfaceKey(wantedResourceIdentifier.getResourceName()));
 206             case InternalLink:
 207                 return InstanceIdentifier.create(OrgOpenroadmDevice.class)
 208                     .child(InternalLink.class, new InternalLinkKey(wantedResourceIdentifier.getResourceName()));
 209             case PhysicalLink:
 210                 return InstanceIdentifier.create(OrgOpenroadmDevice.class)
 211                     .child(PhysicalLink.class, new PhysicalLinkKey(wantedResourceIdentifier.getResourceName()));
 212             case Shelf:
 213                 return InstanceIdentifier.create(OrgOpenroadmDevice.class)
 214                     .child(Shelves.class, new ShelvesKey(wantedResourceIdentifier.getResourceName()));
 215             default:
 216                 LOG.error("Unknown resource type {}", wantedResourceType);
 217                 return null;
 218         }
 219     }
 220
 221     private static org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum
 222         convertResourceTypeEnum(ResourceTypeEnum wantedResourceType) {
 223         switch (wantedResourceType) {
 224             case Device:
 225                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum.Device;
 226             case Degree:
 227                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum.Degree;
 228             case SharedRiskGroup:
 229                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 230                     .ResourceTypeEnum.SharedRiskGroup;
 231             case Connection:
 232                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 233                     .ResourceTypeEnum.Connection;
 234             case CircuitPack:
 235                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 236                     .ResourceTypeEnum.CircuitPack;
 237             case Port:
 238                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum.Port;
 239             case Interface:
 240                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 241                     .ResourceTypeEnum.Interface;
 242             case InternalLink:
 243                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 244                     .ResourceTypeEnum.InternalLink;
 245             case PhysicalLink:
 246                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019
 247                     .ResourceTypeEnum.PhysicalLink;
 248             case Shelf:
 249                 return org.opendaylight.yang.gen.v1.http.org.openroadm.resource.types.rev181019.ResourceTypeEnum.Shelf;
 250             default:
 251                 LOG.error("Unknown resource type {}", wantedResourceType);
 252                 return null;
 253         }
 254     }
 255
 256     private OlmUtils22() {
 257     }
 258
 259 }