portal-BE/src/main/java/org/onap/portal/controller/RolesController.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 package org.onap.portal.controller;
  38
  39 import io.swagger.annotations.ApiOperation;
  40 import java.util.List;
  41 import javax.servlet.http.HttpServletRequest;
  42 import javax.servlet.http.HttpServletResponse;
  43 import org.onap.aaf.cadi.aaf.AAFPermission;
  44 import org.onap.portal.annotation.ApiVersion;
  45 import org.onap.portal.domain.db.ep.EpAppFunction;
  46 import org.onap.portal.domain.dto.PortalRestResponse;
  47 import org.onap.portal.domain.dto.PortalRestStatusEnum;
  48 import org.onap.portal.domain.dto.transport.CentralV2Role;
  49 import org.onap.portal.logging.aop.EPAuditLog;
  50 import org.onap.portal.service.ExternalAccessRolesService;
  51 import org.onap.portalsdk.core.domain.Role;
  52 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
  53 import org.onap.portalsdk.core.onboarding.util.AuthUtil;
  54 import org.onap.portalsdk.core.restful.domain.EcompRole;
  55 import org.onap.portalsdk.core.restful.domain.EcompUser;
  56 import org.springframework.beans.factory.annotation.Autowired;
  57 import org.springframework.context.annotation.EnableAspectJAutoProxy;
  58 import org.springframework.web.bind.annotation.RestController;
  59
  60 @RestController
  61 @EnableAspectJAutoProxy
  62 @EPAuditLog
  63 @ApiVersion
  64 public class RolesController {
  65
  66     private static EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(RolesController.class);
  67
  68
  69     final String LOGINID_PATTERN = "/v3/user/[a-zA-Z0-9]{1,25}$";
  70     final String FUNCTION_CD_PATTERN = "/v3/function/[a-zA-Z0-9_-]{1,75}$";
  71
  72     final String DELETE_ROLEFUNCTION = "/v3/roleFunction/[a-zA-Z0-9_-]{1,75}$";
  73
  74     private static final String UEBKEY = "uebkey";
  75
  76     private final ExternalAccessRolesService externalAccessRolesService;
  77     private final ExternalAccessRolesController externalAccessRolesController;
  78
  79     @Autowired
  80     public RolesController(ExternalAccessRolesService externalAccessRolesService,
  81         ExternalAccessRolesController externalAccessRolesController) {
  82         this.externalAccessRolesService = externalAccessRolesService;
  83         this.externalAccessRolesController = externalAccessRolesController;
  84     }
  85
  86
  87     @ApiOperation(value = "Gets roles for an application which is upgraded to newer version.", response = CentralV2Role.class, responseContainer = "Json")
  88     @ApiVersion(max = "v3", service = "/v3/roles", min = 0, method = "GET")
  89     public List<CentralV2Role> getV2RolesForApp(HttpServletRequest request, HttpServletResponse response)
  90         throws Exception {
  91         return externalAccessRolesController.getV2RolesForApp(request, response);
  92     }
  93
  94     @ApiVersion(max = "v3", service = LOGINID_PATTERN, min = 0, method = "GET")
  95     public String getV2UserList(HttpServletRequest request, HttpServletResponse response, String loginId)
  96         throws Exception {
  97         return externalAccessRolesController.getV2UserList(request, response, loginId);
  98     }
  99
 100     @ApiVersion(max = "v3", service = "/v3/role", min = 0, method = "POST")
 101     public PortalRestResponse<String> saveRole(HttpServletRequest request, HttpServletResponse response, Role role)
 102         throws Exception {
 103         return externalAccessRolesController.saveRole(request, response, role);
 104     }
 105
 106     @ApiVersion(max = "v3", service = "/v3/role/[0-9]{1,25}$", min = 0, method = "GET")
 107     public CentralV2Role getV2RoleInfo(HttpServletRequest request, HttpServletResponse response, Long roleId)
 108         throws Exception {
 109         return externalAccessRolesController.getV2RoleInfo(request, response, roleId);
 110     }
 111
 112     @ApiVersion(max = "v3", service = "/v3/users", min = 0, method = "GET")
 113     public List<EcompUser> getUsersOfApplication(HttpServletRequest request, HttpServletResponse response)
 114         throws Exception {
 115         return externalAccessRolesController.getUsersOfApplication(request, response);
 116     }
 117
 118     @ApiVersion(max = "v3", service = "/v3/functions", min = 0, method = "GET")
 119     public List<EpAppFunction> getRoleFunctionsList(HttpServletRequest request, HttpServletResponse response)
 120         throws Exception {
 121         return externalAccessRolesController.getV2RoleFunctionsList(request, response);
 122     }
 123
 124     @ApiVersion(max = "v3", service = FUNCTION_CD_PATTERN, min = 0, method = "GET")
 125     public EpAppFunction getRoleFunction(HttpServletRequest request, HttpServletResponse response, String code)
 126         throws Exception {
 127         return externalAccessRolesController.getV2RoleFunction(request, response, code);
 128     }
 129
 130     @ApiVersion(max = "v3", service = "/v3/roleFunction", min = 0, method = "POST")
 131     public PortalRestResponse<String> saveRoleFunction(HttpServletRequest request, HttpServletResponse response,
 132         String roleFunc) throws Exception {
 133         return externalAccessRolesController.saveRoleFunction(request, response, roleFunc);
 134     }
 135
 136     @ApiVersion(max = "v3", service = DELETE_ROLEFUNCTION, min = 0, method = "DELETE")
 137     public PortalRestResponse<String> deleteRoleFunction(HttpServletRequest request, HttpServletResponse response,
 138         String code) throws Exception {
 139         return externalAccessRolesController.deleteRoleFunction(request, response, code);
 140     }
 141
 142     @ApiVersion(max = "v3", service = "/v3/deleteRole/[0-9]{1,25}$", min = 0, method = "DELETE")
 143     public PortalRestResponse<String> deleteRole(HttpServletRequest request, HttpServletResponse response, Long roleId)
 144         throws Exception {
 145         return externalAccessRolesController.deleteRole(request, response, roleId);
 146     }
 147
 148     @ApiVersion(max = "v3", service = "/v3/activeRoles", min = 0, method = "GET")
 149     public List<CentralV2Role> getV2ActiveRoles(HttpServletRequest request, HttpServletResponse response)
 150         throws Exception {
 151         return externalAccessRolesController.getV2ActiveRoles(request, response);
 152     }
 153
 154     @ApiVersion(max = "v3", service = "/v3/upload/portal/functions", min = 0, method = "POST")
 155     public PortalRestResponse<String> bulkUploadFunctions(HttpServletRequest request, HttpServletResponse response)
 156         throws Exception {
 157         return externalAccessRolesController.bulkUploadFunctions(request, response);
 158     }
 159
 160     @ApiVersion(max = "v3", service = "/v3/upload/portal/roles", min = 0, method = "POST")
 161     public PortalRestResponse<String> bulkUploadRoles(HttpServletRequest request, HttpServletResponse response)
 162         throws Exception {
 163         return externalAccessRolesController.bulkUploadRoles(request, response);
 164     }
 165
 166     @ApiVersion(max = "v3", service = "/v3/upload/portal/roleFunctions", min = 0, method = "POST")
 167     public PortalRestResponse<String> bulkUploadRoleFunctions(HttpServletRequest request, HttpServletResponse response)
 168         throws Exception {
 169         return externalAccessRolesController.bulkUploadRoleFunctions(request, response);
 170     }
 171
 172     @ApiVersion(max = "v3", service = "/v3/upload/portal/userRoles", min = 0, method = "POST")
 173     public PortalRestResponse<String> bulkUploadUserRoles(HttpServletRequest request, HttpServletResponse response)
 174         throws Exception {
 175         return externalAccessRolesController.bulkUploadUserRoles(request, response);
 176     }
 177
 178     @ApiVersion(max = "v3", service = "/v3/upload/portal/userRole/[0-9]{1,25}$", min = 0, method = "POST")
 179     public PortalRestResponse<String> bulkUploadUsersSingleRole(HttpServletRequest request,
 180         HttpServletResponse response, Long roleId) throws Exception {
 181         return externalAccessRolesController.bulkUploadUsersSingleRole(request, response, roleId);
 182     }
 183
 184     @ApiVersion(max = "v3", service = "/v3/upload/partner/functions", min = 0, method = "POST")
 185     public PortalRestResponse<String> bulkUploadPartnerFunctions(HttpServletRequest request,
 186         HttpServletResponse response) throws Exception {
 187         return externalAccessRolesController.bulkUploadPartnerFunctions(request, response);
 188     }
 189
 190     //not using this
 191     @ApiVersion(max = "v3", service = "/v3/upload/partner/roles", min = 0, method = "POST")
 192     public PortalRestResponse<String> bulkUploadPartnerRoles(HttpServletRequest request, HttpServletResponse response,
 193         List<Role> upload) throws Exception {
 194         return externalAccessRolesController.bulkUploadPartnerRoles(request, response, upload);
 195     }
 196
 197     @ApiVersion(max = "v3", service = "/v3/upload/partner/roleFunctions", min = 0, method = "POST")
 198     public PortalRestResponse<String> bulkUploadPartnerRoleFunctions(HttpServletRequest request,
 199         HttpServletResponse response) throws Exception {
 200         return externalAccessRolesController.bulkUploadPartnerRoleFunctions(request, response);
 201     }
 202
 203     @ApiVersion(max = "v3", service = "/v3/menuFunctions", min = 0, method = "GET")
 204     public List<String> getMenuFunctions(HttpServletRequest request, HttpServletResponse response) throws Exception {
 205         return externalAccessRolesController.getMenuFunctions(request, response);
 206     }
 207
 208     @ApiVersion(max = "v3", service = "/v3/update/app/roleDescription", min = 0, method = "PUT")
 209     public PortalRestResponse<String> updateAppRoleDescription(HttpServletRequest request, HttpServletResponse response)
 210         throws Exception {
 211         Integer updatedRoleDesc = 0;
 212         try {
 213             updatedRoleDesc = externalAccessRolesService.updateAppRoleDescription(request.getHeader(UEBKEY));
 214         } catch (Exception e) {
 215             response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
 216             logger.error(EELFLoggerDelegate.errorLogger, "updateAppRoleDescription: failed!", e);
 217             return new PortalRestResponse<>(PortalRestStatusEnum.ERROR,
 218                 "updateAppRoleDescription: " + e.getMessage(), "Failure");
 219         }
 220         return new PortalRestResponse<String>(PortalRestStatusEnum.OK,
 221             "Successfully updated app role descriptions: '" + updatedRoleDesc + "'", "Success");
 222     }
 223
 224     @ApiVersion(max = "v4", service = "/v4/user/[a-zA-Z0-9]{1,25}$", min = 0, method = "GET")
 225     public String getEcompUser(HttpServletRequest request, HttpServletResponse response, String loginId)
 226         throws Exception {
 227         return externalAccessRolesController.getEcompUser(request, response, loginId);
 228     }
 229
 230     @ApiVersion(max = "v4", service = "/v4/roles", min = 0, method = "GET")
 231     public List<EcompRole> getEcompRolesOfApplication(HttpServletRequest request, HttpServletResponse response)
 232         throws Exception {
 233         return externalAccessRolesController.getEcompRolesOfApplication(request, response);
 234     }
 235
 236     @ApiVersion(max = "v3", service = "/v3/systemUser", min = 0, method = "GET")
 237     public List<AAFPermission> getSystemUser(HttpServletRequest request, HttpServletResponse response)
 238         throws Exception {
 239         return AuthUtil.getAAFPermissions(request);
 240     }
 241 }