Update license; improve coverage; add docs dir
[portal.git] / ecomp-portal-BE-os / src / main / java / org / openecomp / portalapp / uebhandler / FunctionalMenuHandler.java
index 0a36050..8fd70a2 100644 (file)
@@ -1,21 +1,39 @@
 /*-
- * ================================================================================
- * ECOMP Portal
- * ================================================================================
- * Copyright (C) 2017 AT&T Intellectual Property
- * ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
+ * ============LICENSE_START==========================================
+ * ONAP Portal
+ * ===================================================================
+ * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+ * ===================================================================
+ *
+ * Unless otherwise specified, all software contained herein is licensed
+ * under the Apache License, Version 2.0 (the “License”);
+ * you may not use this software except in compliance with the License.
  * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
+ *             http://www.apache.org/licenses/LICENSE-2.0
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- * ================================================================================
+ *
+ * Unless otherwise specified, all documentation contained herein is licensed
+ * under the Creative Commons License, Attribution 4.0 Intl. (the “License”);
+ * you may not use this documentation except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *             https://creativecommons.org/licenses/by/4.0/
+ *
+ * Unless required by applicable law or agreed to in writing, documentation
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * ============LICENSE_END============================================
+ *
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  */
 package org.openecomp.portalapp.uebhandler;
 
@@ -27,7 +45,6 @@ import org.openecomp.portalapp.portal.service.AdminRolesService;
 import org.openecomp.portalapp.portal.service.FunctionalMenuService;
 import org.openecomp.portalapp.portal.service.SearchService;
 import org.openecomp.portalapp.portal.transport.FunctionalMenuItem;
-import org.openecomp.portalapp.portal.utils.EcompPortalUtils;
 import org.openecomp.portalsdk.core.logging.logic.EELFLoggerDelegate;
 import org.openecomp.portalsdk.core.onboarding.ueb.UebException;
 import org.openecomp.portalsdk.core.onboarding.ueb.UebManager;
@@ -44,83 +61,76 @@ import com.google.gson.Gson;
 @org.springframework.context.annotation.Configuration
 @EnableAspectJAutoProxy
 @EPAuditLog
