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 package org.openecomp.sdcrests.item.rest.services;
  18
  19 import static org.openecomp.sdc.itempermissions.notifications.NotificationConstants.PERMISSION_USER;
  20 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_ID;
  21 import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.ITEM_NAME;
  22
  23 import java.util.Arrays;
  24 import java.util.Collection;
  25 import java.util.EnumMap;
  26 import java.util.HashMap;
  27 import java.util.HashSet;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Optional;
  31 import java.util.Set;
  32 import java.util.function.Predicate;
  33 import java.util.stream.Collectors;
  34 import javax.annotation.PostConstruct;
  35 import javax.inject.Named;
  36 import javax.ws.rs.core.Response;
  37 import org.openecomp.sdc.activitylog.ActivityLogManager;
  38 import org.openecomp.sdc.activitylog.ActivityLogManagerFactory;
  39 import org.openecomp.sdc.activitylog.dao.type.ActivityLogEntity;
  40 import org.openecomp.sdc.activitylog.dao.type.ActivityType;
  41 import org.openecomp.sdc.datatypes.model.ItemType;
  42 import org.openecomp.sdc.itempermissions.PermissionsManager;
  43 import org.openecomp.sdc.itempermissions.PermissionsManagerFactory;
  44 import org.openecomp.sdc.itempermissions.impl.types.PermissionTypes;
  45 import org.openecomp.sdc.logging.api.Logger;
  46 import org.openecomp.sdc.logging.api.LoggerFactory;
  47 import org.openecomp.sdc.notification.dtos.Event;
  48 import org.openecomp.sdc.notification.factories.NotificationPropagationManagerFactory;
  49 import org.openecomp.sdc.notification.services.NotificationPropagationManager;
  50 import org.openecomp.sdc.versioning.ItemManager;
  51 import org.openecomp.sdc.versioning.ItemManagerFactory;
  52 import org.openecomp.sdc.versioning.VersioningManager;
  53 import org.openecomp.sdc.versioning.VersioningManagerFactory;
  54 import org.openecomp.sdc.versioning.dao.types.Version;
  55 import org.openecomp.sdc.versioning.dao.types.VersionStatus;
  56 import org.openecomp.sdc.versioning.types.Item;
  57 import org.openecomp.sdc.versioning.types.ItemStatus;
  58 import org.openecomp.sdc.versioning.types.NotificationEventTypes;
  59 import org.openecomp.sdcrests.item.rest.Items;
  60 import org.openecomp.sdcrests.item.rest.mapping.MapItemToDto;
  61 import org.openecomp.sdcrests.item.types.ItemAction;
  62 import org.openecomp.sdcrests.item.types.ItemActionRequestDto;
  63 import org.openecomp.sdcrests.item.types.ItemDto;
  64 import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
  65 import org.springframework.context.annotation.Scope;
  66 import org.springframework.stereotype.Service;
  67 import org.springframework.validation.annotation.Validated;
  68
  69 @Named
  70 @Service("items")
  71 @Scope(value = "prototype")
  72 @Validated
  73 public class ItemsImpl implements Items {
  74
  75     private ItemManager itemManager = ItemManagerFactory.getInstance().createInterface();
  76
  77     private static ActivityLogManager activityLogManager = ActivityLogManagerFactory.getInstance().createInterface();
  78
  79     private VersioningManager versioningManager = VersioningManagerFactory.getInstance().createInterface();
  80
  81     private final PermissionsManager permissionsManager = PermissionsManagerFactory.getInstance().createInterface();
  82
  83     private static final Logger LOGGER = LoggerFactory.getLogger(ItemsImpl.class);
  84
  85     private NotificationPropagationManager notifier =
  86             NotificationPropagationManagerFactory.getInstance().createInterface();
  87
  88     private Map<ItemAction, ActionSideAffects> actionSideAffectsMap = new EnumMap<>(ItemAction.class);
  89
  90     @PostConstruct
  91     public void initActionSideAffectsMap() {
  92         actionSideAffectsMap
  93                 .put(ItemAction.ARCHIVE, new ActionSideAffects(ActivityType.Archive, NotificationEventTypes.ARCHIVE));
  94         actionSideAffectsMap
  95                 .put(ItemAction.RESTORE, new ActionSideAffects(ActivityType.Restore, NotificationEventTypes.RESTORE));
  96     }
  97
  98     private static final String ONBOARDING_METHOD = "onboardingMethod";
  99
 100     @Override
 101     public Response actOn(ItemActionRequestDto request, String itemId, String user) {
 102
 103         Item item = itemManager.get(itemId);
 104         if (item == null) {
 105             return Response.status(Response.Status.NOT_FOUND).entity(new Exception("Item does not exist.")).build();
 106         }
 107
 108         switch (request.getAction()) {
 109             case ARCHIVE:
 110                 itemManager.archive(item);
 111                 break;
 112             case RESTORE:
 113                 itemManager.restore(item);
 114                 break;
 115             default:
 116         }
 117
 118         actionSideAffectsMap.get(request.getAction()).execute(item, user);
 119
 120         return Response.ok().build();
 121     }
 122
 123     @Override
 124     public Response list(String itemStatusFilter, String versionStatusFilter, String itemTypeFilter,
 125             String permissionFilter, String onboardingMethodFilter, String user) {
 126
 127         Predicate<Item> itemPredicate =
 128                 createItemPredicate(itemStatusFilter, versionStatusFilter, itemTypeFilter, onboardingMethodFilter,
 129                         permissionFilter, user);
 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(item -> results.add(mapper.applyMapping(item, ItemDto.class)));
 136
 137         return Response.ok(results).build();
 138
 139     }
 140
 141     @Override
 142     public Response getItem(String itemId, String user) {
 143         Item item = itemManager.get(itemId);
 144         ItemDto itemDto = new MapItemToDto().applyMapping(item, ItemDto.class);
 145
 146         return Response.ok(itemDto).build();
 147     }
 148
 149     private class SyncEvent implements Event {
 150
 151         private String eventType;
 152         private String originatorId;
 153         private Map<String, Object> attributes;
 154         private String entityId;
 155
 156         SyncEvent(String eventType, String originatorId, Map<String, Object> attributes, String entityId) {
 157             this.eventType = eventType;
 158             this.originatorId = originatorId;
 159             this.attributes = attributes;
 160             this.entityId = entityId;
 161         }
 162
 163         @Override
 164         public String getEventType() {
 165             return eventType;
 166         }
 167
 168         @Override
 169         public String getOriginatorId() {
 170             return originatorId;
 171         }
 172
 173         @Override
 174         public Map<String, Object> getAttributes() {
 175             return attributes;
 176         }
 177
 178         @Override
 179         public String getEntityId() {
 180             return entityId;
 181         }
 182
 183     }
 184
 185     private class ActionSideAffects {
 186
 187         private ActivityType activityType;
 188         private NotificationEventTypes notificationType;
 189
 190         private ActionSideAffects(ActivityType activityType, NotificationEventTypes notificationType) {
 191             this.activityType = activityType;
 192             this.notificationType = notificationType;
 193
 194         }
 195
 196         private Version getLatestVersion(String itemId) {
 197             List<Version> list = versioningManager.list(itemId);
 198             Optional<Version> max = list.stream().max(Version::compareTo);
 199
 200             return max.orElse(null);
 201         }
 202
 203         private void execute(Item item, String user) {
 204             notifyUsers(item.getId(), item.getName(), user, this.notificationType);
 205             activityLogManager.logActivity(
 206                     new ActivityLogEntity(item.getId(), getLatestVersion(item.getId()), this.activityType, user, true,
 207                             "", ""));
 208         }
 209
 210         private void notifyUsers(String itemId, String itemName, String userName, NotificationEventTypes eventType) {
 211             Map<String, Object> eventProperties = new HashMap<>();
 212             eventProperties.put(ITEM_NAME, itemName == null ? itemManager.get(itemId).getName() : itemName);
 213             eventProperties.put(ITEM_ID, itemId);
 214
 215             eventProperties.put(PERMISSION_USER, userName);
 216
 217             Event syncEvent = new SyncEvent(eventType.getEventName(), itemId, eventProperties, itemId);
 218             try {
 219                 notifier.notifySubscribers(syncEvent, userName);
 220             } catch (Exception e) {
 221                 LOGGER.error("Failed to send sync notification to users subscribed to item '" + itemId);
 222             }
 223         }
 224     }
 225
 226     private Predicate<Item> createItemPredicate(String itemStatusFilter, String versionStatusFilter,
 227             String itemTypeFilter, String onboardingMethodFilter, String permissionsFilter, String user) {
 228         Predicate<Item> itemPredicate = item -> true;
 229
 230         if (itemStatusFilter != null) {
 231             validateItemStatusValue(itemStatusFilter);
 232             itemPredicate = itemPredicate.and(createItemStatusPredicate(itemStatusFilter));
 233         }
 234         if (versionStatusFilter != null) {
 235             validateVersionStatusValue(versionStatusFilter);
 236             itemPredicate = itemPredicate.and(createVersionStatusPredicate(versionStatusFilter));
 237         }
 238         if (itemTypeFilter != null) {
 239             validateItemTypeValue(itemTypeFilter);
 240             itemPredicate = itemPredicate.and(createItemTypePredicate(itemTypeFilter));
 241         }
 242         if (onboardingMethodFilter != null) {
 243             validateOnboardingMethodValue(onboardingMethodFilter);
 244             itemPredicate = itemPredicate.and(createOnboardingMethodPredicate(onboardingMethodFilter));
 245         }
 246         if (permissionsFilter != null) {
 247             validatePermissionValue(permissionsFilter);
 248             itemPredicate = itemPredicate.and(createPermissionsPredicate(user, permissionsFilter));
 249         }
 250         return itemPredicate;
 251     }
 252
 253     private String formatFilter(String filterValue) {
 254         return filterValue.replace(",", "|");
 255     }
 256
 257     private Predicate<Item> createItemStatusPredicate(String filterValue) {
 258         return item -> item.getStatus().name().matches(formatFilter(filterValue));
 259     }
 260
 261     private Predicate<Item> createVersionStatusPredicate(String filterValue) {
 262         Set<VersionStatus> versionStatuses =
 263                 Arrays.stream(filterValue.split(",")).map(VersionStatus::valueOf).collect(Collectors.toSet());
 264         return item -> item.getVersionStatusCounters().keySet().stream().anyMatch(versionStatuses::contains);
 265     }
 266
 267     private Predicate<Item> createItemTypePredicate(String filterValue) {
 268         return item -> item.getType().matches(formatFilter(filterValue));
 269     }
 270
 271     private Predicate<Item> createOnboardingMethodPredicate(String filterValue) {
 272         return item -> !ItemType.vsp.name().equals(item.getType()) || ((String) item.getProperties()
 273                                                                                     .get(ONBOARDING_METHOD))
 274                                                                               .matches(formatFilter(filterValue));
 275     }
 276
 277     private Predicate<Item> createPermissionsPredicate(String user, String filterValue) {
 278         String[] permissions = filterValue.split(",");
 279         Set<String> itemIds = new HashSet<>();
 280         for (String permission : permissions) {
 281             itemIds.addAll(permissionsManager.listUserPermittedItems(user, permission));
 282         }
 283         return item -> itemIds.contains(item.getId());
 284     }
 285
 286     private void validateItemStatusValue(String itemStatusFilter) {
 287         String[] values = itemStatusFilter.split(",");
 288         for (String value : values) {
 289             ItemStatus.valueOf(value);
 290         }
 291     }
 292
 293     private void validateVersionStatusValue(String versionStatusFilter) {
 294         String[] values = versionStatusFilter.split(",");
 295         for (String value : values) {
 296             VersionStatus.valueOf(value);
 297         }
 298
 299     }
 300
 301     private void validateItemTypeValue(String itemTypeFilter) {
 302         String[] values = itemTypeFilter.split(",");
 303         for (String value : values) {
 304             ItemType.valueOf(value);
 305         }
 306     }
 307
 308     private void validateOnboardingMethodValue(String onboardingMethodFilter) {
 309         String[] values = onboardingMethodFilter.split(",");
 310         for (String value : values) {
 311             OnboardingMethod.valueOf(value);
 312         }
 313     }
 314
 315     private void validatePermissionValue(String permissionsFilter) {
 316         String[] values = permissionsFilter.split(",");
 317         for (String value : values) {
 318             PermissionTypes.valueOf(value);
 319         }
 320     }
 321
 322     //Do not delete - is in use, duplicates code to prevent dependency on openecomp-sdc-vendor-software-product-api
 323     private enum OnboardingMethod {
 324         NetworkPackage, Manual;
 325     }
 326 }