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

   1 /*-
   2  * ============LICENSE_START==========================================
   3  * ONAP Portal SDK
   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 org.apache.cxf.transport.http.HTTPException;
  41 import org.openecomp.portalapp.util.SystemType;
  42
  43 public interface ApplicationsRestClientService {
  44         public <T> T get(Class<T> clazz, long app, String restPath) throws HTTPException;
  45         public String getIncomingJsonString(long appId, String restPath) throws HTTPException;
  46
  47         public <T> T post(Class<T> clazz, long appId, Object payload, String restPath) throws HTTPException;
  48         public <T> T post(Class<T> clazz, long appId, Object payload, String restPath, SystemType type) throws HTTPException;
  49
  50         public <T> T put(Class<T> clazz, long appId, Object payload, String restPath) throws HTTPException;
  51
  52         /**
  53          * Sends a GET request to the specified application at the specified path.
  54          * This is a workaround for a problem triggered by a superclass/subclass
  55          * with identical field names.
  56          *
  57          * @param clazz
  58          *            Expected response type
  59          * @param appId
  60          *            Application ID
  61          * @param restPath
  62          *            Path at the remote application
  63          * @param useJacksonMapper
  64          *            If true, uses a com.fasterxml.jackson.databind.ObjectMapper to
  65          *            translate the remote application response from JSON to an
  66          *            object. Otherwise, uses a com.google.gson.Gson.
  67          * @return Instance of the specified class
  68          * @throws HTTPException
  69          */
  70         public <T> T get(Class<T> clazz, long appId, String restPath, boolean useJacksonMapper) throws HTTPException;
  71 }