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.messages.AuditMessages;
  38 import org.openecomp.sdc.logging.types.LoggerServiceName;
  39 import org.openecomp.sdc.notification.dtos.Event;
  40 import org.openecomp.sdc.notification.factories.NotificationPropagationManagerFactory;
  41 import org.openecomp.sdc.notification.services.NotificationPropagationManager;
  42 import org.openecomp.sdc.vendorlicense.VendorLicenseConstants;
  43 import org.openecomp.sdc.vendorlicense.VendorLicenseManager;
  44 import org.openecomp.sdc.vendorlicense.VendorLicenseManagerFactory;
  45 import org.openecomp.sdc.vendorlicense.dao.types.VendorLicenseModelEntity;
  46 import org.openecomp.sdc.versioning.ItemManager;
  47 import org.openecomp.sdc.versioning.ItemManagerFactory;
  48 import org.openecomp.sdc.versioning.VersioningManager;
  49 import org.openecomp.sdc.versioning.VersioningManagerFactory;
  50 import org.openecomp.sdc.versioning.dao.types.Version;
  51 import org.openecomp.sdc.versioning.dao.types.VersionStatus;
  52 import org.openecomp.sdc.versioning.types.Item;
  53 import org.openecomp.sdc.versioning.types.NotificationEventTypes;
  54 import org.openecomp.sdcrests.item.rest.mapping.MapItemToDto;
  55 import org.openecomp.sdcrests.item.rest.mapping.MapVersionToDto;
  56 import org.openecomp.sdcrests.item.types.ItemCreationDto;
  57 import org.openecomp.sdcrests.item.types.ItemDto;
  58 import org.openecomp.sdcrests.item.types.VersionDto;
  59 import org.openecomp.sdcrests.vendorlicense.rest.VendorLicenseModels;
  60 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelEntityToDto;
  61 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity;
  62 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto;
  63 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelEntityDto;
  64 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelRequestDto;
  65 import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
  66 import org.springframework.context.annotation.Scope;
  67 import org.springframework.stereotype.Service;
  68 import org.springframework.validation.annotation.Validated;
  69
  70 import javax.inject.Named;
  71 import javax.ws.rs.core.Response;
  72 import java.util.HashMap;
  73 import java.util.Map;
  74 import java.util.Optional;
  75 import java.util.function.Predicate;
  76
  77 import static org.openecomp.sdc.itempermissions.notifications.NotificationConstants.PERMISSION_USER;
  78 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_ID;
  79 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_NAME;
  80 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.SUBMIT_DESCRIPTION;
  81 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_ID;
  82 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_NAME;
  83 import static org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto.VendorLicenseModelAction.Submit;
  84
  85 @Named
  86 @Service("vendorLicenseModels")
  87 @Scope(value = "prototype")
  88 @Validated
  89 public class VendorLicenseModelsImpl implements VendorLicenseModels {
  90
  91   private static final String VLM_ID = "VLM id";
  92   private static final String SUBMIT_ITEM_ACTION = "Submit_Item";
  93   private static final String SUBMIT_HEALED_VERSION_ERROR =
  94       "VLM Id %s: Error while submitting version %s created based on Certified version %s for healing purpose.";
  95   private static final Logger LOGGER = LoggerFactory.getLogger(VendorLicenseModelsImpl.class);
  96   private ItemPermissionsManager permissionsManager = ItemPermissionsManagerFactory.getInstance()
  97       .createInterface();
  98   private NotificationPropagationManager notifier =
  99       NotificationPropagationManagerFactory.getInstance().createInterface();
 100
 101   private ItemManager itemManager = ItemManagerFactory.getInstance().createInterface();
 102   private VersioningManager versioningManager =
 103       VersioningManagerFactory.getInstance().createInterface();
 104   private VendorLicenseManager vendorLicenseManager =
 105       VendorLicenseManagerFactory.getInstance().createInterface();
 106   private ActivityLogManager activityLogManager =
 107       ActivityLogManagerFactory.getInstance().createInterface();
 108
 109   @Override
 110   public Response listLicenseModels(String versionStatus, String user) {
 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     return Response.ok(results).build();
 133   }
 134
 135   @Override
 136   public Response createLicenseModel(VendorLicenseModelRequestDto request, String user) {
 137     LOGGER.audit(AuditMessages.AUDIT_MSG + AuditMessages.CREATE_VLM + request.getVendorName());
 138     MdcUtil.initMdc(LoggerServiceName.Create_VLM.toString());
 139
 140     Item item = new Item();
 141     item.setType(ItemType.vlm.name());
 142     item.setOwner(user);
 143     item.setName(request.getVendorName());
 144     item.setDescription(request.getDescription());
 145
 146     UniqueValueUtil
 147         .validateUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 148     item = itemManager.create(item);
 149     UniqueValueUtil
 150         .createUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 151
 152     Version version = versioningManager.create(item.getId(), new Version(), null);
 153
 154     VendorLicenseModelEntity vlm = new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 155         .applyMapping(request, VendorLicenseModelEntity.class);
 156     vlm.setId(item.getId());
 157     vlm.setVersion(version);
 158
 159     vendorLicenseManager.createVendorLicenseModel(vlm);
 160     versioningManager.publish(item.getId(), version, "Initial vlm:" + vlm.getVendorName());
 161
 162     ItemCreationDto itemCreationDto = new ItemCreationDto();
 163     itemCreationDto.setItemId(item.getId());
 164     itemCreationDto.setVersion(new MapVersionToDto().applyMapping(version, VersionDto.class));
 165
 166     activityLogManager.logActivity(new ActivityLogEntity(vlm.getId(), version,
 167         ActivityType.Create, user, true, "", ""));
 168     return Response.ok(itemCreationDto).build();
 169   }
 170
 171   @Override
 172   public Response updateLicenseModel(VendorLicenseModelRequestDto request, String vlmId,
 173                                      String versionId, String user) {
 174     MdcUtil.initMdc(LoggerServiceName.Update_VLM.toString());
 175
 176     VendorLicenseModelEntity vlm =
 177         new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 178             .applyMapping(request, VendorLicenseModelEntity.class);
 179     vlm.setId(vlmId);
 180     vlm.setVersion(new Version(versionId));
 181
 182     vendorLicenseManager.updateVendorLicenseModel(vlm);
 183     return Response.ok().build();
 184   }
 185
 186   @Override
 187   public Response getLicenseModel(String vlmId, String versionId, String user) {
 188     MdcUtil.initMdc(LoggerServiceName.Get_VLM.toString());
 189
 190     Version version = versioningManager.get(vlmId, new Version(versionId));
 191     VendorLicenseModelEntity vlm = vendorLicenseManager.getVendorLicenseModel(vlmId, version);
 192     vlm.setWritetimeMicroSeconds(version.getModificationTime().getTime());
 193
 194     try {
 195       Optional<Version> healedVersion = HealingManagerFactory.getInstance().createInterface()
 196           .healItemVersion(vlmId, version, ItemType.vlm, false);
 197
 198       if (healedVersion.isPresent()) {
 199         vlm.setVersion(healedVersion.get());
 200         if (version.getStatus() == VersionStatus.Certified) {
 201           submitHealedVersion(vlmId, healedVersion.get(), versionId, user);
 202         }
 203       }
 204     } catch (Exception e) {
 205       LOGGER.error(
 206           String.format("Error while auto healing VLM with Id %s and version %s", vlmId, versionId),
 207           e);
 208     }
 209
 210     VendorLicenseModelEntityDto vlmDto =
 211         new MapVendorLicenseModelEntityToDto().applyMapping(vlm, VendorLicenseModelEntityDto.class);
 212     return Response.ok(vlmDto).build();
 213   }
 214
 215   @Override
 216   public Response deleteLicenseModel(String vlmId, String versionId, String user) {
 217     MdcUtil.initMdc(LoggerServiceName.Delete_VLM.toString());
 218     vendorLicenseManager.deleteVendorLicenseModel(vlmId, new Version(versionId));
 219     return Response.ok().build();
 220   }
 221
 222   @Override
 223   public Response actOnLicenseModel(VendorLicenseModelActionRequestDto request, String vlmId,
 224                                     String versionId, String user) {
 225     Version version = new Version(versionId);
 226
 227     if (request.getAction() == Submit) {
 228       if (!permissionsManager.isAllowed(vlmId, user, SUBMIT_ITEM_ACTION)) {
 229         return Response.status(Response.Status.FORBIDDEN)
 230             .entity(new Exception(Messages.PERMISSIONS_ERROR.getErrorMessage())).build();
 231       }
 232       String message =
 233           request.getSubmitRequest() == null ? "Submit" : request.getSubmitRequest().getMessage();
 234       submit(vlmId, version, message, user);
 235
 236       notifyUsers(vlmId, version, message, user, NotificationEventTypes.SUBMIT);
 237
 238     }
 239     return Response.ok().build();
 240   }
 241
 242   private void submit(String vlmId, Version version, String message, String user) {
 243     MdcUtil.initMdc(LoggerServiceName.Submit_VLM.toString());
 244     LOGGER.audit(AuditMessages.AUDIT_MSG + AuditMessages.SUBMIT_VLM + vlmId);
 245
 246     vendorLicenseManager.validate(vlmId, version);
 247     versioningManager.submit(vlmId, version, message);
 248
 249     activityLogManager.logActivity(
 250         new ActivityLogEntity(vlmId, version, ActivityType.Submit, user, true, "", message));
 251   }
 252
 253   private void submitHealedVersion(String vlmId, Version healedVersion, String baseVersionId,
 254                                    String user) {
 255     try {
 256       submit(vlmId, healedVersion, "Submit after heal", user);
 257     } catch (Exception ex) {
 258       LOGGER.error(
 259           String.format(SUBMIT_HEALED_VERSION_ERROR, vlmId, healedVersion.getId(), baseVersionId),
 260           ex);
 261     }
 262   }
 263
 264   private void notifyUsers(String itemId, Version version, String message,
 265                            String userName, NotificationEventTypes eventType) {
 266     Map<String, Object> eventProperties = new HashMap<>();
 267     eventProperties.put(ITEM_NAME, itemManager.get(itemId).getName());
 268     eventProperties.put(ITEM_ID, itemId);
 269
 270     Version ver = versioningManager.get(itemId, version);
 271     eventProperties.put(VERSION_NAME, ver.getName());
 272     eventProperties.put(VERSION_ID, ver.getId());
 273
 274     eventProperties.put(SUBMIT_DESCRIPTION, message);
 275     eventProperties.put(PERMISSION_USER, userName);
 276
 277     Event syncEvent = new SyncEvent(eventType.getEventName(), itemId, eventProperties, itemId);
 278     try {
 279       notifier.notifySubscribers(syncEvent, userName);
 280     } catch (Exception e) {
 281       LOGGER.error("Failed to send sync notification to users subscribed o item '" + itemId);
 282     }
 283   }
 284
 285   private class SyncEvent implements Event {
 286
 287     private String eventType;
 288     private String originatorId;
 289     private Map<String, Object> attributes;
 290     private String entityId;
 291
 292     public SyncEvent(String eventType, String originatorId,
 293                      Map<String, Object> attributes, String entityId) {
 294       this.eventType = eventType;
 295       this.originatorId = originatorId;
 296       this.attributes = attributes;
 297       this.entityId = entityId;
 298     }
 299
 300     @Override
 301     public String getEventType() {
 302       return eventType;
 303     }
 304
 305     @Override
 306     public String getOriginatorId() {
 307       return originatorId;
 308     }
 309
 310     @Override
 311     public Map<String, Object> getAttributes() {
 312       return attributes;
 313     }
 314
 315     @Override
 316     public String getEntityId() {
 317       return entityId;
 318     }
 319   }
 320
 321   private boolean userHasPermission(String itemId, String userId) {
 322     String permission = permissionsManager.getUserItemPermiission(itemId, userId);
 323     return (permission != null && permission
 324         .matches(PermissionTypes.Contributor.name() + "|" + PermissionTypes.Owner.name()));
 325   }
 326 }