ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/service/MicroserviceProxyService.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 javax.servlet.http.HttpServletRequest;\r
  23 \r
  24 import org.openecomp.portalapp.portal.domain.EPUser;\r
  25 import org.springframework.web.client.RestClientException;\r
  26 \r
  27 public interface MicroserviceProxyService {\r
  28 \r
  29         /**\r
  30          * Gets the specific microservice from table ep_microservice, communicates\r
  31          * to microservice with the specified security type. The microservice sends\r
  32          * back the response.\r
  33          * \r
  34          * Gets the data while testing the microservice with no widget associated with\r
  35          * \r
  36          * @param serviceId\r
  37          *            Id of microservice to be used\r
  38          * @return response sent from microservice\r
  39          * @throws Exception\r
  40          */\r
  41         String proxyToDestination(long serviceId, EPUser user, HttpServletRequest request) throws Exception;\r
  42         \r
  43         \r
  44         \r
  45         /**\r
  46          * Gets the microservice data based on the user id and widget id. Different\r
  47          * users have his/her own parameters for one widget. The method sends back\r
  48          * the response.\r
  49          * \r
  50          * @param widgetId\r
  51          *                        Id of widget to be used\r
  52          * @param user\r
  53          *                        User information\r
  54          * @param request\r
  55          * @return response sent from microserivce \r
  56          * @throws Exception\r
  57          */\r
  58         String proxyToDestinationByWidgetId(long widgetId, EPUser user, HttpServletRequest request) throws Exception;\r
  59 }\r