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

   1 /*
   2  * ============LICENSE_START==========================================
   3  * ONAP Portal SDK
   4  * ===================================================================
   5  * Copyright © 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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  37  */
  38 package org.onap.portalsdk.core.onboarding.crossapi;
  39
  40 import org.onap.portalsdk.core.onboarding.exception.PortalAPIException;
  41
  42 /**
  43  * UEB API Interface for all the onboarding third party applications.
  44  */
  45
  46 public interface IPortalUebAPIService {
  47         // User Interface
  48         public String pushUser(String userJson) throws PortalAPIException;
  49
  50         public String editUser(String loginId, String userJson) throws PortalAPIException;
  51
  52         public String getUser(String loginId) throws PortalAPIException;
  53
  54         public String getUsers() throws PortalAPIException;
  55
  56         // Roles Interface
  57         public String getAvailableRoles() throws PortalAPIException;
  58
  59         public String getAvailableFullRoles() throws PortalAPIException;
  60
  61         public String pushUserRole(String loginId, String rolesJson) throws PortalAPIException;
  62
  63         public String getUserRoles(String loginId) throws PortalAPIException;
  64
  65         // Security Interface
  66         public boolean isAppAuthenticated(String appUserName, String appPassword) throws PortalAPIException;
  67 }