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

   1 /*-
   2  * ============LICENSE_START==========================================
   3  * ONAP Portal
   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.openecomp.portalapp.portal.service;
  39
  40 import java.util.List;
  41
  42 import org.openecomp.portalapp.portal.domain.BasicAuthCredentials;
  43 import org.openecomp.portalapp.portal.domain.EPEndpoint;
  44
  45 public interface BasicAuthAccountService {
  46
  47         /**
  48          * Saves Basic Authentication account for external systems
  49          *
  50          * @param newCredential
  51          *            BasicAuthCredentials
  52          * @return Id of the newly created account
  53          * @throws Exception
  54          */
  55         Long saveBasicAuthAccount(BasicAuthCredentials newCredential) throws Exception;
  56
  57         /**
  58          * Saves Endpoint associated with a Basic Auth account
  59          *
  60          * @param endpoint
  61          *            EPEndpoint
  62          * @return Id of the newly created endpoint
  63          * @throws Exception
  64          */
  65         Long saveEndpoints(EPEndpoint endpoint) throws Exception;
  66
  67         /**
  68          * Saves Endpoint associated with a Basic Auth account
  69          *
  70          * @param accountId
  71          * @param endpointId
  72          * @throws Exception
  73          */
  74         void saveEndpointAccount(Long accountId, Long endpointId) throws Exception;
  75
  76         /**
  77          * Returns list of all BasicAuthCredentials in the sytem
  78          *
  79          * @return List<BasicAuthCredentials>
  80          * @throws Exception
  81          */
  82         List<BasicAuthCredentials> getAccountData() throws Exception;
  83
  84         /**
  85          * Deletes BasicAuthenticationAccount
  86          *
  87          * @param accountId
  88          * @throws Exception
  89          */
  90         void deleteEndpointAccout(Long accountId) throws Exception;
  91
  92         /**
  93          * Updates BasicAuthenticationAccount
  94          *
  95          * @param accountId
  96          * @param newCredential
  97          *            BasicAuthCredentials
  98          * @throws Exception
  99          */
 100         void updateBasicAuthAccount(Long accountId, BasicAuthCredentials newCredential) throws Exception;
 101 }