gerrit.onap Code Review - portal/sdk.git/blob

   1 /*-
   2  * ============LICENSE_START==========================================
   3  * ONAP Portal SDK
   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  */
  38 package org.onap.portalsdk.external.authorization.service;
  39
  40 import java.util.List;
  41
  42 import javax.servlet.http.HttpServletRequest;
  43
  44 import org.onap.portalsdk.core.domain.RoleFunction;
  45 import org.onap.portalsdk.core.domain.User;
  46 import org.onap.portalsdk.external.authorization.domain.ExternalAccessPerms;
  47 import org.onap.portalsdk.external.authorization.exception.UserNotFoundException;
  48 import org.springframework.http.ResponseEntity;
  49
  50 public interface UserApiService {
  51
  52         /**
  53          * Gets list of all roles associated to user from external system
  54          *
  55          * @param orgUserId
  56          * @return
  57          * @throws Exception
  58          */
  59         User getUser(String orgUserId, HttpServletRequest request) throws UserNotFoundException;
  60
  61         /**
  62          *
  63          * @param OrgUserId
  64          * @return
  65          */
  66         List<RoleFunction> getRoleFunctions(String orgUserId) throws Exception;
  67
  68         /**
  69          *  Check if user exist in external auth system
  70          *
  71          * @param username
  72          * @param password
  73          * @return Response<String>
  74          * @throws Exception
  75          */
  76         ResponseEntity<String> checkUserExists(String username, String password) throws Exception;
  77
  78         /**
  79          * Get if user has any perms
  80          *
  81          * @param username
  82          * @param password
  83          * @return List<ExternalAccessPerms>
  84          * @throws Exception
  85          */
  86         List<ExternalAccessPerms> getIfUserPermsExists(String username) throws Exception;
  87 }