gerrit.onap Code Review - sdc.git/blob

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