aboutsummaryrefslogtreecommitdiffstats
path: root/common/src/main/java/org/onap/so/rest/service/HttpRestServiceProviderImpl.java
blob: 04dd0bbb7afab483371c36aa8378bcd4c14ae22a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 Nordix Foundation.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.so.rest.service;

import org.onap.so.configuration.rest.HttpHeadersProvider;
import org.onap.so.rest.exceptions.HttpResouceNotFoundException;
import org.onap.so.rest.exceptions.InvalidRestRequestException;
import org.onap.so.rest.exceptions.RestProcessingException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.HttpStatusCodeException;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestTemplate;
import com.google.common.base.Optional;

/**
 * A Service to perform HTTP requests
 *
 * @author waqas.ikram@est.tech
 */
public class HttpRestServiceProviderImpl implements HttpRestServiceProvider {

    private static final Logger LOGGER = LoggerFactory.getLogger(HttpRestServiceProviderImpl.class);
    private final RestTemplate restTemplate;
    private final HttpHeaders defaultHttpHeaders;

    public HttpRestServiceProviderImpl(final RestTemplate restTemplate) {
        this.restTemplate = restTemplate;
        this.defaultHttpHeaders = new HttpHeaders();
    }

    public HttpRestServiceProviderImpl(final RestTemplate restTemplate, final HttpHeaders defaultHttpHeaders) {
        this.restTemplate = restTemplate;
        this.defaultHttpHeaders = defaultHttpHeaders;
    }

    /**
     * 
     * @deprecated this constructor is deprecated in favor of using {@link HttpRestServiceProviderImpl(RestTemplate
     *             restTemplate, HttpHeaders defaultHttpHeaders)}
     */
    @Deprecated
    public HttpRestServiceProviderImpl(final RestTemplate restTemplate, final HttpHeadersProvider httpHeadersProvider) {
        this.restTemplate = restTemplate;
        this.defaultHttpHeaders = httpHeadersProvider.getHttpHeaders();
    }

    @Override
    public <T> Optional<T> get(final String url, final Class<T> clazz) {
        final ResponseEntity<T> response = getHttpResponse(url, clazz);
        return createOptional(response, url, HttpMethod.GET);
    }

    @Override
    public <T> Optional<T> get(final String url, final HttpHeaders headers, final Class<T> clazz) {
        final ResponseEntity<T> response = invokeHttpRequest(new HttpEntity<>(headers), HttpMethod.GET, url, clazz);
        return createOptional(response, url, HttpMethod.GET);
    }

    @Override
    public <T> ResponseEntity<T> getHttpResponse(final String url, final Class<T> clazz) {
        final HttpEntity<?> request = new HttpEntity<>(getDefaultHttpHeaders());
        return invokeHttpRequest(request, HttpMethod.GET, url, clazz);
    }

    @Override
    public <T> ResponseEntity<T> getHttpResponse(final String url, final HttpHeaders headers, final Class<T> clazz) {
        final HttpEntity<?> request = new HttpEntity<>(headers);
        return invokeHttpRequest(request, HttpMethod.GET, url, clazz);
    }

    @Override
    public <T> Optional<T> post(final Object object, final String url, final Class<T> clazz) {
        final ResponseEntity<T> response = postHttpRequest(object, url, clazz);
        return createOptional(response, url, HttpMethod.POST);
    }

    @Override
    public <T> ResponseEntity<T> postHttpRequest(final Object object, final String url, final Class<T> clazz) {
        final HttpEntity<?> request = new HttpEntity<>(object, getDefaultHttpHeaders());
        return invokeHttpRequest(request, HttpMethod.POST, url, clazz);
    }

    @Override
    public <T> ResponseEntity<T> postHttpRequest(final Object object, final String url, final HttpHeaders headers,
            final Class<T> clazz) {
        final HttpEntity<?> request = new HttpEntity<>(object, headers);
        return invokeHttpRequest(request, HttpMethod.POST, url, clazz);
    }

