/*-
 * ============LICENSE_START==========================================
 * ONAP Portal SDK
 * ===================================================================
 * Copyright (C) 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
 *
 * 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============================================
 *
 * 
 */
package org.onap.portalsdk.external.authorization.service;

import java.util.List;

import javax.servlet.http.HttpServletRequest;

import org.onap.portalsdk.core.domain.RoleFunction;
import org.onap.portalsdk.core.domain.User;
import org.onap.portalsdk.external.authorization.domain.ExternalAccessPerms;
import org.onap.portalsdk.external.authorization.exception.UserNotFoundException;
import org.springframework.http.ResponseEntity;

public interface UserApiService {
	
	/**
	 * Gets list of all roles associated to user from external system
	 * 
	 * @param orgUserId
	 * @return 
	 * @throws Exception 
	 */
	User getUser(String orgUserId, HttpServletRequest request) throws UserNotFoundException;
	
	/**
	 * 
	 * @param OrgUserId
	 * @return
	 */
	List<RoleFunction> getRoleFunctions(String orgUserId) throws Exception;
	
	/**
	 *  Check if user exist in external auth system
	 *  
	 * @param username
	 * @param password
	 * @return Response<String>
	 * @throws Exception
	 */
	ResponseEntity<String> checkUserExists(String username, String password) throws Exception;
	
	/**
	 * Get if user has any perms
	 * 
	 * @param username
	 * @param password
	 * @return List<ExternalAccessPerms>
	 * @throws Exception
	 */
	List<ExternalAccessPerms> getIfUserPermsExists(String username) throws Exception;
}