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

   1 /*-\r
   2  * ================================================================================\r
   3  * ECOMP Portal\r
   4  * ================================================================================\r
   5  * Copyright (C) 2017 AT&T Intellectual Property\r
   6  * ================================================================================\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  * \r
  11  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * \r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  * ================================================================================\r
  19  */\r
  20 package org.openecomp.portalapp.portal.service;\r
  21 \r
  22 import java.util.List;\r
  23 \r
  24 import org.openecomp.portalapp.portal.domain.MicroserviceData;\r
  25 import org.openecomp.portalapp.portal.domain.MicroserviceParameter;\r
  26 \r
  27 public interface MicroserviceService {\r
  28 \r
  29         /**\r
  30          * Get all microservices from the ep_microservice\r
  31          * \r
  32          * @return list of all microservices\r
  33          * @throws Exception\r
  34          */\r
  35         List<MicroserviceData> getMicroserviceData() throws Exception;\r
  36 \r
  37         /**\r
  38          * Gets the specified microservice with id from ep_microservice\r
  39          * \r
  40          * @param id\r
  41          *            ID of microservice to be fetched\r
  42          * @return the microservice with the specified id\r
  43          */\r
  44         MicroserviceData getMicroserviceDataById(long id);\r
  45 \r
  46         /**\r
  47          * Saves the specified microservice to the table ep_microservice\r
  48          * \r
  49          * @param newService\r
  50          *            Content of microservice to be saved\r
  51          * @return new microservice id\r
  52          * @throws Exception\r
  53          */\r
  54         Long saveMicroservice(MicroserviceData newService) throws Exception;\r
  55 \r
  56         void saveServiceParameters(long serviceId, List<MicroserviceParameter> list) throws Exception;\r
  57 \r
  58         /**\r
  59          * Deletes the specified microservice from all tables where the serviceId is\r
  60          * used\r
  61          * \r
  62          * @param serviceId\r
  63          * @throws Exception\r
  64          */\r
  65         void deleteMicroservice(long serviceId) throws Exception;\r
  66 \r
  67         /**\r
  68          * Updates the specified microservice from all tables where the serviceId is\r
  69          * used\r
  70          * \r
  71          * @param serviceId\r
  72          *            Id of microservice to be updated\r
  73          * @param newService\r
  74          *            Content of microservice to be updated\r
  75          * @throws Exception\r
  76          */\r
  77         void updateMicroservice(long serviceId, MicroserviceData newService) throws Exception;\r
  78         \r
  79         /**\r
  80          * Gets the Service parameters by the service Id\r
  81          * @param serviceId\r
  82          * @return\r
  83          */\r
  84         List<MicroserviceParameter> getParametersById(long serviceId);\r
  85 \r
  86 }\r