common/src/main/java/org/onap/so/rest/service/HttpRestServiceProvider.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.onap.so.rest.service;
  22
  23 import com.google.common.base.Optional;
  24 import org.springframework.http.ResponseEntity;
  25
  26 /**
  27  * @author waqas.ikram@est.tech
  28  */
  29 public interface HttpRestServiceProvider {
  30
  31     /**
  32      * Execute the HTTP GET to the given URI template
  33      *
  34      * @param url the URL
  35      * @param clazz the type of the return value
  36      * @return Returns the body of this entity.
  37      */
  38     <T> Optional<T> get(final String url, final Class<T> clazz);
  39
  40     /**
  41      * Execute the HTTP GET to the given URI template
  42      *
  43      * @param url the URL
  44      * @param clazz the type of the return value
  45      * @return Returns the {@link ResponseEntity}.
  46      */
  47     <T> ResponseEntity<T> getHttpResponse(final String url, final Class<T> clazz);
  48
  49
  50     /**
  51      * Execute the HTTP POST to the given URI template
  52      *
  53      * @param object the entity (i.e. body) to write to the request
  54      * @param url the URL
  55      * @param clazz the type of the return value
  56      * @return Returns the body of this entity.
  57      */
  58     <T> Optional<T> post(final Object object, final String url, final Class<T> clazz);
  59
  60     /**
  61      * Execute the HTTP POST to the given URI template
  62      *
  63      * @param object the entity (i.e. body) to write to the request
  64      * @param url the URL
  65      * @param clazz the type of the return value
  66      * @return Returns the {@link ResponseEntity}.
  67      */
  68     <T> ResponseEntity<T> postHttpRequest(final Object object, final String url, final Class<T> clazz);
  69
  70     /**
  71      * Execute the HTTP PUT to the given URI template
  72      *
  73      * @param object the entity (i.e. body) to write to the request
  74      * @param url the URL
  75      * @param clazz the type of the return value
  76      * @return Returns the body of this entity.
  77      */
  78     <T> Optional<T> put(final Object object, final String url, final Class<T> clazz);
  79
  80     /**
  81      * Execute the HTTP PUT to the given URI template
  82      *
  83      * @param object the entity (i.e. body) to write to the request
  84      * @param url the URL
  85      * @param clazz the type of the return value
  86      * @return Returns the {@link ResponseEntity}.
  87      */
  88     <T> ResponseEntity<T> putHttpRequest(final Object object, final String url, final Class<T> clazz);
  89
  90
  91 }