ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/controller/AppContactUsController.java

   1 /*-
   2  * ============LICENSE_START==========================================
   3  * ONAP Portal
   4  * ===================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ===================================================================
   7  *
   8  * Unless otherwise specified, all software contained herein is licensed
   9  * under the Apache License, Version 2.0 (the "License");
  10  * you may not use this software except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *             http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * Unless otherwise specified, all documentation contained herein is licensed
  22  * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
  23  * you may not use this documentation except in compliance with the License.
  24  * You may obtain a copy of the License at
  25  *
  26  *             https://creativecommons.org/licenses/by/4.0/
  27  *
  28  * Unless required by applicable law or agreed to in writing, documentation
  29  * distributed under the License is distributed on an "AS IS" BASIS,
  30  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  31  * See the License for the specific language governing permissions and
  32  * limitations under the License.
  33  *
  34  * ============LICENSE_END============================================
  35  *
  36  *
  37  */
  38 package org.onap.portalapp.portal.controller;
  39
  40 import java.util.Comparator;
  41 import java.util.HashMap;
  42 import java.util.List;
  43
  44 import javax.servlet.http.HttpServletRequest;
  45
  46 import org.json.JSONObject;
  47 import org.onap.portalapp.controller.EPRestrictedBaseController;
  48 import org.onap.portalapp.portal.ecomp.model.AppCategoryFunctionsItem;
  49 import org.onap.portalapp.portal.ecomp.model.AppContactUsItem;
  50 import org.onap.portalapp.portal.ecomp.model.PortalRestResponse;
  51 import org.onap.portalapp.portal.ecomp.model.PortalRestStatusEnum;
  52 import org.onap.portalapp.portal.logging.aop.EPAuditLog;
  53 import org.onap.portalapp.portal.service.AppContactUsService;
  54 import org.onap.portalapp.portal.utils.EPCommonSystemProperties;
  55 import org.onap.portalapp.validation.DataValidator;
  56 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
  57 import org.onap.portalsdk.core.util.SystemProperties;
  58 import org.springframework.beans.factory.annotation.Autowired;
  59 import org.springframework.context.annotation.Configuration;
  60 import org.springframework.context.annotation.EnableAspectJAutoProxy;
  61 import org.springframework.web.bind.annotation.PathVariable;
  62 import org.springframework.web.bind.annotation.RequestBody;
  63 import org.springframework.web.bind.annotation.RequestMapping;
  64 import org.springframework.web.bind.annotation.RequestMethod;
  65 import org.springframework.web.bind.annotation.RestController;
  66
  67 @RestController
  68 @RequestMapping("/portalApi/contactus")
  69 @Configuration
  70 @EnableAspectJAutoProxy
  71 @EPAuditLog
  72 public class AppContactUsController extends EPRestrictedBaseController {
  73
  74         private static final String FAILURE = "failure";
  75         private static final String SUCCESS= "success";
  76
  77         private static final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(AppContactUsController.class);
  78         private static final DataValidator dataValidator = new DataValidator();
  79         private final Comparator<AppCategoryFunctionsItem> appCategoryFunctionsItemComparator = Comparator
  80                 .comparing(AppCategoryFunctionsItem::getCategory);
  81
  82         private AppContactUsService contactUsService;
  83
  84         @Autowired
  85         public AppContactUsController(AppContactUsService contactUsService) {
  86                 this.contactUsService = contactUsService;
  87         }
  88
  89
  90         /**
  91          * Answers a JSON object with three items from the system.properties file:
  92          * user self-help ticket URL, email for feedback, and Portal info link.
  93          *
  94          * @param request HttpServletRequest
  95          * @return PortalRestResponse
  96          */
  97         @RequestMapping(value = "/feedback", method = RequestMethod.GET, produces = "application/json")
  98         public PortalRestResponse<String> getPortalDetails(HttpServletRequest request) {
  99                 PortalRestResponse<String> portalRestResponse;
 100                 try {
 101                         final String ticketUrl = SystemProperties.getProperty(EPCommonSystemProperties.USH_TICKET_URL);
 102                         final String portalInfoUrl = SystemProperties.getProperty(EPCommonSystemProperties.PORTAL_INFO_URL);
 103                         final String feedbackEmail = SystemProperties.getProperty(EPCommonSystemProperties.FEEDBACK_EMAIL_ADDRESS);
 104                         HashMap<String, String> map = new HashMap<>();
 105                         map.put(EPCommonSystemProperties.USH_TICKET_URL, ticketUrl);
 106                         map.put(EPCommonSystemProperties.PORTAL_INFO_URL, portalInfoUrl);
 107                         map.put(EPCommonSystemProperties.FEEDBACK_EMAIL_ADDRESS, feedbackEmail);
 108                         JSONObject j = new JSONObject(map);
 109                         String contactUsPortalResponse = j.toString();
 110                         portalRestResponse = new PortalRestResponse<>(PortalRestStatusEnum.OK, SUCCESS,
 111                                 contactUsPortalResponse);
 112                 } catch (Exception e) {
 113                         return new PortalRestResponse<>(PortalRestStatusEnum.ERROR, FAILURE, e.getMessage());
 114                 }
 115                 return portalRestResponse;
 116         }
 117
 118         /**
 119          * Answers the contents of the contact-us table, extended with the
 120          * application name.
 121          *
 122          * @param request HttpServletRequest
 123          * @return PortalRestResponse<List<AppContactUsItem>>
 124          */
 125         @RequestMapping(value = "/list", method = RequestMethod.GET, produces = "application/json")
 126         public PortalRestResponse<List<AppContactUsItem>> getAppContactUsList(HttpServletRequest request) {
 127                 PortalRestResponse<List<AppContactUsItem>> portalRestResponse;
 128                 try {
 129                         List<AppContactUsItem> contents = contactUsService.getAppContactUs();
 130                         portalRestResponse = new PortalRestResponse<>(PortalRestStatusEnum.OK, SUCCESS,
 131                                 contents);
 132                 } catch (Exception e) {
 133                         logger.error(EELFLoggerDelegate.errorLogger, "getAppContactUsList failed", e);
 134                         portalRestResponse = new PortalRestResponse<>(PortalRestStatusEnum.ERROR,
 135                                 e.getMessage(), null);
 136                 }
 137                 return portalRestResponse;
 138         }
 139
 140         /**
 141          * Answers a list of objects, one per application, extended with available
 142          * data on how to contact that app's organization (possibly none).
 143          *
 144          * @param request HttpServletRequest
 145          * @return PortalRestResponse<List<AppContactUsItem>>
 146          */
 147         @RequestMapping(value = "/allapps", method = RequestMethod.GET, produces = "application/json")
 148         public PortalRestResponse<List<AppContactUsItem>> getAppsAndContacts(HttpServletRequest request) {
 149                 PortalRestResponse<List<AppContactUsItem>> portalRestResponse;
 150                 try {
 151                         List<AppContactUsItem> contents = contactUsService.getAppsAndContacts();
 152                         portalRestResponse = new PortalRestResponse<>(PortalRestStatusEnum.OK, SUCCESS,
 153                                 contents);
 154                 } catch (Exception e) {
 155                         logger.error(EELFLoggerDelegate.errorLogger, "getAllAppsAndContacts failed", e);
 156                         portalRestResponse = new PortalRestResponse<>(PortalRestStatusEnum.ERROR,
 157                                 e.getMessage(), null);
 158                 }
 159                 return portalRestResponse;
 160         }
 161
 162         /**
 163          * Answers a list of objects with category-application-function details. Not
 164          * all applications participate in the functional menu.
 165          *
 166          * @param request HttpServletRequest
 167          * @return PortalRestResponse<List<AppCategoryFunctionsItem>>
 168          */
 169         @RequestMapping(value = "/functions", method = RequestMethod.GET, produces = "application/json")
 170         public PortalRestResponse<List<AppCategoryFunctionsItem>> getAppCategoryFunctions(HttpServletRequest request) {
 171                 PortalRestResponse<List<AppCategoryFunctionsItem>> portalRestResponse;
 172                 try {
 173                         List<AppCategoryFunctionsItem> contents = contactUsService.getAppCategoryFunctions();
 174                         contents.sort(appCategoryFunctionsItemComparator);
 175                         portalRestResponse = new PortalRestResponse<>(PortalRestStatusEnum.OK,
 176                                 SUCCESS, contents);
 177                 } catch (Exception e) {
 178                         logger.error(EELFLoggerDelegate.errorLogger, "getAppCategoryFunctions failed", e);
 179                         // TODO build JSON error
 180                         portalRestResponse = new PortalRestResponse<>(PortalRestStatusEnum.ERROR,
 181                                 e.getMessage(), null);
 182                 }
 183                 return portalRestResponse;
 184         }
 185
 186         /**
 187          * Accepts a new application's contact us details.
 188          *
 189          * @param contactUs AppContactUsItem
 190          * @return PortalRestResponse<String>
 191          */
 192         @RequestMapping(value = "/save", method = RequestMethod.POST, produces = "application/json")
 193         public PortalRestResponse<String> save(@RequestBody AppContactUsItem contactUs) {
 194
 195                 if (contactUs == null || contactUs.getAppName() == null) {
 196                         return new PortalRestResponse<>(PortalRestStatusEnum.ERROR, FAILURE,
 197                                 "AppName cannot be null or empty");
 198                 }else if(!dataValidator.isValid(contactUs)){
 199                         return new PortalRestResponse<>(PortalRestStatusEnum.ERROR, FAILURE, "AppName is not valid.");
 200                 }
 201
 202                 String saveAppContactUs = FAILURE;
 203                 try {
 204                         saveAppContactUs = contactUsService.saveAppContactUs(contactUs);
 205                 } catch (Exception e) {
 206                         logger.error(EELFLoggerDelegate.errorLogger, "save failed", e);
 207                         return new PortalRestResponse<>(PortalRestStatusEnum.ERROR, saveAppContactUs, e.getMessage());
 208                 }
 209                 return new PortalRestResponse<>(PortalRestStatusEnum.OK, saveAppContactUs, "");
 210         }
 211
 212         @RequestMapping(value = "/saveAll", method = RequestMethod.POST, produces = "application/json")
 213         public PortalRestResponse<String> save(@RequestBody List<AppContactUsItem> contactUsList) {
 214
 215                 if (contactUsList == null) {
 216                         return new PortalRestResponse<>(PortalRestStatusEnum.ERROR, FAILURE,
 217                                 "AppNameList cannot be null or empty");
 218                 }else if(!dataValidator.isValid(contactUsList)){
 219                         return new PortalRestResponse<>(PortalRestStatusEnum.ERROR, FAILURE, "AppNameList is not valid.");
 220                 }
 221
 222                 String saveAppContactUs = FAILURE;
 223                 try {
 224                         saveAppContactUs = contactUsService.saveAppContactUs(contactUsList);
 225                 } catch (Exception e) {
 226                         logger.error(EELFLoggerDelegate.errorLogger, "save failed", e);
 227                         return new PortalRestResponse<>(PortalRestStatusEnum.ERROR, saveAppContactUs, e.getMessage());
 228                 }
 229                 return new PortalRestResponse<>(PortalRestStatusEnum.OK, saveAppContactUs, "");
 230         }
 231
 232         /**
 233          * Deletes the specified application's contact-us details entry from the
 234          * table.
 235          *
 236          * @param id app ID
 237          * @return PortalRestResponse<String>
 238          */
 239         @RequestMapping(value = "/delete/{appid}", method = RequestMethod.POST, produces = "application/json")
 240         public PortalRestResponse<String> delete(@PathVariable("appid") Long id) {
 241
 242                 String saveAppContactUs = FAILURE;
 243                 try {
 244                         saveAppContactUs = contactUsService.deleteContactUs(id);
 245                 } catch (Exception e) {
 246                         logger.error(EELFLoggerDelegate.errorLogger, "delete failed", e);
 247                         return new PortalRestResponse<>(PortalRestStatusEnum.ERROR, saveAppContactUs, e.getMessage());
 248                 }
 249                 return new PortalRestResponse<>(PortalRestStatusEnum.OK, saveAppContactUs, "");
 250         }
 251
 252 }