ecomp-portal-BE-common/src/main/java/org/onap/portalapp/portal/service/MicroserviceProxyService.java

   1 /*-
   2  * ============LICENSE_START==========================================
   3  * ONAP Portal
   4  * ===================================================================
   5  * Copyright (C) 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  *
  37  */
  38 package org.onap.portalapp.portal.service;
  39
  40 import javax.servlet.http.HttpServletRequest;
  41
  42 import org.onap.portalapp.portal.domain.EPUser;
  43
  44 public interface MicroserviceProxyService {
  45
  46         /**
  47          * Gets the specific microservice from table ep_microservice, communicates
  48          * to microservice with the specified security type. The microservice sends
  49          * back the response.
  50          *
  51          * Gets the data while testing the microservice with no widget associated with
  52          *
  53          * @param serviceId
  54          *            Id of microservice to be used
  55          * @return response sent from microservice
  56          * @throws Exception
  57          */
  58         String proxyToDestination(long serviceId, EPUser user, HttpServletRequest request) throws Exception;
  59
  60
  61
  62         /**
  63          * Gets the microservice data based on the user id and widget id. Different
  64          * users have his/her own parameters for one widget. The method sends back
  65          * the response.
  66          *
  67          * @param widgetId
  68          *                        Id of widget to be used
  69          * @param user
  70          *                        User information
  71          * @param request
  72          * @return response sent from microserivce
  73          * @throws Exception
  74          */
  75         String proxyToDestinationByWidgetId(long widgetId, EPUser user, HttpServletRequest request) throws Exception;
  76 }