sdnr/wt/devicemanager-openroadm/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/devicemanager/openroadm/impl/PmDataBuilderOpenRoadm.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * ONAP : ccsdk features
   4  * ================================================================================
   5  * Copyright (C) 2020 highstreet technologies GmbH Intellectual Property.
   6  * All rights reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  *
  21  */
  22 package org.onap.ccsdk.features.sdnr.wt.devicemanager.openroadm.impl;
  23
  24 import java.net.URL;
  25 import java.util.ArrayList;
  26 import java.util.Collection;
  27 import java.util.Enumeration;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31 import org.onap.ccsdk.features.sdnr.wt.common.YangHelper;
  32 import org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.NetconfBindingAccessor;
  33 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev191129.HistoricalPmList;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev191129.historical.pm.group.HistoricalPm;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev191129.historical.pm.list.HistoricalPmEntry;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.rev191129.historical.pm.val.group.Measurement;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev191129.PmDataType;
  39 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev191129.PmGranularity;
  40 import org.opendaylight.yang.gen.v1.http.org.openroadm.pm.types.rev191129.PmNamesEnum;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.g836.pm.types.rev200413.ErroredSecond;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.g836.pm.types.rev200413.SeverelyErroredSecond;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.openroadm.pm.types.rev200413.PerformanceMeasurementTypeId;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.GranularityPeriodType;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.PmdataEntity;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.PmdataEntityBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.pmdata.entity.PerformanceDataBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.pmdata.grp.MeasurementBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.pmdata.grp.MeasurementKey;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.units.rev200413.Celsius;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.units.rev200413.DB;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.units.rev200413.DBm;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.units.rev200413.Fahrenheit;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.units.rev200413.KHz;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.units.rev200413.MW;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.units.rev200413.PerformanceMeasurementUnitId;
  57 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  58 import org.osgi.framework.Bundle;
  59 import org.osgi.framework.BundleContext;
  60 import org.osgi.framework.FrameworkUtil;
  61 import org.slf4j.Logger;
  62 import org.slf4j.LoggerFactory;
  63
  64 /**
  65  * @author shabnam
  66  *
  67  *         Reading Openroadm PM data and returning as PmDataEntitiy data
  68  */
  69 public class PmDataBuilderOpenRoadm {
  70     // variables
  71     private static final Logger log = LoggerFactory.getLogger(PmDataBuilderOpenRoadm.class);
  72     private PmdataEntityBuilder pmDataBuilder;
  73     private Bundle b = FrameworkUtil.getBundle(this.getClass());
  74     // end of variables
  75
  76     // constructors
  77     public PmDataBuilderOpenRoadm(NetconfBindingAccessor accessor) {
  78         this.pmDataBuilder = new PmdataEntityBuilder();
  79         this.pmDataBuilder.setNodeName(accessor.getNodeId().getValue());
  80     }
  81     // end of constructors
  82
  83     // public methods
  84     // Instantiate historical PM data list
  85     public HistoricalPmList getPmData(NetconfBindingAccessor accessor) {
  86         final Class<HistoricalPmList> pmDataClass = HistoricalPmList.class;
  87         log.info("Get PM data for element {}", accessor.getNodeId().getValue());
  88         InstanceIdentifier<HistoricalPmList> pmDataIid = InstanceIdentifier.builder(pmDataClass).build();
  89         return accessor.getTransactionUtils().readData(accessor.getDataBroker(), LogicalDatastoreType.OPERATIONAL,
  90                 pmDataIid);
  91
  92     }
  93
  94     // Build PM entity for writing into the database
  95     public List<PmdataEntity> buildPmDataEntity(HistoricalPmList historicalPmEnitityList) {
  96         List<PmdataEntity> pmEntitiyList = new ArrayList<>();
  97         Collection<HistoricalPmEntry> pmDataEntryList =
  98                 YangHelper.getCollection(historicalPmEnitityList.getHistoricalPmEntry());
  99         for (HistoricalPmEntry pmDataEntry : pmDataEntryList) {
 100             pmDataBuilder.setUuidInterface(pmDataEntry.getPmResourceType().getName());
 101             Collection<HistoricalPm> historicalPmList = YangHelper.getCollection(pmDataEntry.getHistoricalPm());
 102             for (HistoricalPm historicalPm : historicalPmList) {
 103                 log.info("PmName:{}", historicalPm.getType());
 104
 105                 try {
 106                     writeperformanceData(historicalPm);
 107                 } catch (ClassNotFoundException e) {
 108                     log.info("No relevant data found");
 109                 }
 110                 pmEntitiyList.add(this.pmDataBuilder.build());
 111
 112                 log.info("PmListSize before db writing: {}", pmEntitiyList.size());
 113             }
 114             log.info("PmListSize before db writing: {}", pmEntitiyList.size());
 115         }
 116         return pmEntitiyList;
 117     }
 118     // end of public methods
 119
 120     // private methods
 121     //    Build performance data of Data provider by mapping values from device
 122     private void writeperformanceData(HistoricalPm historicalPm) throws ClassNotFoundException {
 123         Collection<Measurement> measurementList = YangHelper.getCollection(historicalPm.getMeasurement());
 124         Map<MeasurementKey, org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.pmdata.grp.Measurement> measurementMap =
 125                 new HashMap<>();
 126         // Map Performance data of PmDataEntity with MeasurmentData-HistoricalPm
 127         PerformanceDataBuilder performanceDataBuilder = new PerformanceDataBuilder();
 128         for (Measurement measurementData : measurementList) {
 129             this.pmDataBuilder.setGranularityPeriod(mapGranularityPeriod(measurementData.getGranularity()))
 130                     .setTimeStamp(measurementData.getCompletionTime());
 131             if (measurementData.getValidity().getName().equals("suspect")) {
 132                 this.pmDataBuilder.setSuspectIntervalFlag(true);
 133             }
 134             measurementMap.put(
 135                     new MeasurementKey(measurementBuilder(historicalPm.getType(), measurementData.getPmParameterUnit(),
 136                             measurementData.getPmParameterValue()).getPmKey()),
 137                     measurementBuilder(historicalPm.getType(), measurementData.getPmParameterUnit(),
 138                             measurementData.getPmParameterValue()));
 139
 140
 141         }
 142
 143         pmDataBuilder.setPerformanceData(performanceDataBuilder.setMeasurement(measurementMap).build());
 144     }
 145
 146
 147
 148     // Mapping Granularity period of PmDataEntity with PmGranularity of MeasurmentData-HistoricalPm
 149     private GranularityPeriodType mapGranularityPeriod(PmGranularity pmGranularity) {
 150
 151         GranularityPeriodType granPeriod = null;
 152         switch (pmGranularity.getName()) {
 153             case ("notApplicable"):
 154                 granPeriod = GranularityPeriodType.Unknown;
 155                 break;
 156             case ("15min"):
 157                 granPeriod = GranularityPeriodType.Period15Min;
 158                 break;
 159             case ("24Hour"):
 160                 granPeriod = GranularityPeriodType.Period24Hours;
 161                 break;
 162             default:
 163                 granPeriod = GranularityPeriodType.Period15Min;
 164                 break;
 165         }
 166         return granPeriod;
 167     }
 168
 169
 170     // Build the measurement list of data provider based on various values from device
 171     private org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.pmdata.grp.Measurement measurementBuilder(
 172             PmNamesEnum pmType, String pmUnit, PmDataType pmDataType) {
 173
 174         MeasurementBuilder measBuilder = new MeasurementBuilder();
 175         if (pmType.getName().equals("erroredSeconds")) {
 176             measBuilder.setPmKey(ErroredSecond.class);
 177         } else if (pmType.getName().equals("severelyErroredSeconds")) {
 178             measBuilder.setPmKey(SeverelyErroredSecond.class);
 179         } else {
 180             for (Class<? extends PerformanceMeasurementTypeId> obj : setMeasurementTypeId()) {
 181                 if (obj.toString().contains(pmType.name())) {
 182                     measBuilder.setPmKey(obj);
 183                 }
 184             }
 185         }
 186         measBuilder.setPmUnit(setMeasurementUnit(pmUnit));
 187         measBuilder.setPmValue(pmDataType);
 188         return measBuilder.build();
 189
 190     }
 191     // Find the proper PerformanceMeasurementTypeId class based on the PmNames Enum value from device
 192     private List<Class<? extends PerformanceMeasurementTypeId>> setMeasurementTypeId() {
 193         String packageName =
 194                 "org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.openroadm.pm.types.rev200413";
 195         String packageName1 =
 196                 "/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/data/provider/openroadm/pm/types/rev200413/";
 197         List<Class<? extends PerformanceMeasurementTypeId>> measTypeObjList = new ArrayList<>();
 198         URL root = Thread.currentThread().getContextClassLoader().getResource(packageName1);
 199
 200         log.info("path for type package: {}", root);
 201
 202         Enumeration<URL> results = getFileURL(b, packageName);
 203         log.info("FOund Packages {}", results);
 204         if (results != null) {
 205             while (results.hasMoreElements()) {
 206                 URL path = results.nextElement();
 207
 208                 Class<?> cls1 = loadClass(b, path.getFile());
 209
 210                 if (PerformanceMeasurementTypeId.class.isAssignableFrom(cls1)) {
 211                     measTypeObjList.add((Class<? extends PerformanceMeasurementTypeId>) cls1);
 212
 213
 214                 }
 215                 if (cls1 != null) {
 216                     log.info("Class Added {}", cls1.getSimpleName());
 217                 }
 218
 219             }
 220
 221
 222         }
 223
 224         return measTypeObjList;
 225     }
 226
 227     //Map matching PerformanceMeasurementUnitId class based on the string value from device
 228     private Class<? extends PerformanceMeasurementUnitId> setMeasurementUnit(String unitName) {
 229         Class<? extends PerformanceMeasurementUnitId> measurementUnitClass = null;
 230         switch (unitName) {
 231             case ("celsius"):
 232                 measurementUnitClass = Celsius.class;
 233                 break;
 234             case ("dB"):
 235                 measurementUnitClass = DB.class;
 236                 break;
 237             case ("dBm"):
 238                 measurementUnitClass = DBm.class;
 239                 break;
 240             case ("fahrenheit"):
 241                 measurementUnitClass = Fahrenheit.class;
 242                 break;
 243             case ("kHz"):
 244                 measurementUnitClass = KHz.class;
 245                 break;
 246             case ("mW"):
 247                 measurementUnitClass = MW.class;
 248                 break;
 249             default:
 250                 break;
 251         }
 252         return measurementUnitClass;
 253     }
 254
 255
 256     private Class<?> loadClass(Bundle bundle, String classFilePath) {
 257         String className = classFilePath.replaceFirst("^/", "").replace('/', '.').replaceFirst(".class$", "");
 258         try {
 259             return bundle.loadClass(className);
 260         } catch (Exception e) {
 261             log.info(String.format("Class [%s] could not be loaded. Message: [%s].", className, e.getMessage()));
 262         }
 263         return null;
 264     }
 265
 266     private static Enumeration<URL> getFileURL(Bundle b, String classPath) {
 267
 268         BundleContext context = b == null ? null : b.getBundleContext();
 269         if (context == null) {
 270             log.info("no bundle context available");
 271             return null;
 272         }
 273         Bundle[] bundles = context.getBundles();
 274         if (bundles == null || bundles.length <= 0) {
 275             log.info("no bundles found");
 276             return null;
 277         }
 278         log.info("found {} bundles", bundles.length);
 279         Enumeration<URL> resultUrl = null;
 280
 281         for (Bundle bundle : bundles) {
 282             resultUrl = bundle.findEntries("/" + classPath.replace(".", "/"), "*.class", false);
 283             if (resultUrl != null) {
 284                 break;
 285
 286             }
 287
 288         }
 289
 290         return resultUrl;
 291     }
 292
 293
 294     // end of private methods
 295 }
 296