ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/service/UserRolesService.java

   1 /*-
   2  * ================================================================================
   3  * ECOMP Portal
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ================================================================================
  19  */
  20
  21 package org.openecomp.portalapp.portal.service;
  22
  23 import java.util.List;
  24
  25 import org.apache.cxf.transport.http.HTTPException;
  26 import org.openecomp.portalapp.externalsystemapproval.model.ExternalSystemUser;
  27 import org.openecomp.portalapp.portal.domain.EPRole;
  28 import org.openecomp.portalapp.portal.domain.EPUser;
  29 import org.openecomp.portalapp.portal.domain.EPUserApp;
  30 import org.openecomp.portalapp.portal.domain.EPUserAppCatalogRoles;
  31 import org.openecomp.portalapp.portal.domain.ExternalSystemAccess;
  32 import org.openecomp.portalapp.portal.transport.AppWithRolesForUser;
  33 import org.openecomp.portalapp.portal.transport.ExternalRequestFieldsValidator;
  34 import org.openecomp.portalapp.portal.transport.FieldsValidator;
  35 import org.openecomp.portalapp.portal.transport.RoleInAppForUser;
  36 import org.openecomp.portalapp.portal.transport.UserApplicationRoles;
  37
  38 public interface UserRolesService {
  39
  40         /**
  41          * Returns list of app roles of a single app
  42          *
  43          * @param appId
  44          *            ID of row in fn_app
  45          * @param userId
  46          *            ID of row in fn_user
  47          * @param extRequestValue
  48          *            set to false if request is from users page otherwise true
  49          * @return List<RoleInAppForUser>
  50          */
  51         public List<RoleInAppForUser> getAppRolesForUser(Long appId, String userId, Boolean extRequestValue);
  52
  53         public boolean setAppWithUserRoleStateForUser(EPUser user, AppWithRolesForUser newAppRolesForUser);
  54
  55         public List<UserApplicationRoles> getUsersFromAppEndpoint(Long appId) throws HTTPException;
  56
  57         public List<EPRole> importRolesFromRemoteApplication(Long appId) throws HTTPException;
  58
  59         /**
  60          * Gets entries from the local fn_user_role table for the specified user and
  61          * app.
  62          *
  63          * @param appId
  64          *            ID of row in fn_app
  65          * @param userId
  66          *            ID of row in fn_user
  67          * @return List of EPRole; empty if none found.
  68          */
  69         public List<EPUserApp> getCachedAppRolesForUser(Long appId, Long userId);
  70
  71         public FieldsValidator putUserAppRolesRequest(AppWithRolesForUser userAppRolesData, EPUser user);
  72
  73         /**
  74          * Save user app roles in the database from the external request
  75          *
  76          * @param newAppRolesForUser
  77          *
  78          *            contains login id, app name, request id, and list of role
  79          *            names
  80          * @param reqType
  81          * @return if any exceptions, returns detail message and true or false
  82          */
  83         ExternalRequestFieldsValidator setExternalRequestUserAppRole(ExternalSystemUser newAppRolesForUser, String reqType);
  84
  85         public List<EPUserAppCatalogRoles> getUserAppCatalogRoles(EPUser user, String appName);
  86
  87         public String updateRemoteUserProfile(String orgUserId, Long appId);
  88
  89         public ExternalSystemAccess getExternalRequestAccess();
  90
  91 }