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 import static org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto.VendorLicenseModelAction.Submit;
  85
  86 @Named
  87 @Service("vendorLicenseModels")
  88 @Scope(value = "prototype")
  89 @Validated
  90 public class VendorLicenseModelsImpl implements VendorLicenseModels {
  91
  92   private static final String VLM_ID = "VLM id";
  93   private static final String SUBMIT_ITEM_ACTION = "Submit_Item";
  94   private static final String SUBMIT_HEALED_VERSION_ERROR =
  95       "VLM Id %s: Error while submitting version %s created based on Certified version %s for healing purpose.";
  96   private static final Logger LOGGER = LoggerFactory.getLogger(VendorLicenseModelsImpl.class);
  97   private static final MdcDataDebugMessage MDC_DATA_DEBUG_MESSAGE = new MdcDataDebugMessage();
  98
  99   private ItemPermissionsManager permissionsManager = ItemPermissionsManagerFactory.getInstance()
 100       .createInterface();
 101   private NotificationPropagationManager notifier =
 102       NotificationPropagationManagerFactory.getInstance().createInterface();
 103
 104   private ItemManager itemManager = ItemManagerFactory.getInstance().createInterface();
 105   private VersioningManager versioningManager =
 106       VersioningManagerFactory.getInstance().createInterface();
 107   private VendorLicenseManager vendorLicenseManager =
 108       VendorLicenseManagerFactory.getInstance().createInterface();
 109   private ActivityLogManager activityLogManager =
 110       ActivityLogManagerFactory.getInstance().createInterface();
 111
 112   @Override
 113   public Response listLicenseModels(String versionStatus, String user) {
 114     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage(null);
 115     MdcUtil.initMdc(LoggerServiceName.List_VLM.toString());
 116
 117     Predicate<Item> itemPredicate;
 118     if (VersionStatus.Certified.name().equals(versionStatus)) {
 119       itemPredicate = item -> ItemType.vlm.name().equals(item.getType()) &&
 120           item.getVersionStatusCounters().containsKey(VersionStatus.Certified);
 121
 122     } else if (VersionStatus.Draft.name().equals(versionStatus)) {
 123       itemPredicate = item -> ItemType.vlm.name().equals(item.getType()) &&
 124           item.getVersionStatusCounters().containsKey(VersionStatus.Draft) &&
 125           userHasPermission(item.getId(), user);
 126
 127     } else {
 128       itemPredicate = item -> ItemType.vlm.name().equals(item.getType());
 129     }
 130
 131     GenericCollectionWrapper<ItemDto> results = new GenericCollectionWrapper<>();
 132     MapItemToDto mapper = new MapItemToDto();
 133     itemManager.list(itemPredicate).stream()
 134         .sorted((o1, o2) -> o2.getModificationTime().compareTo(o1.getModificationTime()))
 135         .forEach(vspItem -> results.add(mapper.applyMapping(vspItem, ItemDto.class)));
 136
 137     MDC_DATA_DEBUG_MESSAGE.debugExitMessage(null);
 138     return Response.ok(results).build();
 139   }
 140
 141   @Override
 142   public Response createLicenseModel(VendorLicenseModelRequestDto request, String user) {
 143     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage(null);
 144     LOGGER.audit(AuditMessages.AUDIT_MSG + AuditMessages.CREATE_VLM + request.getVendorName());
 145     MdcUtil.initMdc(LoggerServiceName.Create_VLM.toString());
 146
 147     Item item = new Item();
 148     item.setType(ItemType.vlm.name());
 149     item.setOwner(user);
 150     item.setName(request.getVendorName());
 151     item.setDescription(request.getDescription());
 152
 153     UniqueValueUtil
 154         .validateUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 155     item = itemManager.create(item);
 156     UniqueValueUtil
 157         .createUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 158
 159     Version version = versioningManager.create(item.getId(), new Version(), null);
 160
 161     VendorLicenseModelEntity vlm = new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 162         .applyMapping(request, VendorLicenseModelEntity.class);
 163     vlm.setId(item.getId());
 164     vlm.setVersion(version);
 165
 166     vendorLicenseManager.createVendorLicenseModel(vlm);
 167     versioningManager.publish(item.getId(), version, "Initial vlm:" + vlm.getVendorName());
 168
 169     ItemCreationDto itemCreationDto = new ItemCreationDto();
 170     itemCreationDto.setItemId(item.getId());
 171     itemCreationDto.setVersion(new MapVersionToDto().applyMapping(version, VersionDto.class));
 172
 173     activityLogManager.logActivity(new ActivityLogEntity(vlm.getId(), version,
 174         ActivityType.Create, user, true, "", ""));
 175
 176     MDC_DATA_DEBUG_MESSAGE.debugExitMessage(null);
 177     return Response.ok(itemCreationDto).build();
 178   }
 179
 180   @Override
 181   public Response updateLicenseModel(VendorLicenseModelRequestDto request, String vlmId,
 182                                      String versionId, String user) {
 183     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage(VLM_ID, vlmId);
 184     MdcUtil.initMdc(LoggerServiceName.Update_VLM.toString());
 185
 186     VendorLicenseModelEntity vlm =
 187         new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 188             .applyMapping(request, VendorLicenseModelEntity.class);
 189     vlm.setId(vlmId);
 190     vlm.setVersion(new Version(versionId));
 191
 192     vendorLicenseManager.updateVendorLicenseModel(vlm);
 193
 194     MDC_DATA_DEBUG_MESSAGE.debugExitMessage(VLM_ID, vlmId);
 195     return Response.ok().build();
 196   }
 197
 198   @Override
 199   public Response getLicenseModel(String vlmId, String versionId, String user) {
 200     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage(VLM_ID, vlmId);
 201     MdcUtil.initMdc(LoggerServiceName.Get_VLM.toString());
 202
 203     Version version = versioningManager.get(vlmId, new Version(versionId));
 204     VendorLicenseModelEntity vlm = vendorLicenseManager.getVendorLicenseModel(vlmId, version);
 205     vlm.setWritetimeMicroSeconds(version.getModificationTime().getTime());
 206
 207     try {
 208       Optional<Version> healedVersion = HealingManagerFactory.getInstance().createInterface()
 209           .healItemVersion(vlmId, version, ItemType.vlm, false);
 210
 211       if (healedVersion.isPresent()) {
 212         vlm.setVersion(healedVersion.get());
 213         if (version.getStatus() == VersionStatus.Certified) {
 214           submitHealedVersion(vlmId, healedVersion.get(), versionId, user);
 215         }
 216       }
 217     } catch (Exception e) {
 218       LOGGER.error(
 219           String.format("Error while auto healing VLM with Id %s and version %s", vlmId, versionId),
 220           e);
 221     }
 222
 223     VendorLicenseModelEntityDto vlmDto =
 224         new MapVendorLicenseModelEntityToDto().applyMapping(vlm, VendorLicenseModelEntityDto.class);
 225
 226     MDC_DATA_DEBUG_MESSAGE.debugExitMessage(VLM_ID, vlmId);
 227     return Response.ok(vlmDto).build();
 228   }
 229
 230   @Override
 231   public Response deleteLicenseModel(String vlmId, String versionId, String user) {
 232     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage(VLM_ID, vlmId);
 233
 234     MdcUtil.initMdc(LoggerServiceName.Delete_VLM.toString());
 235     vendorLicenseManager.deleteVendorLicenseModel(vlmId, new Version(versionId));
 236
 237     MDC_DATA_DEBUG_MESSAGE.debugExitMessage(VLM_ID, vlmId);
 238
 239     return Response.ok().build();
 240   }
 241
 242   @Override
 243   public Response actOnLicenseModel(VendorLicenseModelActionRequestDto request, String vlmId,
 244                                     String versionId, String user) {
 245     Version version = new Version(versionId);
 246
 247     if (request.getAction() == Submit) {
 248       if (!permissionsManager.isAllowed(vlmId, user, SUBMIT_ITEM_ACTION)) {
 249         return Response.status(Response.Status.FORBIDDEN)
 250             .entity(new Exception(Messages.PERMISSIONS_ERROR.getErrorMessage())).build();
 251       }
 252       String message =
 253           request.getSubmitRequest() == null ? "Submit" : request.getSubmitRequest().getMessage();
 254       submit(vlmId, version, message, user);
 255
 256       notifyUsers(vlmId, version, message, user, NotificationEventTypes.SUBMIT);
 257
 258     }
 259     return Response.ok().build();
 260   }
 261
 262   private void submit(String vlmId, Version version, String message, String user) {
 263     MdcUtil.initMdc(LoggerServiceName.Submit_VLM.toString());
 264     LOGGER.audit(AuditMessages.AUDIT_MSG + AuditMessages.SUBMIT_VLM + vlmId);
 265
 266     vendorLicenseManager.validate(vlmId, version);
 267     versioningManager.submit(vlmId, version, message);
 268
 269     activityLogManager.logActivity(
 270         new ActivityLogEntity(vlmId, version, ActivityType.Submit, user, true, "", message));
 271   }
 272
 273   private void submitHealedVersion(String vlmId, Version healedVersion, String baseVersionId,
 274                                    String user) {
 275     try {
 276       submit(vlmId, healedVersion, "Submit after heal", user);
 277     } catch (Exception ex) {
 278       LOGGER.error(
 279           String.format(SUBMIT_HEALED_VERSION_ERROR, vlmId, healedVersion.getId(), baseVersionId),
 280           ex);
 281     }
 282   }
 283
 284   private void notifyUsers(String itemId, Version version, String message,
 285                            String userName, NotificationEventTypes eventType) {
 286     Map<String, Object> eventProperties = new HashMap<>();
 287     eventProperties.put(ITEM_NAME, itemManager.get(itemId).getName());
 288     eventProperties.put(ITEM_ID, itemId);
 289
 290     Version ver = versioningManager.get(itemId, version);
 291     eventProperties.put(VERSION_NAME, ver.getName());
 292     eventProperties.put(VERSION_ID, ver.getId());
 293
 294     eventProperties.put(SUBMIT_DESCRIPTION, message);
 295     eventProperties.put(PERMISSION_USER, userName);
 296
 297     Event syncEvent = new SyncEvent(eventType.getEventName(), itemId, eventProperties, itemId);
 298     try {
 299       notifier.notifySubscribers(syncEvent, userName);
 300     } catch (Exception e) {
 301       LOGGER.error("Failed to send sync notification to users subscribed o item '" + itemId);
 302     }
 303   }
 304
 305   private class SyncEvent implements Event {
 306
 307     private String eventType;
 308     private String originatorId;
 309     private Map<String, Object> attributes;
 310     private String entityId;
 311
 312     public SyncEvent(String eventType, String originatorId,
 313                      Map<String, Object> attributes, String entityId) {
 314       this.eventType = eventType;
 315       this.originatorId = originatorId;
 316       this.attributes = attributes;
 317       this.entityId = entityId;
 318     }
 319
 320     @Override
 321     public String getEventType() {
 322       return eventType;
 323     }
 324
 325     @Override
 326     public String getOriginatorId() {
 327       return originatorId;
 328     }
 329
 330     @Override
 331     public Map<String, Object> getAttributes() {
 332       return attributes;
 333     }
 334
 335     @Override
 336     public String getEntityId() {
 337       return entityId;
 338     }
 339   }
 340
 341   private boolean userHasPermission(String itemId, String userId) {
 342     String permission = permissionsManager.getUserItemPermiission(itemId, userId);
 343     return (permission != null && permission
 344         .matches(PermissionTypes.Contributor.name() + "|" + PermissionTypes.Owner.name()));
 345   }
 346 }