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 org.springframework.http.ResponseEntity;
  24
  25 import com.google.common.base.Optional;
  26
  27 /**
  28  * @author waqas.ikram@est.tech
  29  */
  30 public interface HttpRestServiceProvider {
  31
  32     /**
  33      * Execute the HTTP GET to the given URI template
  34      *
  35      * @param url the URL
  36      * @param clazz the type of the return value
  37      * @return Returns the body of this entity.
  38      */
  39     public <T> Optional<T> get(final String url, final Class<T> clazz);
  40
  41     /**
  42      * Execute the HTTP GET to the given URI template
  43      *
  44      * @param url the URL
  45      * @param clazz the type of the return value
  46      * @return Returns the {@link ResponseEntity}.
  47      */
  48     public <T> ResponseEntity<T> getHttpResponse(final String url, final Class<T> clazz);
  49
  50
  51     /**
  52      * Execute the HTTP POST to the given URI template
  53      *
  54      * @param object the entity (i.e. body) to write to the request
  55      * @param url the URL
  56      * @param clazz the type of the return value
  57      * @return Returns the body of this entity.
  58      */
  59     public <T> Optional<T> post(final Object object, final String url, final Class<T> clazz);
  60
  61     /**
  62      * Execute the HTTP POST to the given URI template
  63      *
  64      * @param object the entity (i.e. body) to write to the request
  65      * @param url the URL
  66      * @param clazz the type of the return value
  67      * @return Returns the {@link ResponseEntity}.
  68      */
  69     public <T> ResponseEntity<T> postHttpRequest(final Object object, final String url, final Class<T> clazz);
  70
  71
  72 }