common/src/main/java/org/onap/so/rest/service/HttpRestServiceProviderImpl.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.onap.so.configuration.rest.HttpHeadersProvider;
  24 import org.onap.so.rest.exceptions.HttpResouceNotFoundException;
  25 import org.onap.so.rest.exceptions.InvalidRestRequestException;
  26 import org.onap.so.rest.exceptions.RestProcessingException;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29 import org.springframework.http.HttpEntity;
  30 import org.springframework.http.HttpHeaders;
  31 import org.springframework.http.HttpMethod;
  32 import org.springframework.http.HttpStatus;
  33 import org.springframework.http.ResponseEntity;
  34 import org.springframework.web.client.HttpStatusCodeException;
  35 import org.springframework.web.client.RestClientException;
  36 import org.springframework.web.client.RestTemplate;
  37 import com.google.common.base.Optional;
  38
  39 /**
  40  * A Service to perform HTTP requests
  41  *
  42  * @author waqas.ikram@est.tech
  43  */
  44 public class HttpRestServiceProviderImpl implements HttpRestServiceProvider {
  45
  46     private static final Logger LOGGER = LoggerFactory.getLogger(HttpRestServiceProviderImpl.class);
  47     private final RestTemplate restTemplate;
  48     private final HttpHeaders defaultHttpHeaders;
  49
  50     public HttpRestServiceProviderImpl(final RestTemplate restTemplate) {
  51         this.restTemplate = restTemplate;
  52         this.defaultHttpHeaders = new HttpHeaders();
  53     }
  54
  55     public HttpRestServiceProviderImpl(final RestTemplate restTemplate, final HttpHeaders defaultHttpHeaders) {
  56         this.restTemplate = restTemplate;
  57         this.defaultHttpHeaders = defaultHttpHeaders;
  58     }
  59
  60     /**
  61      *
  62      * @deprecated this constructor is deprecated in favor of using {@link HttpRestServiceProviderImpl(RestTemplate
  63      *             restTemplate, HttpHeaders defaultHttpHeaders)}
  64      */
  65     @Deprecated
  66     public HttpRestServiceProviderImpl(final RestTemplate restTemplate, final HttpHeadersProvider httpHeadersProvider) {
  67         this.restTemplate = restTemplate;
  68         this.defaultHttpHeaders = httpHeadersProvider.getHttpHeaders();
  69     }
  70
  71     @Override
  72     public <T> Optional<T> get(final String url, final Class<T> clazz) {
  73         final ResponseEntity<T> response = getHttpResponse(url, clazz);
  74         return createOptional(response, url, HttpMethod.GET);
  75     }
  76
  77     @Override
  78     public <T> Optional<T> get(final String url, final HttpHeaders headers, final Class<T> clazz) {
  79         final ResponseEntity<T> response = invokeHttpRequest(new HttpEntity<>(headers), HttpMethod.GET, url, clazz);
  80         return createOptional(response, url, HttpMethod.GET);
  81     }
  82
  83     @Override
  84     public <T> ResponseEntity<T> getHttpResponse(final String url, final Class<T> clazz) {
  85         final HttpEntity<?> request = new HttpEntity<>(getDefaultHttpHeaders());
  86         return invokeHttpRequest(request, HttpMethod.GET, url, clazz);
  87     }
  88
  89     @Override
  90     public <T> ResponseEntity<T> getHttpResponse(final String url, final HttpHeaders headers, final Class<T> clazz) {
  91         final HttpEntity<?> request = new HttpEntity<>(headers);
  92         return invokeHttpRequest(request, HttpMethod.GET, url, clazz);
  93     }
  94
  95     @Override
  96     public <T> Optional<T> post(final Object object, final String url, final Class<T> clazz) {
  97         final ResponseEntity<T> response = postHttpRequest(object, url, clazz);
  98         return createOptional(response, url, HttpMethod.POST);
  99     }
 100
 101     @Override
 102     public <T> ResponseEntity<T> postHttpRequest(final Object object, final String url, final Class<T> clazz) {
 103         final HttpEntity<?> request = new HttpEntity<>(object, getDefaultHttpHeaders());
 104         return invokeHttpRequest(request, HttpMethod.POST, url, clazz);
 105     }
 106
 107     @Override
 108     public <T> ResponseEntity<T> postHttpRequest(final Object object, final String url, final HttpHeaders headers,
 109             final Class<T> clazz) {
 110         final HttpEntity<?> request = new HttpEntity<>(object, headers);
 111         return invokeHttpRequest(request, HttpMethod.POST, url, clazz);
 112     }
 113
 114     @Override
 115     public <T> Optional<T> put(final Object object, final String url, final Class<T> clazz) {
 116         final ResponseEntity<T> response = putHttpRequest(object, url, clazz);
 117         return createOptional(response, url, HttpMethod.PUT);
 118     }
 119
 120     @Override
 121     public <T> ResponseEntity<T> putHttpRequest(final Object object, final String url, final Class<T> clazz) {
 122         final HttpEntity<?> request = new HttpEntity<>(object, getDefaultHttpHeaders());
 123         return invokeHttpRequest(request, HttpMethod.PUT, url, clazz);
 124     }
 125
 126     private <T> Optional<T> createOptional(final ResponseEntity<T> response, final String url,
 127             final HttpMethod httpMethod) {
 128         if (!response.getStatusCode().equals(HttpStatus.OK) && !response.getStatusCode().equals(HttpStatus.CREATED)) {
 129             final String message = "Unable to invoke HTTP " + httpMethod + " using URL: " + url + ", Response Code: "
 130                     + response.getStatusCode();
 131             LOGGER.error(message);
 132             return Optional.absent();
 133         }
 134
 135         if (response.hasBody()) {
 136             return Optional.of(response.getBody());
 137         }
 138
 139         return Optional.absent();
 140     }
 141
 142     private <T> ResponseEntity<T> invokeHttpRequest(final HttpEntity<?> request, final HttpMethod httpMethod,
 143             final String url, final Class<T> clazz) {
 144         LOGGER.trace("Will invoke HTTP {} using URL: {}", httpMethod, url);
 145         try {
 146             return restTemplate.exchange(url, httpMethod, request, clazz);
 147
 148         } catch (final HttpStatusCodeException httpStatusCodeException) {
 149             final String message = "Unable to invoke HTTP " + httpMethod + " using url: " + url + ", Response: "
 150                     + httpStatusCodeException.getRawStatusCode();
 151             LOGGER.error(message, httpStatusCodeException);
 152             final int rawStatusCode = httpStatusCodeException.getRawStatusCode();
 153             if (rawStatusCode == HttpStatus.BAD_REQUEST.value()) {
 154                 throw new InvalidRestRequestException("No result found for given url: " + url);
 155             } else if (rawStatusCode == HttpStatus.NOT_FOUND.value()) {
 156                 throw new HttpResouceNotFoundException("No result found for given url: " + url);
 157             }
 158             throw new RestProcessingException("Unable to invoke HTTP " + httpMethod + " using URL: " + url,
 159                     httpStatusCodeException, rawStatusCode);
 160
 161         } catch (final RestClientException restClientException) {
 162             LOGGER.error("Unable to invoke HTTP POST using url: {}", url, restClientException);
 163             throw new RestProcessingException("Unable to invoke HTTP " + httpMethod + " using URL: " + url,
 164                     restClientException);
 165         }
 166     }
 167
 168     @Override
 169     public <T> ResponseEntity<T> deleteHttpRequest(final String url, final Class<T> clazz) {
 170         try {
 171             final HttpEntity<?> request = new HttpEntity<>(getDefaultHttpHeaders());
 172             return restTemplate.exchange(url, HttpMethod.DELETE, request, clazz);
 173
 174         } catch (final HttpStatusCodeException httpStatusCodeException) {
 175             final String message = "Unable to invoke HTTP " + HttpMethod.DELETE + " using url: " + url + ", Response: "
 176                     + httpStatusCodeException.getRawStatusCode();
 177             LOGGER.error(message, httpStatusCodeException);
 178             final int rawStatusCode = httpStatusCodeException.getRawStatusCode();
 179             if (rawStatusCode == HttpStatus.BAD_REQUEST.value()) {
 180                 throw new InvalidRestRequestException("No result found for given url: " + url);
 181             } else if (rawStatusCode == HttpStatus.NOT_FOUND.value()) {
 182                 throw new HttpResouceNotFoundException("No result found for given url: " + url);
 183             }
 184             throw new RestProcessingException("Unable to invoke HTTP " + HttpMethod.DELETE + " using URL: " + url,
 185                     httpStatusCodeException, rawStatusCode);
 186         } catch (final RestClientException restClientException) {
 187             LOGGER.error("Unable to invoke HTTP DELETE using url: " + url, restClientException);
 188             throw new InvalidRestRequestException("Unable to invoke HTTP DELETE using URL: " + url,
 189                     restClientException);
 190         }
 191     }
 192
 193     private HttpHeaders getDefaultHttpHeaders() {
 194         return defaultHttpHeaders;
 195     }
 196 }