removed code smells
[portal.git] / 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.GetMapping;
51 import org.springframework.web.bind.annotation.RequestParam;
52 import org.springframework.web.bind.annotation.RestController;
53
54 @RestController
55 public class CommonWidgetController extends EPRestrictedBaseController implements BasicAuthenticationController{
56         
57         
58         private static EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(CommonWidgetController.class);
59         @Autowired
60         private DashboardSearchService searchService;
61         
62         /**
63          * Validates the resource type parameter.
64          * 
65          * @param resourceType
66          * @return True if known in the enum WidgetCategory, else false.
67          */
68         private boolean isValidResourceType(String resourceType) {
69                 if (resourceType == null)
70                         return false;
71                 for (WidgetCategory wc : WidgetCategory.values())
72                         if (wc.name().equals(resourceType))
73                                 return true;
74                 return false;
75         }
76         
77         /**
78          * Gets all widgets of the specified resource type.
79          * 
80          * @param request
81          * @param resourceType
82          *            Request parameter.
83          * @return Rest response wrapped around a CommonWidgetMeta object.
84          */
85         @GetMapping(value = "/commonWidgets", produces = "application/json")
86         public PortalRestResponse<CommonWidgetMeta> getWidgetData(HttpServletRequest request,
87                         @RequestParam String resourceType) {
88                 if (!isValidResourceType(resourceType)){
89                         logger.debug(EELFLoggerDelegate.debugLogger, "Unexpected resource type {}", resourceType);
90                         return new PortalRestResponse<CommonWidgetMeta>(PortalRestStatusEnum.ERROR,
91                                         "Unexpected resource type " + resourceType, null);
92                 }
93                 return new PortalRestResponse<CommonWidgetMeta>(PortalRestStatusEnum.OK, "success",
94                                 searchService.getWidgetData(resourceType));
95         }
96                 
97
98 }