gerrit.onap Code Review - sdc.git/blob

   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.setOwner(user);
 146     item.setName(request.getVendorName());
 147     item.setDescription(request.getDescription());
 148
 149     UniqueValueUtil
 150         .validateUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 151     item = itemManager.create(item);
 152     UniqueValueUtil
 153         .createUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 154
 155     Version version = versioningManager.create(item.getId(), new Version(), null);
 156
 157     VendorLicenseModelEntity vlm = new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 158         .applyMapping(request, VendorLicenseModelEntity.class);
 159     vlm.setId(item.getId());
 160     vlm.setVersion(version);
 161
 162     vendorLicenseManager.createVendorLicenseModel(vlm);
 163     versioningManager.publish(item.getId(), version, "Initial vlm:" + vlm.getVendorName());
 164
 165     ItemCreationDto itemCreationDto = new ItemCreationDto();
 166     itemCreationDto.setItemId(item.getId());
 167     itemCreationDto.setVersion(new MapVersionToDto().applyMapping(version, VersionDto.class));
 168
 169     activityLogManager.logActivity(new ActivityLogEntity(vlm.getId(), version,
 170         ActivityType.Create, user, true, "", ""));
 171
 172     mdcDataDebugMessage.debugExitMessage(null);
 173     return Response.ok(itemCreationDto).build();
 174   }
 175
 176   @Override
 177   public Response updateLicenseModel(VendorLicenseModelRequestDto request, String vlmId,
 178                                      String versionId, String user) {
 179     mdcDataDebugMessage.debugEntryMessage("VLM id", vlmId);
 180     MdcUtil.initMdc(LoggerServiceName.Update_VLM.toString());
 181
 182     VendorLicenseModelEntity vlm =
 183         new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 184             .applyMapping(request, VendorLicenseModelEntity.class);
 185     vlm.setId(vlmId);
 186     vlm.setVersion(new Version(versionId));
 187
 188     vendorLicenseManager.updateVendorLicenseModel(vlm);
 189
 190     mdcDataDebugMessage.debugExitMessage("VLM id", vlmId);
 191     return Response.ok().build();
 192   }
 193
 194   @Override
 195   public Response getLicenseModel(String vlmId, String versionId, String user) {
 196     mdcDataDebugMessage.debugEntryMessage("VLM id", vlmId);
 197     MdcUtil.initMdc(LoggerServiceName.Get_VLM.toString());
 198
 199     Version version = versioningManager.get(vlmId, new Version(versionId));
 200     VendorLicenseModelEntity vlm = vendorLicenseManager.getVendorLicenseModel(vlmId, version);
 201     vlm.setWritetimeMicroSeconds(version.getModificationTime().getTime());
 202
 203     try {
 204       Optional<Version> healedVersion = HealingManagerFactory.getInstance().createInterface()
 205           .healItemVersion(vlmId, version, ItemType.vlm, false);
 206       healedVersion.ifPresent(vlm::setVersion);
 207
 208       if (healedVersion.isPresent() && version.getStatus() == VersionStatus.Certified) {
 209         try {
 210           submit(vlmId, healedVersion.get(), "Submit after heal", user);
 211         } catch (Exception ex) {
 212           logger.error("VLM Id {}: Error while submitting version {} " +
 213                   "created based on Certified version {} for healing purpose.",
 214               vlmId, healedVersion.get().getId(), versionId, ex.getMessage());
 215         }
 216       }
 217     } catch (Exception e) {
 218       logger.error(String.format("Error while auto healing VLM with Id %s and version %s: %s",
 219           vlmId, versionId, e.getMessage()));
 220     }
 221
 222     VendorLicenseModelEntityDto vlmDto =
 223         new MapVendorLicenseModelEntityToDto().applyMapping(vlm, VendorLicenseModelEntityDto.class);
 224
 225     mdcDataDebugMessage.debugExitMessage("VLM id", vlmId);
 226     return Response.ok(vlmDto).build();
 227   }
 228
 229   @Override
 230   public Response deleteLicenseModel(String vlmId, String versionId, String user) {
 231     mdcDataDebugMessage.debugEntryMessage("VLM id", vlmId);
 232
 233     MdcUtil.initMdc(LoggerServiceName.Delete_VLM.toString());
 234     vendorLicenseManager.deleteVendorLicenseModel(vlmId, new Version(versionId));
 235
 236     mdcDataDebugMessage.debugExitMessage("VLM id", vlmId);
 237
 238     return Response.ok().build();
 239   }
 240
 241   @Override
 242   public Response actOnLicenseModel(VendorLicenseModelActionRequestDto request, String vlmId,
 243                                     String versionId, String user) {
 244     Version version = new Version(versionId);
 245
 246     switch (request.getAction()) {
 247       case Submit:
 248         if (!permissionsManager.isAllowed(vlmId, user, SUBMIT_ITEM)) {
 249           return Response.status(Response.Status.FORBIDDEN).entity
 250               (new Exception(Messages.PERMISSIONS_ERROR.getErrorMessage())).build();
 251         }
 252         String message =
 253             request.getSubmitRequest() == null ? "" : request.getSubmitRequest().getMessage();
 254         submit(vlmId, version, message, user);
 255
 256         notifyUsers(vlmId, version, message, user, NotificationEventTypes.SUBMIT);
 257         break;
 258       default:
 259     }
 260
 261     return Response.ok().build();
 262   }
 263
 264   private void submit(String vlmId, Version version, String message, String user) {
 265     MdcUtil.initMdc(LoggerServiceName.Submit_VLM.toString());
 266     logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.SUBMIT_VLM + vlmId);
 267
 268     vendorLicenseManager.validate(vlmId, version);
 269     versioningManager.submit(vlmId, version, message);
 270
 271     activityLogManager.logActivity(
 272         new ActivityLogEntity(vlmId, version, ActivityType.Submit, user, true, "", message));
 273   }
 274
 275   private void notifyUsers(String itemId, Version version, String message,
 276                            String userName, NotificationEventTypes eventType) {
 277     Map<String, Object> eventProperties = new HashMap<>();
 278     eventProperties.put(ITEM_NAME, itemManager.get(itemId).getName());
 279     eventProperties.put(ITEM_ID, itemId);
 280
 281     Version ver = versioningManager.get(itemId, version);
 282     eventProperties.put(VERSION_NAME, ver.getName());
 283     eventProperties.put(VERSION_ID, ver.getId());
 284
 285     eventProperties.put(SUBMIT_DESCRIPTION, message);
 286     eventProperties.put(PERMISSION_USER, userName);
 287
 288     Event syncEvent = new SyncEvent(eventType.getEventName(), itemId, eventProperties, itemId);
 289     try {
 290       notifier.notifySubscribers(syncEvent, userName);
 291     } catch (Exception e) {
 292       logger.error("Failed to send sync notification to users subscribed o item '" + itemId);
 293     }
 294   }
 295
 296   private class SyncEvent implements Event {
 297
 298     private String eventType;
 299     private String originatorId;
 300     private Map<String, Object> attributes;
 301     private String entityId;
 302
 303     public SyncEvent(String eventType, String originatorId,
 304                      Map<String, Object> attributes, String entityId) {
 305       this.eventType = eventType;
 306       this.originatorId = originatorId;
 307       this.attributes = attributes;
 308       this.entityId = entityId;
 309     }
 310
 311     @Override
 312     public String getEventType() {
 313       return eventType;
 314     }
 315
 316     @Override
 317     public String getOriginatorId() {
 318       return originatorId;
 319     }
 320
 321     @Override
 322     public Map<String, Object> getAttributes() {
 323       return attributes;
 324     }
 325
 326     @Override
 327     public String getEntityId() {
 328       return entityId;
 329     }
 330   }
 331
 332   private boolean userHasPermission(String itemId, String userId) {
 333     String permission = permissionsManager.getUserItemPermiission(itemId, userId);
 334     return (permission != null && permission
 335         .matches(PermissionTypes.Contributor.name() + "|" + PermissionTypes.Owner.name()));
 336   }
 337 }