openecomp-be/api/openecomp-sdc-rest-webapp/vendor-license-rest/vendor-license-rest-services/src/main/java/org/openecomp/sdcrests/vendorlicense/rest/services/VendorLicenseModelsImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdcrests.vendorlicense.rest.services;
  22
  23 import org.openecomp.core.util.UniqueValueUtil;
  24 import org.openecomp.sdc.activitylog.ActivityLogManager;
  25 import org.openecomp.sdc.activitylog.ActivityLogManagerFactory;
  26 import org.openecomp.sdc.activitylog.dao.type.ActivityLogEntity;
  27 import org.openecomp.sdc.activitylog.dao.type.ActivityType;
  28 import org.openecomp.sdc.common.errors.Messages;
  29 import org.openecomp.sdc.datatypes.model.ItemType;
  30 import org.openecomp.sdc.healing.factory.HealingManagerFactory;
  31 import org.openecomp.sdc.itempermissions.ItemPermissionsManager;
  32 import org.openecomp.sdc.itempermissions.ItemPermissionsManagerFactory;
  33 import org.openecomp.sdc.itempermissions.impl.types.PermissionTypes;
  34 import org.openecomp.sdc.logging.api.Logger;
  35 import org.openecomp.sdc.logging.api.LoggerFactory;
  36 import org.openecomp.sdc.logging.context.MdcUtil;
  37 import org.openecomp.sdc.logging.context.impl.MdcDataDebugMessage;
  38 import org.openecomp.sdc.logging.messages.AuditMessages;
  39 import org.openecomp.sdc.logging.types.LoggerServiceName;
  40 import org.openecomp.sdc.notification.dtos.Event;
  41 import org.openecomp.sdc.notification.factories.NotificationPropagationManagerFactory;
  42 import org.openecomp.sdc.notification.services.NotificationPropagationManager;
  43 import org.openecomp.sdc.vendorlicense.VendorLicenseConstants;
  44 import org.openecomp.sdc.vendorlicense.VendorLicenseManager;
  45 import org.openecomp.sdc.vendorlicense.VendorLicenseManagerFactory;
  46 import org.openecomp.sdc.vendorlicense.dao.types.VendorLicenseModelEntity;
  47 import org.openecomp.sdc.versioning.ItemManager;
  48 import org.openecomp.sdc.versioning.ItemManagerFactory;
  49 import org.openecomp.sdc.versioning.VersioningManager;
  50 import org.openecomp.sdc.versioning.VersioningManagerFactory;
  51 import org.openecomp.sdc.versioning.dao.types.Version;
  52 import org.openecomp.sdc.versioning.dao.types.VersionStatus;
  53 import org.openecomp.sdc.versioning.types.Item;
  54 import org.openecomp.sdc.versioning.types.NotificationEventTypes;
  55 import org.openecomp.sdcrests.item.rest.mapping.MapItemToDto;
  56 import org.openecomp.sdcrests.item.rest.mapping.MapVersionToDto;
  57 import org.openecomp.sdcrests.item.types.ItemCreationDto;
  58 import org.openecomp.sdcrests.item.types.ItemDto;
  59 import org.openecomp.sdcrests.item.types.VersionDto;
  60 import org.openecomp.sdcrests.vendorlicense.rest.VendorLicenseModels;
  61 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelEntityToDto;
  62 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity;
  63 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto;
  64 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelEntityDto;
  65 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelRequestDto;
  66 import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
  67 import org.springframework.context.annotation.Scope;
  68 import org.springframework.stereotype.Service;
  69 import org.springframework.validation.annotation.Validated;
  70
  71 import javax.inject.Named;
  72 import javax.ws.rs.core.Response;
  73 import java.util.HashMap;
  74 import java.util.Map;
  75 import java.util.Optional;
  76 import java.util.function.Predicate;
  77
  78 import static org.openecomp.sdc.itempermissions.notifications.NotificationConstants.PERMISSION_USER;
  79 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_ID;
  80 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_NAME;
  81 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.SUBMIT_DESCRIPTION;
  82 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_ID;
  83 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_NAME;
  84
  85 @Named
  86 @Service("vendorLicenseModels")
  87 @Scope(value = "prototype")
  88 @Validated
  89 public class VendorLicenseModelsImpl implements VendorLicenseModels {
  90
  91   private static MdcDataDebugMessage mdcDataDebugMessage = new MdcDataDebugMessage();
  92   private static final Logger logger = LoggerFactory.getLogger(VendorLicenseModelsImpl.class);
  93   public static final String SUBMIT_ITEM = "Submit_Item";
  94
  95   private ItemPermissionsManager permissionsManager = ItemPermissionsManagerFactory.getInstance()
  96       .createInterface();
  97   private NotificationPropagationManager notifier =
  98       NotificationPropagationManagerFactory.getInstance().createInterface();
  99
 100   private ItemManager itemManager = ItemManagerFactory.getInstance().createInterface();
 101   private VersioningManager versioningManager =
 102       VersioningManagerFactory.getInstance().createInterface();
 103   private VendorLicenseManager vendorLicenseManager =
 104       VendorLicenseManagerFactory.getInstance().createInterface();
 105   private ActivityLogManager activityLogManager =
 106       ActivityLogManagerFactory.getInstance().createInterface();
 107
 108   @Override
 109   public Response listLicenseModels(String versionStatus, String user) {
 110     mdcDataDebugMessage.debugEntryMessage(null);
 111     MdcUtil.initMdc(LoggerServiceName.List_VLM.toString());
 112
 113     Predicate<Item> itemPredicate;
 114     if (VersionStatus.Certified.name().equals(versionStatus)) {
 115       itemPredicate = item -> ItemType.vlm.name().equals(item.getType()) &&
 116           item.getVersionStatusCounters().containsKey(VersionStatus.Certified);
 117
 118     } else if (VersionStatus.Draft.name().equals(versionStatus)) {
 119       itemPredicate = item -> ItemType.vlm.name().equals(item.getType()) &&
 120           item.getVersionStatusCounters().containsKey(VersionStatus.Draft) &&
 121           userHasPermission(item.getId(), user);
 122
 123     } else {
 124       itemPredicate = item -> ItemType.vlm.name().equals(item.getType());
 125     }
 126
 127     GenericCollectionWrapper<ItemDto> results = new GenericCollectionWrapper<>();
 128     MapItemToDto mapper = new MapItemToDto();
 129     itemManager.list(itemPredicate).stream()
 130         .sorted((o1, o2) -> o2.getModificationTime().compareTo(o1.getModificationTime()))
 131         .forEach(vspItem -> results.add(mapper.applyMapping(vspItem, ItemDto.class)));
 132
 133     mdcDataDebugMessage.debugExitMessage(null);
 134     return Response.ok(results).build();
 135   }
 136
 137   @Override
 138   public Response createLicenseModel(VendorLicenseModelRequestDto request, String user) {
 139     mdcDataDebugMessage.debugEntryMessage(null);
 140     logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.CREATE_VLM + request.getVendorName());
 141     MdcUtil.initMdc(LoggerServiceName.Create_VLM.toString());
 142
 143     Item item = new Item();
 144     item.setType(ItemType.vlm.name());
 145     item.setName(request.getVendorName());
 146     item.setDescription(request.getDescription());
 147
 148     UniqueValueUtil
 149         .validateUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 150     item = itemManager.create(item);
 151     UniqueValueUtil
 152         .createUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 153
 154     Version version = versioningManager.create(item.getId(), new Version(), null);
 155
 156     VendorLicenseModelEntity vlm = new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 157         .applyMapping(request, VendorLicenseModelEntity.class);
 158     vlm.setId(item.getId());
 159     vlm.setVersion(version);
 160
 161     vendorLicenseManager.createVendorLicenseModel(vlm);
 162     versioningManager.publish(item.getId(), version, "Initial vlm:" + vlm.getVendorName());
 163
 164     ItemCreationDto itemCreationDto = new ItemCreationDto();
 165     itemCreationDto.setItemId(item.getId());
 166     itemCreationDto.setVersion(new MapVersionToDto().applyMapping(version, VersionDto.class));
 167
 168     activityLogManager.logActivity(new ActivityLogEntity(vlm.getId(), version,
 169         ActivityType.Create, user, true, "", ""));
 170
 171     mdcDataDebugMessage.debugExitMessage(null);
 172     return Response.ok(itemCreationDto).build();
 173   }
 174
 175   @Override
 176   public Response updateLicenseModel(VendorLicenseModelRequestDto request, String vlmId,
 177                                      String versionId, String user) {
 178     mdcDataDebugMessage.debugEntryMessage("VLM id", vlmId);
 179     MdcUtil.initMdc(LoggerServiceName.Update_VLM.toString());
 180
 181     VendorLicenseModelEntity vlm =
 182         new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 183             .applyMapping(request, VendorLicenseModelEntity.class);
 184     vlm.setId(vlmId);
 185     vlm.setVersion(new Version(versionId));
 186
 187     vendorLicenseManager.updateVendorLicenseModel(vlm);
 188
 189     mdcDataDebugMessage.debugExitMessage("VLM id", vlmId);
 190     return Response.ok().build();
 191   }
 192
 193   @Override
 194   public Response getLicenseModel(String vlmId, String versionId, String user) {
 195     mdcDataDebugMessage.debugEntryMessage("VLM id", vlmId);
 196     MdcUtil.initMdc(LoggerServiceName.Get_VLM.toString());
 197
 198     Version version = versioningManager.get(vlmId, new Version(versionId));
 199     VendorLicenseModelEntity vlm = vendorLicenseManager.getVendorLicenseModel(vlmId, version);
 200     vlm.setWritetimeMicroSeconds(version.getModificationTime().getTime());
 201
 202     try {
 203       Optional<Version> healedVersion = HealingManagerFactory.getInstance().createInterface()
 204           .healItemVersion(vlmId, version, ItemType.vlm, false);
 205       healedVersion.ifPresent(vlm::setVersion);
 206
 207       if (healedVersion.isPresent() && version.getStatus() == VersionStatus.Certified) {
 208         try {
 209           submit(vlmId, healedVersion.get(), "Submit after heal", user);
 210         } catch (Exception ex) {
 211           logger.error("VLM Id {}: Error while submitting version {} " +
 212                   "created based on Certified version {} for healing purpose.",
 213               vlmId, healedVersion.get().getId(), versionId, ex.getMessage());
 214         }
 215       }
 216     } catch (Exception e) {
 217       logger.error(String.format("Error while auto healing VLM with Id %s and version %s: %s",
 218           vlmId, versionId, e.getMessage()));
 219     }
 220
 221     VendorLicenseModelEntityDto vlmDto =
 222         new MapVendorLicenseModelEntityToDto().applyMapping(vlm, VendorLicenseModelEntityDto.class);
 223
 224     mdcDataDebugMessage.debugExitMessage("VLM id", vlmId);
 225     return Response.ok(vlmDto).build();
 226   }
 227
 228   @Override
 229   public Response deleteLicenseModel(String vlmId, String versionId, String user) {
 230     mdcDataDebugMessage.debugEntryMessage("VLM id", vlmId);
 231
 232     MdcUtil.initMdc(LoggerServiceName.Delete_VLM.toString());
 233     vendorLicenseManager.deleteVendorLicenseModel(vlmId, new Version(versionId));
 234
 235     mdcDataDebugMessage.debugExitMessage("VLM id", vlmId);
 236
 237     return Response.ok().build();
 238   }
 239
 240   @Override
 241   public Response actOnLicenseModel(VendorLicenseModelActionRequestDto request, String vlmId,
 242                                     String versionId, String user) {
 243     Version version = new Version(versionId);
 244
 245     switch (request.getAction()) {
 246       case Submit:
 247         if (!permissionsManager.isAllowed(vlmId, user, SUBMIT_ITEM)) {
 248           return Response.status(Response.Status.FORBIDDEN).entity
 249               (new Exception(Messages.PERMISSIONS_ERROR.getErrorMessage())).build();
 250         }
 251         String message =
 252             request.getSubmitRequest() == null ? "" : request.getSubmitRequest().getMessage();
 253         submit(vlmId, version, message, user);
 254
 255         notifyUsers(vlmId, version, message, user, NotificationEventTypes.SUBMIT);
 256         break;
 257       default:
 258     }
 259
 260     return Response.ok().build();
 261   }
 262
 263   private void submit(String vlmId, Version version, String message, String user) {
 264     MdcUtil.initMdc(LoggerServiceName.Submit_VLM.toString());
 265     logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.SUBMIT_VLM + vlmId);
 266
 267     vendorLicenseManager.validate(vlmId, version);
 268     versioningManager.submit(vlmId, version, message);
 269
 270     activityLogManager.logActivity(
 271         new ActivityLogEntity(vlmId, version, ActivityType.Submit, user, true, "", message));
 272   }
 273
 274   private void notifyUsers(String itemId, Version version, String message,
 275                            String userName, NotificationEventTypes eventType) {
 276     Map<String, Object> eventProperties = new HashMap<>();
 277     eventProperties.put(ITEM_NAME, itemManager.get(itemId).getName());
 278     eventProperties.put(ITEM_ID, itemId);
 279
 280     Version ver = versioningManager.get(itemId, version);
 281     eventProperties.put(VERSION_NAME, ver.getName());
 282     eventProperties.put(VERSION_ID, ver.getId());
 283
 284     eventProperties.put(SUBMIT_DESCRIPTION, message);
 285     eventProperties.put(PERMISSION_USER, userName);
 286
 287     Event syncEvent = new SyncEvent(eventType.getEventName(), itemId, eventProperties, itemId);
 288     try {
 289       notifier.notifySubscribers(syncEvent, userName);
 290     } catch (Exception e) {
 291       logger.error("Failed to send sync notification to users subscribed o item '" + itemId);
 292     }
 293   }
 294
 295   private class SyncEvent implements Event {
 296
 297     private String eventType;
 298     private String originatorId;
 299     private Map<String, Object> attributes;
 300     private String entityId;
 301
 302     public SyncEvent(String eventType, String originatorId,
 303                      Map<String, Object> attributes, String entityId) {
 304       this.eventType = eventType;
 305       this.originatorId = originatorId;
 306       this.attributes = attributes;
 307       this.entityId = entityId;
 308     }
 309
 310     @Override
 311     public String getEventType() {
 312       return eventType;
 313     }
 314
 315     @Override
 316     public String getOriginatorId() {
 317       return originatorId;
 318     }
 319
 320     @Override
 321     public Map<String, Object> getAttributes() {
 322       return attributes;
 323     }
 324
 325     @Override
 326     public String getEntityId() {
 327       return entityId;
 328     }
 329   }
 330
 331   private boolean userHasPermission(String itemId, String userId) {
 332     String permission = permissionsManager.getUserItemPermiission(itemId, userId);
 333     return (permission != null && permission
 334         .matches(PermissionTypes.Contributor.name() + "|" + PermissionTypes.Owner.name()));
 335   }
 336 }