ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/controller/ManifestController.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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  37  */
  38 package org.onap.portalapp.portal.controller;
  39
  40 import java.util.HashMap;
  41 import java.util.Map;
  42 import java.util.jar.Attributes;
  43
  44 import javax.servlet.http.HttpServletRequest;
  45
  46 import org.springframework.beans.factory.annotation.Autowired;
  47 import org.springframework.context.annotation.Configuration;
  48 import org.springframework.context.annotation.EnableAspectJAutoProxy;
  49 import org.springframework.web.bind.annotation.RequestMapping;
  50 import org.springframework.web.bind.annotation.RequestMethod;
  51 import org.springframework.web.bind.annotation.ResponseBody;
  52 import org.springframework.web.bind.annotation.RestController;
  53 import org.onap.portalapp.portal.logging.aop.EPAuditLog;
  54 import org.onap.portalapp.portal.service.ManifestService;
  55 import org.onap.portalsdk.core.controller.RestrictedBaseController;
  56 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
  57
  58 /**
  59  * This controller responds to a request for the web application manifest,
  60  * returning a JSON with the information that was created at build time.
  61  *
  62  * Manifest entries have names with hyphens, which means Javascript code can't
  63  * simply use the shorthand object.key; instead use object['key'].
  64  */
  65 @RestController
  66 @Configuration("manifestPortalController")
  67 @EnableAspectJAutoProxy
  68 @RequestMapping("/")
  69 @EPAuditLog
  70 public class ManifestController extends RestrictedBaseController {
  71
  72         private EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(ManifestController.class);
  73
  74         @Autowired
  75         private ManifestService manifestService;
  76
  77         /**
  78          * Gets the webapp manifest contents as a JSON object.
  79          *
  80          * @param request
  81          *            HttpServletRequest
  82          * @return A map of key-value pairs. On success:
  83          *
  84          *         <pre>
  85          * { "manifest" : { "key1": "value1", "key2": "value2" } }
  86          *         </pre>
  87          *
  88          *         On failure:
  89          *
  90          *         <pre>
  91          * { "error": "message" }
  92          *         </pre>
  93          */
  94         @RequestMapping(value = { "/portalApi/manifest" }, method = RequestMethod.GET, produces = "application/json")
  95         @ResponseBody
  96         public Map<String, Object> getManifest(HttpServletRequest request) {
  97                 Map<String, Object> response = new HashMap<String, Object>();
  98                 try {
  99                         Attributes attributes = manifestService.getWebappManifest();
 100                         response.put("manifest", attributes);
 101                 } catch (Exception ex) {
 102                         logger.error(EELFLoggerDelegate.errorLogger, "getManifest: failed to read manifest", ex);
 103                         response.put("error", "failed to get manifest: " + ex.toString());
 104                 }
 105                 return response;
 106         }
 107
 108 }