gerrit.onap Code Review - dcaegen2/collectors/datafile.git/blob

   1 /*-
   2  * ============LICENSE_START========================================================================
   3  * Copyright (C) 2018 NOKIA Intellectual Property, 2018-2019 Nordix Foundation. All rights reserved.
   4  * ==================================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END=========================================================
  17  */
  18
  19 package org.onap.dcaegen2.collectors.datafile.service;
  20
  21 import com.google.gson.JsonArray;
  22 import com.google.gson.JsonElement;
  23 import com.google.gson.JsonObject;
  24 import com.google.gson.JsonParser;
  25
  26 import java.net.URI;
  27 import java.util.ArrayList;
  28 import java.util.List;
  29 import java.util.Optional;
  30 import java.util.stream.StreamSupport;
  31
  32 import org.onap.dcaegen2.collectors.datafile.ftp.Scheme;
  33 import org.onap.dcaegen2.collectors.datafile.model.FileData;
  34 import org.onap.dcaegen2.collectors.datafile.model.FileReadyMessage;
  35 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFileData;
  36 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFileReadyMessage;
  37 import org.onap.dcaegen2.collectors.datafile.model.ImmutableMessageMetaData;
  38 import org.onap.dcaegen2.collectors.datafile.model.MessageMetaData;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41 import org.springframework.util.StringUtils;
  42
  43 import reactor.core.publisher.Flux;
  44 import reactor.core.publisher.Mono;
  45
  46 /**
  47  * Parses the fileReady event and creates a Flux of FileReadyMessage containing the information.
  48  *
  49  * @author <a href="mailto:henrik.b.andersson@est.tech">Henrik Andersson</a>
  50  */
  51 public class JsonMessageParser {
  52     private static final Logger logger = LoggerFactory.getLogger(JsonMessageParser.class);
  53
  54     private static final String COMMON_EVENT_HEADER = "commonEventHeader";
  55     private static final String EVENT_NAME = "eventName";
  56     private static final String LAST_EPOCH_MICROSEC = "lastEpochMicrosec";
  57     private static final String SOURCE_NAME = "sourceName";
  58     private static final String START_EPOCH_MICROSEC = "startEpochMicrosec";
  59     private static final String TIME_ZONE_OFFSET = "timeZoneOffset";
  60
  61     private static final String EVENT = "event";
  62     private static final String NOTIFICATION_FIELDS = "notificationFields";
  63     private static final String CHANGE_IDENTIFIER = "changeIdentifier";
  64     private static final String CHANGE_TYPE = "changeType";
  65     private static final String NOTIFICATION_FIELDS_VERSION = "notificationFieldsVersion";
  66
  67     private static final String ARRAY_OF_NAMED_HASH_MAP = "arrayOfNamedHashMap";
  68     private static final String NAME = "name";
  69     private static final String HASH_MAP = "hashMap";
  70     private static final String LOCATION = "location";
  71     private static final String COMPRESSION = "compression";
  72     private static final String FILE_FORMAT_TYPE = "fileFormatType";
  73     private static final String FILE_FORMAT_VERSION = "fileFormatVersion";
  74
  75     private static final String FILE_READY_CHANGE_TYPE = "FileReady";
  76     private static final String FILE_READY_CHANGE_IDENTIFIER = "PM_MEAS_FILES";
  77
  78     /**
  79      * The data types available in the event name.
  80      */
  81     private enum EventNameDataType {
  82         PRODUCT_NAME(1), VENDOR_NAME(2);
  83
  84         private int index;
  85
  86         EventNameDataType(int index) {
  87             this.index = index;
  88         }
  89     }
  90
  91     /**
  92      * Parses the Json message and returns a stream of messages.
  93      *
  94      * @param rawMessage the Json message to parse.
  95      * @return a <code>Flux</code> containing messages.
  96      */
  97     public Flux<FileReadyMessage> getMessagesFromJson(Mono<String> rawMessage) {
  98         return rawMessage.flatMapMany(this::getJsonParserMessage).flatMap(this::createMessageData);
  99     }
 100
 101     Optional<JsonObject> getJsonObjectFromAnArray(JsonElement element) {
 102         JsonParser jsonParser = new JsonParser();
 103         if (element.isJsonPrimitive()) {
 104             return Optional.of(jsonParser.parse(element.getAsString()).getAsJsonObject());
 105         } else if (element.isJsonObject()) {
 106             return Optional.of((JsonObject) element);
 107         } else {
 108             return Optional.of(jsonParser.parse(element.toString()).getAsJsonObject());
 109         }
 110     }
 111
 112     private Flux<FileReadyMessage> getMessagesFromJsonArray(JsonElement jsonElement) {
 113         return createMessages(
 114                 Flux.defer(() -> Flux.fromStream(StreamSupport.stream(jsonElement.getAsJsonArray().spliterator(), false)
 115                         .map(jsonElementFromArray -> getJsonObjectFromAnArray(jsonElementFromArray)
 116                                 .orElseGet(JsonObject::new)))));
 117     }
 118
 119     /**
 120      * Extract info from string and create a Flux of {@link FileReadyMessage}.
 121      *
 122      * @param rawMessage - results from DMaaP
 123      * @return reactive Flux of FileReadyMessages
 124      */
 125     private Flux<FileReadyMessage> createMessageData(JsonElement jsonElement) {
 126         return jsonElement.isJsonObject() ? createMessages(Flux.just(jsonElement.getAsJsonObject()))
 127                 : getMessagesFromJsonArray(jsonElement);
 128     }
 129
 130     private Mono<JsonElement> getJsonParserMessage(String message) {
 131         logger.trace("original message from message router: {}", message);
 132         return StringUtils.isEmpty(message) ? Mono.empty() : Mono.fromSupplier(() -> new JsonParser().parse(message));
 133     }
 134
 135     private Flux<FileReadyMessage> createMessages(Flux<JsonObject> jsonObject) {
 136         return jsonObject.flatMap(monoJsonP -> containsNotificationFields(monoJsonP) ? transformMessages(monoJsonP)
 137                 : logErrorAndReturnEmptyMessageFlux("Incorrect JsonObject - missing header. " + jsonObject));
 138     }
 139
 140
 141     private Mono<FileReadyMessage> transformMessages(JsonObject message) {
 142         Optional<MessageMetaData> optionalMessageMetaData = getMessageMetaData(message);
 143         if (optionalMessageMetaData.isPresent()) {
 144             MessageMetaData messageMetaData = optionalMessageMetaData.get();
 145             JsonObject notificationFields = message.getAsJsonObject(EVENT).getAsJsonObject(NOTIFICATION_FIELDS);
 146             JsonArray arrayOfNamedHashMap = notificationFields.getAsJsonArray(ARRAY_OF_NAMED_HASH_MAP);
 147             if (arrayOfNamedHashMap != null) {
 148                 List<FileData> allFileDataFromJson = getAllFileDataFromJson(arrayOfNamedHashMap, messageMetaData);
 149                 if (!allFileDataFromJson.isEmpty()) {
 150                     return Mono.just(ImmutableFileReadyMessage.builder() //
 151                             .files(allFileDataFromJson) //
 152                             .build());
 153                 } else {
 154                     return Mono.empty();
 155                 }
 156             }
 157
 158             logger.error("VES event parsing. Missing arrayOfNamedHashMap in message. {}", message);
 159             return Mono.empty();
 160         }
 161         logger.error("VES event parsing. FileReady event has incorrect JsonObject. {}", message);
 162         return Mono.empty();
 163     }
 164
 165
 166     private Optional<MessageMetaData> getMessageMetaData(JsonObject message) {
 167         List<String> missingValues = new ArrayList<>();
 168         JsonObject commonEventHeader = message.getAsJsonObject(EVENT).getAsJsonObject(COMMON_EVENT_HEADER);
 169         String eventName = getValueFromJson(commonEventHeader, EVENT_NAME, missingValues);
 170
 171         JsonObject notificationFields = message.getAsJsonObject(EVENT).getAsJsonObject(NOTIFICATION_FIELDS);
 172         String changeIdentifier = getValueFromJson(notificationFields, CHANGE_IDENTIFIER, missingValues);
 173         String changeType = getValueFromJson(notificationFields, CHANGE_TYPE, missingValues);
 174
 175         // Just to check that it is in the message. Might be needed in the future if there is a new
 176         // version.
 177         getValueFromJson(notificationFields, NOTIFICATION_FIELDS_VERSION, missingValues);
 178
 179         MessageMetaData messageMetaData = ImmutableMessageMetaData.builder() //
 180                 .productName(getDataFromEventName(EventNameDataType.PRODUCT_NAME, eventName, missingValues)) //
 181                 .vendorName(getDataFromEventName(EventNameDataType.VENDOR_NAME, eventName, missingValues)) //
 182                 .lastEpochMicrosec(getValueFromJson(commonEventHeader, LAST_EPOCH_MICROSEC, missingValues)) //
 183                 .sourceName(getValueFromJson(commonEventHeader, SOURCE_NAME, missingValues)) //
 184                 .startEpochMicrosec(getValueFromJson(commonEventHeader, START_EPOCH_MICROSEC, missingValues)) //
 185                 .timeZoneOffset(getValueFromJson(commonEventHeader, TIME_ZONE_OFFSET, missingValues)) //
 186                 .changeIdentifier(changeIdentifier) //
 187                 .changeType(changeType) //
 188                 .build();
 189         if (missingValues.isEmpty() && isChangeIdentifierCorrect(changeIdentifier) && isChangeTypeCorrect(changeType)) {
 190             return Optional.of(messageMetaData);
 191         } else {
 192             String errorMessage = "VES event parsing.";
 193             if (!missingValues.isEmpty()) {
 194                 errorMessage += " Missing data: " + missingValues;
 195             }
 196             if (!isChangeIdentifierCorrect(changeIdentifier) || !isChangeTypeCorrect(changeType)) {
 197                 errorMessage += " Change identifier or change type is wrong.";
 198             }
 199             errorMessage += " Message: {}";
 200             logger.error(errorMessage, message);
 201             return Optional.empty();
 202         }
 203     }
 204
 205     private boolean isChangeTypeCorrect(String changeType) {
 206         return FILE_READY_CHANGE_TYPE.equals(changeType);
 207     }
 208
 209     private boolean isChangeIdentifierCorrect(String changeIdentifier) {
 210         return FILE_READY_CHANGE_IDENTIFIER.equals(changeIdentifier);
 211     }
 212
 213     private List<FileData> getAllFileDataFromJson(JsonArray arrayOfAdditionalFields, MessageMetaData messageMetaData) {
 214         List<FileData> res = new ArrayList<>();
 215         for (int i = 0; i < arrayOfAdditionalFields.size(); i++) {
 216             JsonObject fileInfo = (JsonObject) arrayOfAdditionalFields.get(i);
 217             Optional<FileData> fileData = getFileDataFromJson(fileInfo, messageMetaData);
 218
 219             if (fileData.isPresent()) {
 220                 res.add(fileData.get());
 221             }
 222         }
 223         return res;
 224     }
 225
 226     private Optional<FileData> getFileDataFromJson(JsonObject fileInfo, MessageMetaData messageMetaData) {
 227         logger.trace("starting to getFileDataFromJson!");
 228
 229         List<String> missingValues = new ArrayList<>();
 230         JsonObject data = fileInfo.getAsJsonObject(HASH_MAP);
 231
 232         String location = getValueFromJson(data, LOCATION, missingValues);
 233         Scheme scheme;
 234         try {
 235             scheme = Scheme.getSchemeFromString(URI.create(location).getScheme());
 236         } catch (Exception e) {
 237             logger.error("VES event parsing.", e);
 238             return Optional.empty();
 239         }
 240         FileData fileData = ImmutableFileData.builder() //
 241                 .name(getValueFromJson(fileInfo, NAME, missingValues)) //
 242                 .fileFormatType(getValueFromJson(data, FILE_FORMAT_TYPE, missingValues)) //
 243                 .fileFormatVersion(getValueFromJson(data, FILE_FORMAT_VERSION, missingValues)) //
 244                 .location(location) //
 245                 .scheme(scheme) //
 246                 .compression(getValueFromJson(data, COMPRESSION, missingValues)) //
 247                 .messageMetaData(messageMetaData)
 248                 .build();
 249         if (missingValues.isEmpty()) {
 250             return Optional.of(fileData);
 251         }
 252         logger.error("VES event parsing. File information wrong. Missing data: {} Data: {}", missingValues, fileInfo);
 253         return Optional.empty();
 254     }
 255
 256     /**
 257      * Gets data from the event name.
 258      * Defined as: {DomainAbbreviation}_{productName}-{vendorName}_{Description}, example:
 259      * Noti_RnNode-Ericsson_FileReady
 260      *
 261      * @param dataType The type of data to get, {@link DmaapConsumerJsonParser.EventNameDataType}.
 262      * @param eventName The event name to get the data from.
 263      * @param missingValues List of missing values. The dataType will be added if missing.
 264      * @return String of data from event name
 265      */
 266     private String getDataFromEventName(EventNameDataType dataType, String eventName, List<String> missingValues) {
 267         String[] eventArray = eventName.split("_|-");
 268         if (eventArray.length >= 4) {
 269             return eventArray[dataType.index];
 270         } else {
 271             missingValues.add(dataType.toString());
 272             logger.error("Can not get {} from eventName, eventName is not in correct format: {}", dataType, eventName);
 273         }
 274         return "";
 275     }
 276
 277     private String getValueFromJson(JsonObject jsonObject, String jsonKey, List<String> missingValues) {
 278         if (jsonObject.has(jsonKey)) {
 279             return jsonObject.get(jsonKey).getAsString();
 280         } else {
 281             missingValues.add(jsonKey);
 282             return "";
 283         }
 284     }
 285
 286     private boolean containsNotificationFields(JsonObject jsonObject) {
 287         return jsonObject.has(EVENT) && jsonObject.getAsJsonObject(EVENT).has(NOTIFICATION_FIELDS);
 288     }
 289
 290     private Flux<FileReadyMessage> logErrorAndReturnEmptyMessageFlux(String errorMessage) {
 291         logger.error(errorMessage);
 292         return Flux.empty();
 293     }
 294 }