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.dao.UniqueValueDaoFactory;
  21 import org.openecomp.core.util.UniqueValueUtil;
  22 import org.openecomp.sdc.activitylog.ActivityLogManager;
  23 import org.openecomp.sdc.activitylog.ActivityLogManagerFactory;
  24 import org.openecomp.sdc.activitylog.dao.type.ActivityLogEntity;
  25 import org.openecomp.sdc.activitylog.dao.type.ActivityType;
  26 import org.openecomp.sdc.common.errors.CoreException;
  27 import org.openecomp.sdc.common.errors.ErrorCode;
  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.notification.dtos.Event;
  37 import org.openecomp.sdc.notification.factories.NotificationPropagationManagerFactory;
  38 import org.openecomp.sdc.notification.services.NotificationPropagationManager;
  39 import org.openecomp.sdc.vendorlicense.VendorLicenseConstants;
  40 import org.openecomp.sdc.vendorlicense.VendorLicenseManager;
  41 import org.openecomp.sdc.vendorlicense.VendorLicenseManagerFactory;
  42 import org.openecomp.sdc.vendorlicense.dao.types.VendorLicenseModelEntity;
  43 import org.openecomp.sdc.versioning.AsdcItemManager;
  44 import org.openecomp.sdc.versioning.AsdcItemManagerFactory;
  45 import org.openecomp.sdc.versioning.VersioningManager;
  46 import org.openecomp.sdc.versioning.VersioningManagerFactory;
  47 import org.openecomp.sdc.versioning.dao.types.Version;
  48 import org.openecomp.sdc.versioning.dao.types.VersionStatus;
  49 import org.openecomp.sdc.versioning.types.Item;
  50 import org.openecomp.sdc.versioning.types.NotificationEventTypes;
  51 import org.openecomp.sdcrests.item.rest.mapping.MapItemToDto;
  52 import org.openecomp.sdcrests.item.rest.mapping.MapVersionToDto;
  53 import org.openecomp.sdcrests.item.types.ItemCreationDto;
  54 import org.openecomp.sdcrests.item.types.ItemDto;
  55 import org.openecomp.sdcrests.item.types.VersionDto;
  56 import org.openecomp.sdcrests.vendorlicense.rest.VendorLicenseModels;
  57 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelEntityToDto;
  58 import org.openecomp.sdcrests.vendorlicense.rest.mapping.MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity;
  59 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto;
  60 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelEntityDto;
  61 import org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelRequestDto;
  62 import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
  63 import org.springframework.context.annotation.Scope;
  64 import org.springframework.stereotype.Service;
  65 import org.springframework.validation.annotation.Validated;
  66
  67 import javax.inject.Named;
  68 import javax.ws.rs.core.Response;
  69 import java.util.HashMap;
  70 import java.util.Map;
  71 import java.util.Objects;
  72 import java.util.Optional;
  73 import java.util.function.Predicate;
  74
  75 import static org.openecomp.sdc.itempermissions.notifications.NotificationConstants.PERMISSION_USER;
  76 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_ID;
  77 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_NAME;
  78 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.SUBMIT_DESCRIPTION;
  79 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_ID;
  80 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.VERSION_NAME;
  81 import static org.openecomp.sdcrests.vendorlicense.types.VendorLicenseModelActionRequestDto.VendorLicenseModelAction.Submit;
  82
  83 @Named
  84 @Service("vendorLicenseModels")
  85 @Scope(value = "prototype")
  86 @Validated
  87 public class VendorLicenseModelsImpl implements VendorLicenseModels {
  88
  89   private static final String SUBMIT_ITEM_ACTION = "Submit_Item";
  90   private static final String SUBMIT_HEALED_VERSION_ERROR =
  91       "VLM Id %s: Error while submitting version %s created based on Certified version %s for healing purpose.";
  92   private static final Logger LOGGER = LoggerFactory.getLogger(VendorLicenseModelsImpl.class);
  93   private ItemPermissionsManager permissionsManager = ItemPermissionsManagerFactory.getInstance()
  94       .createInterface();
  95   private NotificationPropagationManager notifier =
  96       NotificationPropagationManagerFactory.getInstance().createInterface();
  97
  98   private AsdcItemManager asdcItemManager = AsdcItemManagerFactory.getInstance().createInterface();
  99   private VersioningManager versioningManager =
 100       VersioningManagerFactory.getInstance().createInterface();
 101   private VendorLicenseManager vendorLicenseManager =
 102       VendorLicenseManagerFactory.getInstance().createInterface();
 103   private ActivityLogManager activityLogManager =
 104       ActivityLogManagerFactory.getInstance().createInterface();
 105   private UniqueValueUtil uniqueValueUtil = new UniqueValueUtil(UniqueValueDaoFactory.getInstance()
 106       .createInterface());
 107
 108   @Override
 109   public Response listLicenseModels(String versionStatus, String user) {
 110     Predicate<Item> itemPredicate;
 111     if (VersionStatus.Certified.name().equals(versionStatus)) {
 112       itemPredicate = item -> ItemType.vlm.name().equals(item.getType()) &&
 113           item.getVersionStatusCounters().containsKey(VersionStatus.Certified);
 114
 115     } else if (VersionStatus.Draft.name().equals(versionStatus)) {
 116       itemPredicate = item -> ItemType.vlm.name().equals(item.getType()) &&
 117           item.getVersionStatusCounters().containsKey(VersionStatus.Draft) &&
 118           userHasPermission(item.getId(), user);
 119
 120     } else {
 121       itemPredicate = item -> ItemType.vlm.name().equals(item.getType());
 122     }
 123
 124     GenericCollectionWrapper<ItemDto> results = new GenericCollectionWrapper<>();
 125     MapItemToDto mapper = new MapItemToDto();
 126     asdcItemManager.list(itemPredicate).stream()
 127         .sorted((o1, o2) -> o2.getModificationTime().compareTo(o1.getModificationTime()))
 128         .forEach(vspItem -> results.add(mapper.applyMapping(vspItem, ItemDto.class)));
 129     return Response.ok(results).build();
 130   }
 131
 132   @Override
 133   public Response createLicenseModel(VendorLicenseModelRequestDto request, String user) {
 134
 135     Item item = new Item();
 136     item.setType(ItemType.vlm.name());
 137     item.setOwner(user);
 138     item.setName(request.getVendorName());
 139     item.setDescription(request.getDescription());
 140
 141     uniqueValueUtil
 142         .validateUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 143     item = asdcItemManager.create(item);
 144     uniqueValueUtil
 145         .createUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, item.getName());
 146
 147     Version version = versioningManager.create(item.getId(), new Version(), null);
 148
 149     VendorLicenseModelEntity vlm = new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 150         .applyMapping(request, VendorLicenseModelEntity.class);
 151     vlm.setId(item.getId());
 152     vlm.setVersion(version);
 153
 154     vendorLicenseManager.createVendorLicenseModel(vlm);
 155     versioningManager.publish(item.getId(), version, "Initial vlm:" + vlm.getVendorName());
 156
 157     ItemCreationDto itemCreationDto = new ItemCreationDto();
 158     itemCreationDto.setItemId(item.getId());
 159     itemCreationDto.setVersion(new MapVersionToDto().applyMapping(version, VersionDto.class));
 160
 161     activityLogManager.logActivity(new ActivityLogEntity(vlm.getId(), version,
 162         ActivityType.Create, user, true, "", ""));
 163     return Response.ok(itemCreationDto).build();
 164   }
 165
 166   @Override
 167   public Response updateLicenseModel(VendorLicenseModelRequestDto request, String vlmId,
 168                                      String versionId, String user) {
 169     VendorLicenseModelEntity vlm =
 170         new MapVendorLicenseModelRequestDtoToVendorLicenseModelEntity()
 171             .applyMapping(request, VendorLicenseModelEntity.class);
 172     vlm.setId(vlmId);
 173     vlm.setVersion(new Version(versionId));
 174
 175     vendorLicenseManager.updateVendorLicenseModel(vlm);
 176     return Response.ok().build();
 177   }
 178
 179   @Override
 180   public Response getLicenseModel(String vlmId, String versionId, String user) {
 181     Version version = versioningManager.get(vlmId, new Version(versionId));
 182     VendorLicenseModelEntity vlm = vendorLicenseManager.getVendorLicenseModel(vlmId, version);
 183     vlm.setWritetimeMicroSeconds(version.getModificationTime().getTime());
 184
 185     try {
 186       Optional<Version> healedVersion = HealingManagerFactory.getInstance().createInterface()
 187           .healItemVersion(vlmId, version, ItemType.vlm, false);
 188
 189       if (healedVersion.isPresent()) {
 190         vlm.setVersion(healedVersion.get());
 191         if (version.getStatus() == VersionStatus.Certified) {
 192           submitHealedVersion(vlmId, healedVersion.get(), versionId, user);
 193         }
 194       }
 195     } catch (Exception e) {
 196       LOGGER.error(
 197           String.format("Error while auto healing VLM with Id %s and version %s", vlmId, versionId),
 198           e);
 199     }
 200
 201     VendorLicenseModelEntityDto vlmDto =
 202         new MapVendorLicenseModelEntityToDto().applyMapping(vlm, VendorLicenseModelEntityDto.class);
 203     return Response.ok(vlmDto).build();
 204   }
 205
 206   @Override
 207   public Response deleteLicenseModel(String vlmId, String user) {
 208     Item vlm = asdcItemManager.get(vlmId);
 209
 210     if (!vlm.getType().equals(ItemType.vlm.name())){
 211       throw new CoreException((new ErrorCode.ErrorCodeBuilder()
 212               .withMessage(String.format("Vlm with id %s does not exist.",
 213                       vlmId)).build()));
 214     }
 215
 216     Integer certifiedVersionsCounter = vlm.getVersionStatusCounters().get(VersionStatus.Certified);
 217     if (Objects.isNull(certifiedVersionsCounter) || certifiedVersionsCounter == 0) {
 218       asdcItemManager.delete(vlm);
 219       permissionsManager.deleteItemPermissions(vlmId);
 220       uniqueValueUtil
 221           .deleteUniqueValue(VendorLicenseConstants.UniqueValues.VENDOR_NAME, vlm.getName());
 222       notifyUsers(vlmId, vlm.getName(), null, "VLM was deleted", user,
 223           NotificationEventTypes.DELETE);
 224
 225       return Response.ok().build();
 226     } else {
 227       return Response.status(Response.Status.FORBIDDEN)
 228           .entity(new Exception(Messages.DELETE_VLM_ERROR.getErrorMessage())).build();
 229     }
 230   }
 231
 232   @Override
 233   public Response actOnLicenseModel(VendorLicenseModelActionRequestDto request, String vlmId,
 234                                     String versionId, String user) {
 235     Version version = new Version(versionId);
 236
 237     if (request.getAction() == Submit) {
 238       if (!permissionsManager.isAllowed(vlmId, user, SUBMIT_ITEM_ACTION)) {
 239         return Response.status(Response.Status.FORBIDDEN)
 240             .entity(new Exception(Messages.PERMISSIONS_ERROR.getErrorMessage())).build();
 241       }
 242       String message =
 243           request.getSubmitRequest() == null ? "Submit" : request.getSubmitRequest().getMessage();
 244       submit(vlmId, version, message, user);
 245
 246       notifyUsers(vlmId, null, version, message, user, NotificationEventTypes.SUBMIT);
 247
 248     }
 249     return Response.ok().build();
 250   }
 251
 252   private void submit(String vlmId, Version version, String message, String user) {
 253
 254     vendorLicenseManager.validate(vlmId, version);
 255     versioningManager.submit(vlmId, version, message);
 256
 257     activityLogManager.logActivity(
 258         new ActivityLogEntity(vlmId, version, ActivityType.Submit, user, true, "", message));
 259   }
 260
 261   private void submitHealedVersion(String vlmId, Version healedVersion, String baseVersionId,
 262                                    String user) {
 263     try {
 264       submit(vlmId, healedVersion, "Submit after heal", user);
 265     } catch (Exception ex) {
 266       LOGGER.error(
 267           String.format(SUBMIT_HEALED_VERSION_ERROR, vlmId, healedVersion.getId(), baseVersionId),
 268           ex);
 269     }
 270   }
 271
 272   private void notifyUsers(String itemId, String itemName, Version version, String message,
 273                            String userName, NotificationEventTypes eventType) {
 274     Map<String, Object> eventProperties = new HashMap<>();
 275     eventProperties.put(ITEM_NAME, itemName == null ? asdcItemManager.get(itemId).getName() : itemName);
 276     eventProperties.put(ITEM_ID, itemId);
 277
 278     if (version != null) {
 279       eventProperties.put(VERSION_NAME, version.getName() == null
 280           ? versioningManager.get(itemId, version).getName()
 281           : version.getName());
 282       eventProperties.put(VERSION_ID, version.getId());
 283     }
 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     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 }