ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/controller/CommonWidgetController.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 javax.servlet.http.HttpServletRequest;
  41
  42 import org.onap.portalapp.controller.EPRestrictedBaseController;
  43 import org.onap.portalapp.portal.controller.DashboardController.WidgetCategory;
  44 import org.onap.portalapp.portal.ecomp.model.PortalRestResponse;
  45 import org.onap.portalapp.portal.ecomp.model.PortalRestStatusEnum;
  46 import org.onap.portalapp.portal.service.DashboardSearchService;
  47 import org.onap.portalapp.portal.transport.CommonWidgetMeta;
  48 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
  49 import org.springframework.beans.factory.annotation.Autowired;
  50 import org.springframework.web.bind.annotation.RequestMapping;
  51 import org.springframework.web.bind.annotation.GetMapping;
  52 import org.springframework.web.bind.annotation.RequestMethod;
  53 import org.springframework.web.bind.annotation.RequestParam;
  54 import org.springframework.web.bind.annotation.RestController;
  55
  56 @RestController
  57 public class CommonWidgetController extends EPRestrictedBaseController implements BasicAuthenticationController{
  58
  59
  60         private static EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(CommonWidgetController.class);
  61         @Autowired
  62         private DashboardSearchService searchService;
  63
  64         /**
  65          * Validates the resource type parameter.
  66          *
  67          * @param resourceType
  68          * @return True if known in the enum WidgetCategory, else false.
  69          */
  70         private boolean isValidResourceType(String resourceType) {
  71                 if (resourceType == null)
  72                         return false;
  73                 for (WidgetCategory wc : WidgetCategory.values())
  74                         if (wc.name().equals(resourceType))
  75                                 return true;
  76                 return false;
  77         }
  78
  79         /**
  80          * Gets all widgets of the specified resource type.
  81          *
  82          * @param request
  83          * @param resourceType
  84          *            Request parameter.
  85          * @return Rest response wrapped around a CommonWidgetMeta object.
  86          */
  87         @GetMapping(value = "/commonWidgets", produces = "application/json")
  88         public PortalRestResponse<CommonWidgetMeta> getWidgetData(HttpServletRequest request,
  89                         @RequestParam String resourceType) {
  90                 if (!isValidResourceType(resourceType)){
  91                         logger.debug(EELFLoggerDelegate.debugLogger, "Unexpected resource type {}", resourceType);
  92                         return new PortalRestResponse<CommonWidgetMeta>(PortalRestStatusEnum.ERROR,
  93                                         "Unexpected resource type " + resourceType, null);
  94                 }
  95                 return new PortalRestResponse<CommonWidgetMeta>(PortalRestStatusEnum.OK, "success",
  96                                 searchService.getWidgetData(resourceType));
  97         }
  98
  99
 100 }