ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/service/EPLeftMenuServiceImpl.java

   1 /*-
   2  * ================================================================================
   3  * ECOMP Portal
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property
   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  * ================================================================================
  19  */
  20 package org.openecomp.portalapp.portal.service;
  21
  22 import java.util.Collection;
  23 import java.util.Comparator;
  24 import java.util.LinkedHashMap;
  25 import java.util.Map;
  26 import java.util.Set;
  27 import java.util.SortedSet;
  28 import java.util.TreeSet;
  29
  30 import org.json.JSONArray;
  31 import org.json.JSONObject;
  32 import org.springframework.beans.factory.annotation.Autowired;
  33 import org.springframework.context.annotation.EnableAspectJAutoProxy;
  34 import org.springframework.stereotype.Service;
  35 import org.springframework.transaction.annotation.Transactional;
  36
  37 import org.openecomp.portalsdk.core.domain.MenuData;
  38 import org.openecomp.portalsdk.core.logging.logic.EELFLoggerDelegate;
  39 import org.openecomp.portalapp.portal.domain.EPUser;
  40 import org.openecomp.portalapp.portal.domain.UserRoles;
  41 //import org.openecomp.portalapp.portal.domain.Menu;
  42 import org.openecomp.portalapp.portal.logging.aop.EPMetricsLog;
  43
  44 @Service("leftMenuService")
  45 @Transactional
  46 @org.springframework.context.annotation.Configuration
  47 @EnableAspectJAutoProxy
  48 @EPMetricsLog
  49
  50 public class EPLeftMenuServiceImpl implements EPLeftMenuService {
  51
  52         private static final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(EPLeftMenuServiceImpl.class);
  53
  54         @Autowired
  55         private EPAppService appService;
  56
  57         /*
  58          * (non-Javadoc)
  59          *
  60          * @see
  61          * org.openecomp.portalapp.portal.service.EPLeftMenuService#getLeftMenuItems
  62          * (java.util.Set)
  63          */
  64         @Override
  65         public String getLeftMenuItems(EPUser user, Set<MenuData> fullMenuSet, Set<String> roleFunctionSet) {
  66                 final Map<String, JSONObject> defaultNavMap = new LinkedHashMap<String, JSONObject>();
  67
  68                 resetNavMap(defaultNavMap);
  69
  70                 loadDefaultNavMap(defaultNavMap);
  71
  72                 // Handle Account Administrator in a special way; soon this will
  73                 // be revised as Account Administrator may become obsolete
  74                 try {
  75                         if (user != null) {
  76                                 UserRoles uRoles = appService.getUserProfileNormalizedForLeftMenu(user);
  77                                 if (uRoles.getRoles().contains("Account Administrator"))
  78                                         loadAccAdminNavMap(defaultNavMap);
  79                         }
  80                 } catch (Exception e) {
  81                         logger.error(EELFLoggerDelegate.errorLogger,
  82                                         "getLeftMenuItems: failed to get roles for user " + user.getOrgUserId(), e);
  83                 }
  84
  85                 loadNavMapByRole(defaultNavMap, fullMenuSet);
  86
  87                 return convertToSideBarModel(defaultNavMap);
  88         }
  89
  90         /**
  91          * Clears the map
  92          *
  93          * @param defaultNavMap
  94          */
  95         private void resetNavMap(Map<String, JSONObject> defaultNavMap) {
  96                 defaultNavMap.clear();
  97         }
  98
  99         /**
 100          *
 101          * @param defaultNavMap
 102          * @param fullMenuSet
 103          */
 104         private void loadNavMapByRole(Map<String, JSONObject> defaultNavMap, Set<MenuData> fullMenuSet) {
 105
 106                 class SortOrderComparator implements Comparator<MenuData> {
 107                         @Override
 108                         public int compare(MenuData e1, MenuData e2) {
 109                                 return e1.getSortOrder().compareTo(e2.getSortOrder());
 110                         }
 111                 }
 112
 113                 SortedSet<MenuData> sortMenuSet = new TreeSet<MenuData>(new SortOrderComparator());
 114                 for (MenuData mn : fullMenuSet) {
 115                         sortMenuSet.add(mn);
 116                 }
 117
 118                 for (MenuData mn : sortMenuSet) {
 119                         JSONObject navItemsDetails = new JSONObject();
 120                         navItemsDetails.put("name", mn.getLabel());
 121                         navItemsDetails.put("state", mn.getAction());
 122                         navItemsDetails.put("imageSrc", mn.getImageSrc());
 123                         defaultNavMap.put(mn.getAction(), navItemsDetails);
 124                 }
 125         }
 126
 127         /**
 128          *
 129          * @param defaultNavMap
 130          * @return
 131          */
 132         private String convertToSideBarModel(Map<String, JSONObject> defaultNavMap) {
 133                 JSONObject sidebarModel = new JSONObject();
 134                 JSONArray navItems = new JSONArray();
 135                 Collection<JSONObject> jsonObjs = defaultNavMap.values();
 136
 137                 for (JSONObject navItemsDetail : jsonObjs)
 138                         navItems.put(navItemsDetail);
 139
 140                 sidebarModel.put("label", "ECOMP portal");
 141                 sidebarModel.put("navItems", navItems);
 142                 return sidebarModel.toString();
 143         }
 144
 145         /**
 146          * Loads default entries for regular user.
 147          *
 148          * @param defaultNavMap
 149          */
 150         private void loadDefaultNavMap(Map<String, JSONObject> defaultNavMap) {
 151
 152                 JSONObject navItemsDetails1 = new JSONObject();
 153                 navItemsDetails1.put("name", "Home");
 154                 navItemsDetails1.put("state", "root.applicationsHome");
 155                 navItemsDetails1.put("imageSrc", "icon-building-home");
 156                 defaultNavMap.put("root.applicationsHome", navItemsDetails1);
 157
 158                 JSONObject navItemsDetails2 = new JSONObject();
 159                 navItemsDetails2.put("name", "Application Catalog");
 160                 navItemsDetails2.put("state", "root.appCatalog");
 161                 navItemsDetails2.put("imageSrc", "icon-apps-marketplace");
 162                 defaultNavMap.put("root.appCatalog", navItemsDetails2);
 163
 164                 JSONObject navItemsDetails3 = new JSONObject();
 165                 navItemsDetails3.put("name", "Widget Catalog");
 166                 navItemsDetails3.put("state", "root.widgetCatalog");
 167                 navItemsDetails3.put("imageSrc", "icon-apps-marketplace");
 168                 defaultNavMap.put("root.widgetCatalog", navItemsDetails3);
 169
 170         }
 171
 172         /**
 173          * Loads default entries for application administrator.
 174          *
 175          * @param defaultNavMap
 176          */
 177         private void loadAccAdminNavMap(Map<String, JSONObject> defaultNavMap) {
 178
 179                 JSONObject navItemsDetails1 = new JSONObject();
 180                 navItemsDetails1.put("name", "Users");
 181                 navItemsDetails1.put("state", "root.users");
 182                 navItemsDetails1.put("imageSrc", "icon-user");
 183                 defaultNavMap.put("root.users", navItemsDetails1);
 184
 185                 // No more widget onboarding like this:
 186                 //
 187                 // JSONObject navItemsDetails2 = new JSONObject();
 188                 // navItemsDetails2.put("name", "Widget Onboarding");
 189                 // navItemsDetails2.put("state", "root.widgetOnboarding");
 190                 // navItemsDetails2.put("imageSrc", "icon-add-widget");
 191                 // defaultNavMap.put("root.widgetOnboarding", navItemsDetails2);
 192
 193         }
 194
 195 }