    @Override
    public <T> Optional<T> put(final Object object, final String url, final Class<T> clazz) {
        final ResponseEntity<T> response = putHttpRequest(object, url, clazz);
        return createOptional(response, url, HttpMethod.PUT);
    }

    @Override
    public <T> ResponseEntity<T> putHttpRequest(final Object object, final String url, final Class<T> clazz) {
        final HttpEntity<?> request = new HttpEntity<>(object, getDefaultHttpHeaders());
        return invokeHttpRequest(request, HttpMethod.PUT, url, clazz);
    }

    private <T> Optional<T> createOptional(final ResponseEntity<T> response, final String url,
            final HttpMethod httpMethod) {
        if (!response.getStatusCode().equals(HttpStatus.OK) && !response.getStatusCode().equals(HttpStatus.CREATED)) {
            final String message = "Unable to invoke HTTP " + httpMethod + " using URL: " + url + ", Response Code: "
                    + response.getStatusCode();
            LOGGER.error(message);
            return Optional.absent();
        }

        if (response.hasBody()) {
            return Optional.of(response.getBody());
        }

        return Optional.absent();
    }

    private <T> ResponseEntity<T> invokeHttpRequest(final HttpEntity<?> request, final HttpMethod httpMethod,
            final String url, final Class<T> clazz) {
        LOGGER.trace("Will invoke HTTP {} using URL: {}", httpMethod, url);
        try {
            return restTemplate.exchange(url, httpMethod, request, clazz);

        } catch (final HttpStatusCodeException httpStatusCodeException) {
            final String message = "Unable to invoke HTTP " + httpMethod + " using url: " + url + ", Response: "
                    + httpStatusCodeException.getRawStatusCode();
            LOGGER.error(message, httpStatusCodeException);
            final int rawStatusCode = httpStatusCodeException.getRawStatusCode();
            if (rawStatusCode == HttpStatus.BAD_REQUEST.value()) {
                throw new InvalidRestRequestException("No result found for given url: " + url);
            } else if (rawStatusCode == HttpStatus.NOT_FOUND.value()) {
                throw new HttpResouceNotFoundException("No result found for given url: " + url);
            }
            throw new RestProcessingException("Unable to invoke HTTP " + httpMethod + " using URL: " + url,
                    httpStatusCodeException, rawStatusCode);

        } catch (final RestClientException restClientException) {
            LOGGER.error("Unable to invoke HTTP POST using url: {}", url, restClientException);
            throw new RestProcessingException("Unable to invoke HTTP " + httpMethod + " using URL: " + url,
                    restClientException);
        }
    }

    @Override
    public <T> ResponseEntity<T> deleteHttpRequest(final String url, final Class<T> clazz) {
        try {
            final HttpEntity<?> request = new HttpEntity<>(getDefaultHttpHeaders());
            return restTemplate.exchange(url, HttpMethod.DELETE, request, clazz);

        } catch (final HttpStatusCodeException httpStatusCodeException) {
            final String message = "Unable to invoke HTTP " + HttpMethod.DELETE + " using url: " + url + ", Response: "
                    + httpStatusCodeException.getRawStatusCode();
            LOGGER.error(message, httpStatusCodeException);
            final int rawStatusCode = httpStatusCodeException.getRawStatusCode();
            if (rawStatusCode == HttpStatus.BAD_REQUEST.value()) {
                throw new InvalidRestRequestException("No result found for given url: " + url);
            } else if (rawStatusCode == HttpStatus.NOT_FOUND.value()) {
                throw new HttpResouceNotFoundException("No result found for given url: " + url);
            }
            throw new RestProcessingException("Unable to invoke HTTP " + HttpMethod.DELETE + " using URL: " + url,
                    httpStatusCodeException, rawStatusCode);
        } catch (final RestClientException restClientException) {
            LOGGER.error("Unable to invoke HTTP DELETE using url: " + url, restClientException);
            throw new InvalidRestRequestException("Unable to invoke HTTP DELETE using URL: " + url,
                    restClientException);
        }
    }

    private HttpHeaders getDefaultHttpHeaders() {
        return defaultHttpHeaders;
    }
}