2 * ============LICENSE_START==========================================
4 * ===================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ===================================================================
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
13 * http://www.apache.org/licenses/LICENSE-2.0
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.
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
26 * https://creativecommons.org/licenses/by/4.0/
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.
34 * ============LICENSE_END============================================
37 package org.onap.portalapp.portal.controller;
39 import java.util.List;
41 import javax.servlet.http.HttpServletRequest;
42 import javax.servlet.http.HttpServletResponse;
44 import org.onap.aaf.cadi.aaf.AAFPermission;
45 import org.onap.portalapp.annotation.ApiVersion;
46 import org.onap.portalapp.portal.domain.CentralV2RoleFunction;
47 import org.onap.portalapp.portal.ecomp.model.PortalRestResponse;
48 import org.onap.portalapp.portal.ecomp.model.PortalRestStatusEnum;
49 import org.onap.portalapp.portal.logging.aop.EPAuditLog;
50 import org.onap.portalapp.portal.service.ExternalAccessRolesService;
51 import org.onap.portalapp.portal.transport.CentralV2Role;
52 import org.onap.portalsdk.core.domain.Role;
53 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
54 import org.onap.portalsdk.core.onboarding.util.AuthUtil;
55 import org.onap.portalsdk.core.restful.domain.EcompRole;
56 import org.onap.portalsdk.core.restful.domain.EcompUser;
57 import org.springframework.beans.factory.annotation.Autowired;
58 import org.springframework.context.annotation.EnableAspectJAutoProxy;
60 import io.swagger.annotations.ApiOperation;
62 @org.springframework.context.annotation.Configuration
63 @EnableAspectJAutoProxy
66 public class RolesController implements BasicAuthenticationController {
68 private static EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(RolesController.class);
71 final String LOGINID_PATTERN = "/v3/user/[a-zA-Z0-9]{1,25}$";
72 final String FUNCTION_CD_PATTERN = "/v3/function/[a-zA-Z0-9_-]{1,75}$";
74 final String DELETE_ROLEFUNCTION = "/v3/roleFunction/[a-zA-Z0-9_-]{1,75}$";
76 private static final String UEBKEY = "uebkey";
79 private ExternalAccessRolesService externalAccessRolesService;
82 ExternalAccessRolesController externalAccessRolesController;
85 @ApiOperation(value = "Gets roles for an application which is upgraded to newer version.", response = CentralV2Role.class, responseContainer = "Json")
86 @ApiVersion(max = "v3", service = "/v3/roles", min = 0, method = "GET")
87 public List<CentralV2Role> getV2RolesForApp(HttpServletRequest request, HttpServletResponse response)
89 return externalAccessRolesController.getV2RolesForApp(request, response);
92 @ApiVersion(max = "v3", service = LOGINID_PATTERN, min = 0, method = "GET")
93 public String getV2UserList(HttpServletRequest request, HttpServletResponse response, String loginId)
95 return externalAccessRolesController.getV2UserList(request, response, loginId);
98 @ApiVersion(max = "v3", service = "/v3/role", min = 0, method = "POST")
99 public PortalRestResponse<String> saveRole(HttpServletRequest request, HttpServletResponse response, Role role)
101 return externalAccessRolesController.saveRole(request, response, role);
104 @ApiVersion(max = "v3", service = "/v3/role/[0-9]{1,25}$", min = 0, method = "GET")
105 public CentralV2Role getV2RoleInfo(HttpServletRequest request, HttpServletResponse response, Long roleId)
107 return externalAccessRolesController.getV2RoleInfo(request, response, roleId);
110 @ApiVersion(max = "v3", service = "/v3/users", min = 0, method = "GET")
111 public List<EcompUser> getUsersOfApplication(HttpServletRequest request, HttpServletResponse response)
113 return externalAccessRolesController.getUsersOfApplication(request, response);
116 @ApiVersion(max = "v3", service = "/v3/functions", min = 0, method = "GET")
117 public List<CentralV2RoleFunction> getRoleFunctionsList(HttpServletRequest request, HttpServletResponse response)
119 return externalAccessRolesController.getV2RoleFunctionsList(request, response);
122 @ApiVersion(max = "v3", service = FUNCTION_CD_PATTERN, min = 0, method = "GET")
123 public CentralV2RoleFunction getRoleFunction(HttpServletRequest request, HttpServletResponse response, String code)
125 return externalAccessRolesController.getV2RoleFunction(request, response, code);
128 @ApiVersion(max = "v3", service = "/v3/roleFunction", min = 0, method = "POST")
129 public PortalRestResponse<String> saveRoleFunction(HttpServletRequest request, HttpServletResponse response,
130 String roleFunc) throws Exception {
131 return externalAccessRolesController.saveRoleFunction(request, response, roleFunc);
134 @ApiVersion(max = "v3", service = DELETE_ROLEFUNCTION, min = 0, method = "DELETE")
135 public PortalRestResponse<String> deleteRoleFunction(HttpServletRequest request, HttpServletResponse response,
136 String code) throws Exception {
137 return externalAccessRolesController.deleteRoleFunction(request, response, code);
140 @ApiVersion(max = "v3", service = "/v3/deleteRole/[0-9]{1,25}$", min = 0, method = "DELETE")
141 public PortalRestResponse<String> deleteRole(HttpServletRequest request, HttpServletResponse response, Long roleId)
143 return externalAccessRolesController.deleteRole(request, response, roleId);
146 @ApiVersion(max = "v3", service = "/v3/activeRoles", min = 0, method = "GET")
147 public List<CentralV2Role> getV2ActiveRoles(HttpServletRequest request, HttpServletResponse response)
149 return externalAccessRolesController.getV2ActiveRoles(request, response);
152 @ApiVersion(max = "v3", service = "/v3/upload/portal/functions", min = 0, method = "POST")
153 public PortalRestResponse<String> bulkUploadFunctions(HttpServletRequest request, HttpServletResponse response)
155 return externalAccessRolesController.bulkUploadFunctions(request, response);
158 @ApiVersion(max = "v3", service = "/v3/upload/portal/roles", min = 0, method = "POST")
159 public PortalRestResponse<String> bulkUploadRoles(HttpServletRequest request, HttpServletResponse response)
161 return externalAccessRolesController.bulkUploadRoles(request, response);
164 @ApiVersion(max = "v3", service = "/v3/upload/portal/roleFunctions", min = 0, method = "POST")
165 public PortalRestResponse<String> bulkUploadRoleFunctions(HttpServletRequest request, HttpServletResponse response)
167 return externalAccessRolesController.bulkUploadRoleFunctions(request, response);
170 @ApiVersion(max = "v3", service = "/v3/upload/portal/userRoles", min = 0, method = "POST")
171 public PortalRestResponse<String> bulkUploadUserRoles(HttpServletRequest request, HttpServletResponse response)
173 return externalAccessRolesController.bulkUploadUserRoles(request, response);
176 @ApiVersion(max = "v3", service = "/v3/upload/portal/userRole/[0-9]{1,25}$", min = 0, method = "POST")
177 public PortalRestResponse<String> bulkUploadUsersSingleRole(HttpServletRequest request,
178 HttpServletResponse response, Long roleId) throws Exception {
179 return externalAccessRolesController.bulkUploadUsersSingleRole(request, response, roleId);
182 @ApiVersion(max = "v3", service = "/v3/upload/partner/functions", min = 0, method = "POST")
183 public PortalRestResponse<String> bulkUploadPartnerFunctions(HttpServletRequest request,
184 HttpServletResponse response) throws Exception {
185 return externalAccessRolesController.bulkUploadPartnerFunctions(request, response);
188 @ApiVersion(max = "v3", service = "/v3/upload/partner/roles", min = 0, method = "POST")
189 public PortalRestResponse<String> bulkUploadPartnerRoles(HttpServletRequest request, HttpServletResponse response,
190 List<Role> upload) throws Exception {
191 return externalAccessRolesController.bulkUploadPartnerRoles(request, response, upload);
194 @ApiVersion(max = "v3", service = "/v3/upload/partner/roleFunctions", min = 0, method = "POST")
195 public PortalRestResponse<String> bulkUploadPartnerRoleFunctions(HttpServletRequest request,
196 HttpServletResponse response) throws Exception {
197 return externalAccessRolesController.bulkUploadPartnerRoleFunctions(request, response);
200 @ApiVersion(max = "v3", service = "/v3/menuFunctions", min = 0, method = "GET")
201 public List<String> getMenuFunctions(HttpServletRequest request, HttpServletResponse response) throws Exception {
202 return externalAccessRolesController.getMenuFunctions(request, response);
205 @ApiVersion(max = "v3", service = "/v3/update/app/roleDescription", min = 0, method = "PUT")
206 public PortalRestResponse<String> updateAppRoleDescription(HttpServletRequest request, HttpServletResponse response)
208 Integer updatedRoleDesc = 0;
210 updatedRoleDesc = externalAccessRolesService.updateAppRoleDescription(request.getHeader(UEBKEY));
211 } catch (Exception e) {
212 response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
213 logger.error(EELFLoggerDelegate.errorLogger, "updateAppRoleDescription: failed!", e);
214 return new PortalRestResponse<String>(PortalRestStatusEnum.ERROR,
215 "updateAppRoleDescription: " + e.getMessage(), "Failure");
217 return new PortalRestResponse<String>(PortalRestStatusEnum.OK,
218 "Successfully updated app role descriptions: '" + updatedRoleDesc + "'", "Success");
221 @ApiVersion(max = "v4", service = "/v4/user/[a-zA-Z0-9]{1,25}$", min = 0, method = "GET")
222 public String getEcompUser(HttpServletRequest request, HttpServletResponse response, String loginId)
224 return externalAccessRolesController.getEcompUser(request, response, loginId);
227 @ApiVersion(max = "v4", service = "/v4/roles", min = 0, method = "GET")
228 public List<EcompRole> getEcompRolesOfApplication(HttpServletRequest request, HttpServletResponse response)
230 return externalAccessRolesController.getEcompRolesOfApplication(request, response);
233 @ApiVersion(max = "v3", service = "/v3/systemUser", min = 0, method = "GET")
234 public List<AAFPermission> getSystemUser(HttpServletRequest request, HttpServletResponse response)
236 return AuthUtil.getAAFPermissions(request);