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

   1 /*-
   2  * ================================================================================
   3  * ECOMP Portal SDK
   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 package org.openecomp.portalsdk.core.onboarding.crossapi;
  21
  22 import org.openecomp.portalsdk.core.onboarding.exception.PortalAPIException;
  23
  24 /**
  25  *
  26  * @author Ikram Ikramullah
  27  *
  28  *  UEB API Interface for all the onboarding third party applications.
  29  *
  30  */
  31
  32 public interface IPortalUebAPIService {
  33         //User Interface
  34         public String pushUser(String userJson) throws PortalAPIException;
  35         public String editUser(String loginId, String userJson)  throws PortalAPIException;
  36         public String getUser(String loginId) throws PortalAPIException;
  37         public String getUsers() throws PortalAPIException;
  38
  39         //Roles Interface
  40         public String getAvailableRoles() throws PortalAPIException;
  41         public String getAvailableFullRoles() throws PortalAPIException;
  42         public String pushUserRole(String loginId, String rolesJson) throws PortalAPIException;
  43         public String getUserRoles(String loginId) throws PortalAPIException;
  44
  45         //Security Interface
  46         public boolean isAppAuthenticated(String appUserName, String appPassword) throws PortalAPIException;
  47 }