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

   1 /*-
   2  * ================================================================================
   3  * ECOMP Portal
   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.portalapp.portal.service;
  21
  22 import java.util.List;
  23
  24 import org.openecomp.portalapp.portal.domain.MicroserviceData;
  25 import org.openecomp.portalapp.portal.domain.MicroserviceParameter;
  26
  27 public interface MicroserviceService {
  28
  29         /**
  30          * Get all microservices from the ep_microservice
  31          *
  32          * @return list of all microservices
  33          * @throws Exception
  34          */
  35         List<MicroserviceData> getMicroserviceData() throws Exception;
  36
  37         /**
  38          * Gets the specified microservice with id from ep_microservice
  39          *
  40          * @param id
  41          *            ID of microservice to be fetched
  42          * @return the microservice with the specified id
  43          */
  44         MicroserviceData getMicroserviceDataById(long id);
  45
  46         /**
  47          * Saves the specified microservice to the table ep_microservice
  48          *
  49          * @param newService
  50          *            Content of microservice to be saved
  51          * @return new microservice id
  52          * @throws Exception
  53          */
  54         Long saveMicroservice(MicroserviceData newService) throws Exception;
  55
  56         void saveServiceParameters(long serviceId, List<MicroserviceParameter> list) throws Exception;
  57
  58         /**
  59          * Deletes the specified microservice from all tables where the serviceId is
  60          * used
  61          *
  62          * @param serviceId
  63          * @throws Exception
  64          */
  65         void deleteMicroservice(long serviceId) throws Exception;
  66
  67         /**
  68          * Updates the specified microservice from all tables where the serviceId is
  69          * used
  70          *
  71          * @param serviceId
  72          *            Id of microservice to be updated
  73          * @param newService
  74          *            Content of microservice to be updated
  75          * @throws Exception
  76          */
  77         void updateMicroservice(long serviceId, MicroserviceData newService) throws Exception;
  78
  79         /**
  80          * Gets the Service parameters by the service Id
  81          *
  82          * @param serviceId
  83          * @return List<MicroserviceParameter>
  84          */
  85         List<MicroserviceParameter> getParametersById(long serviceId);
  86
  87 }