sdnc-a1-controller/northbound/nonrt-ric-api/provider/src/main/java/org/o_ran_sc/nonrtric/sdnc_a1/northbound/restadapter/RestAdapter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.o_ran_sc.nonrtric.sdnc_a1.northbound.restadapter;
  22
  23 import org.springframework.http.ResponseEntity;
  24
  25 /**
  26  * An interface to wrap the generic HTTP methods
  27  *
  28  * @author lathishbabu.ganesan@est.tech
  29  *
  30  */
  31 public interface RestAdapter {
  32
  33   /**
  34    * Retrieve a representation by doing a GET on the specified URL. The response (if any) is
  35    * converted and returned.
  36    *
  37    * @param uri the URL
  38    * @param clazz responseType the type of the return value
  39    * @return the converted object
  40    */
  41
  42   <T> ResponseEntity<T> get(final String url, final Class<?> clazz);
  43
  44   /**
  45    * Create or update a resource by PUTting the given object to the URI.
  46    *
  47    * @param url the URL
  48    * @param request the String to be PUT (may be {@code null})
  49    * @param clazz responseType the type of the return value
  50    * @return the response code
  51    */
  52   <T> ResponseEntity<T> put(final String url, final String body, final Class<T> clazz);
  53
  54   /**
  55    * Delete resource for the given object to the URI.
  56    *
  57    * @param url the URL
  58    * @return the response code
  59    */
  60   <T> ResponseEntity<T> delete(final String url);
  61
  62 }