3 * ============LICENSE_START==========================================
4 * ===================================================================
5 * Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
6 * ===================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END============================================
20 * ECOMP and OpenECOMP are trademarks
21 * and service marks of AT&T Intellectual Property.
25 package com.woorea.openstack.connector;
27 import java.io.IOException;
29 import java.net.URISyntaxException;
30 import java.net.UnknownHostException;
31 import java.util.List;
33 import java.util.Map.Entry;
35 import org.apache.http.HttpEntity;
36 import org.apache.http.HttpStatus;
37 import org.apache.http.client.HttpResponseException;
38 import org.apache.http.client.methods.CloseableHttpResponse;
39 import org.apache.http.client.methods.HttpDelete;
40 import org.apache.http.client.methods.HttpGet;
41 import org.apache.http.client.methods.HttpPost;
42 import org.apache.http.client.methods.HttpPut;
43 import org.apache.http.client.methods.HttpUriRequest;
44 import org.apache.http.client.utils.URIBuilder;
45 import org.apache.http.entity.ContentType;
46 import org.apache.http.entity.StringEntity;
47 import org.apache.http.impl.client.CloseableHttpClient;
48 import org.apache.http.impl.client.HttpClients;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
52 import com.fasterxml.jackson.annotation.JsonInclude.Include;
53 import com.fasterxml.jackson.annotation.JsonRootName;
54 import com.fasterxml.jackson.core.JsonProcessingException;
55 import com.fasterxml.jackson.databind.DeserializationFeature;
56 import com.fasterxml.jackson.databind.ObjectMapper;
57 import com.fasterxml.jackson.databind.SerializationFeature;
58 import com.woorea.openstack.base.client.OpenStackClientConnector;
59 import com.woorea.openstack.base.client.OpenStackConnectException;
60 import com.woorea.openstack.base.client.OpenStackRequest;
61 import com.woorea.openstack.base.client.OpenStackResponse;
62 import com.woorea.openstack.base.client.OpenStackResponseException;
64 public class HttpClientConnector implements OpenStackClientConnector {
66 public static ObjectMapper DEFAULT_MAPPER;
67 public static ObjectMapper WRAPPED_MAPPER;
69 private static Logger LOGGER = LoggerFactory.getLogger(HttpClientConnector.class);
72 DEFAULT_MAPPER = new ObjectMapper();
74 DEFAULT_MAPPER.setSerializationInclusion(Include.NON_NULL);
75 DEFAULT_MAPPER.disable(SerializationFeature.INDENT_OUTPUT);
76 DEFAULT_MAPPER.enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY);
77 DEFAULT_MAPPER.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
79 WRAPPED_MAPPER = new ObjectMapper();
81 WRAPPED_MAPPER.setSerializationInclusion(Include.NON_NULL);
82 WRAPPED_MAPPER.disable(SerializationFeature.INDENT_OUTPUT);
83 WRAPPED_MAPPER.enable(SerializationFeature.WRAP_ROOT_VALUE);
84 WRAPPED_MAPPER.enable(DeserializationFeature.UNWRAP_ROOT_VALUE);
85 WRAPPED_MAPPER.enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY);
86 WRAPPED_MAPPER.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
89 protected static <T> ObjectMapper getObjectMapper (Class<T> type) {
90 return type.getAnnotation(JsonRootName.class) == null ? DEFAULT_MAPPER : WRAPPED_MAPPER;
94 public <T> OpenStackResponse request(OpenStackRequest<T> request) {
96 CloseableHttpClient httpClient = null; //HttpClients.createDefault();
97 httpClient = HttpClients.custom().setRedirectStrategy(new HttpClientRedirectStrategy()).build();
101 // Build the URI with query params
103 URIBuilder uriBuilder = new URIBuilder(request.endpoint() + request.path());
105 for(Map.Entry<String, List<Object> > entry : request.queryParams().entrySet()) {
106 for (Object o : entry.getValue()) {
107 uriBuilder.setParameter(entry.getKey(), String.valueOf(o));
111 uri = uriBuilder.build();
112 } catch (URISyntaxException e) {
113 throw new HttpClientException (e);
116 HttpEntity entity = null;
117 if (request.entity() != null) {
118 // Flatten the entity to a Json string
121 // Get appropriate mapper, based on existence of a root element in Entity class
122 ObjectMapper mapper = getObjectMapper (request.entity().getEntity().getClass());
124 String entityJson = mapper.writeValueAsString (request.entity().getEntity());
125 entity = new StringEntity(entityJson, ContentType.create(request.entity().getContentType()));
127 LOGGER.debug ("Request JSON Body: " + entityJson.replaceAll("\"password\":\"[^\"]*\"", "\"password\":\"***\""));
129 } catch (JsonProcessingException e) {
130 throw new HttpClientException ("Json processing error on request entity", e);
131 } catch (IOException e) {
132 throw new HttpClientException ("Json IO error on request entity", e);
136 // Determine the HttpRequest class based on the method
137 HttpUriRequest httpRequest;
139 switch (request.method()) {
141 HttpPost post = new HttpPost(uri);
142 post.setEntity (entity);
147 httpRequest = new HttpGet(uri);
151 HttpPut put = new HttpPut(uri);
152 put.setEntity (entity);
157 httpRequest = new HttpDelete(uri);
161 throw new HttpClientException ("Unrecognized HTTP Method: " + request.method());
164 for (Entry<String, List<Object>> h : request.headers().entrySet()) {
165 StringBuilder sb = new StringBuilder();
166 for (Object v : h.getValue()) {
167 sb.append(String.valueOf(v));
169 httpRequest.addHeader(h.getKey(), sb.toString());
172 LOGGER.debug ("Sending HTTP request: " + httpRequest.toString());
174 // Get the Response. But don't get the body entity yet, as this response
175 // will be wrapped in an HttpClientResponse. The HttpClientResponse
176 // buffers the body in constructor, so can close the response here.
177 HttpClientResponse httpClientResponse = null;
178 CloseableHttpResponse httpResponse = null;
180 // Catch known HttpClient exceptions, and wrap them in OpenStack Client Exceptions
181 // so calling functions can distinguish. Only RuntimeExceptions are allowed.
183 httpResponse = httpClient.execute(httpRequest);
185 LOGGER.debug ("Response status: " + httpResponse.getStatusLine().getStatusCode());
187 httpClientResponse = new HttpClientResponse (httpResponse);
189 int status = httpResponse.getStatusLine().getStatusCode();
190 if (status == HttpStatus.SC_OK || status == HttpStatus.SC_CREATED ||
191 status == HttpStatus.SC_NO_CONTENT || status == HttpStatus.SC_ACCEPTED)
193 return httpClientResponse;
196 catch (HttpResponseException e) {
197 // What exactly does this mean? It does not appear to get thrown for
198 // non-2XX responses as documented.
199 throw new OpenStackResponseException(e.getMessage(), e.getStatusCode());
201 catch (UnknownHostException e) {
202 throw new OpenStackConnectException("Unknown Host: " + e.getMessage());
204 catch (IOException e) {
205 // Catch all other IOExceptions and throw as OpenStackConnectException
206 throw new OpenStackConnectException(e.getMessage());
208 catch (Exception e) {
209 // Catchall for anything else, must throw as a RuntimeException
210 LOGGER.error ("Unexpected client exception: " +e.getMessage());
211 throw new RuntimeException("Unexpected client exception", e);
214 // Have the body. Close the stream
215 if (httpResponse != null)
217 httpResponse.close();
218 } catch (IOException e) {
219 LOGGER.warn("Unable to close HTTP Response: " + e);
223 // Get here on an error response (4XX-5XX)
224 throw new OpenStackResponseException(httpResponse.getStatusLine().getReasonPhrase(),
225 httpResponse.getStatusLine().getStatusCode(),