-public class FunctionalMenuHandler { 
-       EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(FunctionalMenuHandler.class);
-       
+public class FunctionalMenuHandler {
+       private EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(FunctionalMenuHandler.class);
+
        @Autowired
-       AdminRolesService adminRolesService;
-       
+       private AdminRolesService adminRolesService;
+
        @Autowired
-       FunctionalMenuService functionalMenuService;
-       
+       private FunctionalMenuService functionalMenuService;
+
        @Autowired
-       SearchService searchSvc;
-       
-       @Autowired 
-       DataAccessService dataAccessService;
+       private SearchService searchSvc;
 
        @Async
-       public Boolean getFunctionalMenu(UebMsg requestMsg)
-       {
+       public Boolean getFunctionalMenu(UebMsg requestMsg) {
                UebMsg returnMsg = new UebMsg();
-               
-               if (requestMsg == null)
-               {
+
+               if (requestMsg == null) {
                        logger.error(EELFLoggerDelegate.errorLogger, "handleMenuRequest received null message");
                        return false;
-               }
-               else if (requestMsg.getSourceTopicName() == null)
-               {
-                       logger.error(EELFLoggerDelegate.errorLogger, "A source topic name is required and not found in this msg:" + requestMsg.toString());
+               } else if (requestMsg.getSourceTopicName() == null) {
+                       logger.error(EELFLoggerDelegate.errorLogger,
+                                       "A source topic name is required and not found in this msg:" + requestMsg.toString());
                        return false;
-               }
-               else if (requestMsg.getUserId() == null)
-               {
-                       logger.debug(EELFLoggerDelegate.debugLogger, "Error getting functional menu.  A userId is required and not found in this msg: " + requestMsg.toString());
-                       returnMsg.putMsgId(requestMsg.getMsgId());  // echo tells requester this is a response
+               } else if (requestMsg.getUserId() == null) {
+                       logger.debug(EELFLoggerDelegate.debugLogger,
+                                       "Error getting functional menu.  A userId is required and not found in this msg: "
+                                                       + requestMsg.toString());
+                       returnMsg.putMsgId(requestMsg.getMsgId()); // echo tells requester this is a response
                        returnMsg.putPayload("Error: A userId is required.  Call msg.putUserId() with an userId");
-               }
-               else
-               {
-                       logger.debug(EELFLoggerDelegate.debugLogger, "Getting functional menu for user = " + requestMsg.getUserId());
+               } else {
+                       logger.debug(EELFLoggerDelegate.debugLogger,
+                                       "Getting functional menu for user = " + requestMsg.getUserId());
                        EPUser user = searchSvc.searchUserByUserId(requestMsg.getUserId());
-                       
+
                        List<FunctionalMenuItem> menuItems = null;
-                       if (user == null) 
-                       {
-                               logger.debug(EELFLoggerDelegate.debugLogger, "Error getting functional menu.  userId not found in directory or is guest: " + requestMsg.toString());
-                       } 
-               else if (adminRolesService.isSuperAdmin(user)) 
-               {  
-                               logger.debug(EELFLoggerDelegate.debugLogger, "FunctionalMenuHandler: SuperUser, about to call getFunctionalMenuItems()");
+                       if (user == null) {
+                               logger.debug(EELFLoggerDelegate.debugLogger,
+                                               "Error getting functional menu.  userId not found in directory or is guest: "
+                                                               + requestMsg.toString());
+                       } else if (adminRolesService.isSuperAdmin(user)) {
+                               logger.debug(EELFLoggerDelegate.debugLogger,
+                                               "FunctionalMenuHandler: SuperUser, about to call getFunctionalMenuItems()");
                                menuItems = functionalMenuService.getFunctionalMenuItems();
-                       } 
-               else 
-                       {
-                               logger.debug(EELFLoggerDelegate.debugLogger, "getMenuItemsForAuthUser: about to call getFunctionalMenuItemsForUser()");
+                       } else {
+                               logger.debug(EELFLoggerDelegate.debugLogger,
+                                               "getMenuItemsForAuthUser: about to call getFunctionalMenuItemsForUser()");
                                menuItems = functionalMenuService.getFunctionalMenuItemsForUser(requestMsg.getUserId());
                        }
-                   
-                       if ( menuItems != null )
-                   {
-                           String functionalMenuJsonString = new Gson().toJson(menuItems);
+
+                       if (menuItems != null) {
+                               String functionalMenuJsonString = new Gson().toJson(menuItems);
                                logger.debug(EELFLoggerDelegate.debugLogger, "returning functional menu : " + functionalMenuJsonString);
-                           returnMsg.putMsgId(requestMsg.getMsgId());  // echo tells requester this is a response
-                           returnMsg.putPayload(functionalMenuJsonString);
+                               returnMsg.putMsgId(requestMsg.getMsgId()); // echo tells requester this is a response
+                               returnMsg.putPayload(functionalMenuJsonString);
                        } else {
-                               returnMsg.putMsgId(requestMsg.getMsgId());  // echo tells requester this is a response
+                               returnMsg.putMsgId(requestMsg.getMsgId()); // echo tells requester this is a response
                                returnMsg.putPayload("Error: Not found for userId = " + requestMsg.getUserId());
                        }
                }
-           
+
                try {
-               UebManager.getInstance().publishReplyEP(returnMsg, requestMsg.getSourceTopicName());
-           } catch (UebException e) {
-               logger.error(EELFLoggerDelegate.errorLogger, "UebException occurred while responding to the Ueb message, Details:" + EcompPortalUtils.getStackTrace(e));
-           } catch (Exception e) {
-               logger.error(EELFLoggerDelegate.errorLogger, "Exception occurred while responding to the Ueb message, Details:" + EcompPortalUtils.getStackTrace(e));
-           }
-        
-        return true;
+                       UebManager.getInstance().publishReplyEP(returnMsg, requestMsg.getSourceTopicName());
+               } catch (UebException e) {
+                       logger.error(EELFLoggerDelegate.errorLogger,
+                                       "getFunctionalMenu failed to publish reply", e);
+               } catch (Exception e) {
+                       logger.error(EELFLoggerDelegate.errorLogger,
+                                       "getFunctionalMenu failed", e);
+               }
+
+               return true;
        }
 }