SimpleHttp.java
/*
* Copyright 2016 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* 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.
*/
package org.keycloak.broker.provider.util;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.http.Header;
import org.apache.http.HeaderIterator;
import org.apache.http.HttpEntity;
import org.apache.http.HttpHeaders;
import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.client.HttpClient;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpHead;
import org.apache.http.client.methods.HttpPatch;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.message.BasicNameValuePair;
import org.keycloak.common.util.Base64;
import org.keycloak.connections.httpclient.HttpClientProvider;
import org.keycloak.models.KeycloakSession;
import org.keycloak.util.JsonSerialization;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringWriter;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.zip.GZIPInputStream;
/**
* @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
* @author Vlastimil Elias (velias at redhat dot com)
* @author David Klassen (daviddd.kl@gmail.com)
*/
public class SimpleHttp {
private static final ObjectMapper mapper = new ObjectMapper();
private static final int UNDEFINED_TIMEOUT = -1;
private final HttpClient client;
private final String url;
private final String method;
private Map<String, String> headers;
private Map<String, String> params;
private Object entity;
private int socketTimeOutMillis = UNDEFINED_TIMEOUT;
private int connectTimeoutMillis = UNDEFINED_TIMEOUT;
private int connectionRequestTimeoutMillis = UNDEFINED_TIMEOUT;
private RequestConfig.Builder requestConfigBuilder;
protected SimpleHttp(String url, String method, HttpClient client) {
this.client = client;
this.url = url;
this.method = method;
}
public static SimpleHttp doDelete(String url, KeycloakSession session) {
return doDelete(url, session.getProvider(HttpClientProvider.class).getHttpClient());
}
public static SimpleHttp doDelete(String url, HttpClient client) {
return new SimpleHttp(url, "DELETE", client);
}
public static SimpleHttp doGet(String url, KeycloakSession session) {
return doGet(url, session.getProvider(HttpClientProvider.class).getHttpClient());
}
public static SimpleHttp doGet(String url, HttpClient client) {
return new SimpleHttp(url, "GET", client);
}
public static SimpleHttp doPost(String url, KeycloakSession session) {
return doPost(url, session.getProvider(HttpClientProvider.class).getHttpClient());
}
public static SimpleHttp doPost(String url, HttpClient client) {
return new SimpleHttp(url, "POST", client);
}
public static SimpleHttp doPut(String url, HttpClient client) {
return new SimpleHttp(url, "PUT", client);
}
public static SimpleHttp doHead(String url, HttpClient client) {
return new SimpleHttp(url, "HEAD", client);
}
public static SimpleHttp doPatch(String url, HttpClient client) {
return new SimpleHttp(url, "PATCH", client);
}
public SimpleHttp header(String name, String value) {
if (headers == null) {
headers = new HashMap<>();
}
headers.put(name, value);
return this;
}
public String getHeader(String name) {
if (headers != null) {
return headers.get(name);
}
return null;
}
public SimpleHttp json(Object entity) {
this.entity = entity;
return this;
}
public SimpleHttp entity(HttpEntity entity) {
this.entity = entity;
return this;
}
public SimpleHttp param(String name, String value) {
if (params == null) {
params = new HashMap<>();
}
params.put(name, value);
return this;
}
public SimpleHttp socketTimeOutMillis(int timeout) {
this.socketTimeOutMillis = timeout;
return this;
}
public SimpleHttp connectTimeoutMillis(int timeout) {
this.connectTimeoutMillis = timeout;
return this;
}
public SimpleHttp connectionRequestTimeoutMillis(int timeout) {
this.connectionRequestTimeoutMillis = timeout;
return this;
}
public SimpleHttp auth(String token) {
header("Authorization", "Bearer " + token);
return this;
}
public SimpleHttp authBasic(final String username, final String password) {
final String basicCredentials = String.format("%s:%s", username, password);
header("Authorization", "Basic " + Base64.encodeBytes(basicCredentials.getBytes()));
return this;
}
public SimpleHttp acceptJson() {
if (headers == null || !headers.containsKey("Accept")) {
header("Accept", "application/json");
}
return this;
}
public JsonNode asJson() throws IOException {
if (headers == null || !headers.containsKey("Accept")) {
header("Accept", "application/json");
}
return mapper.readTree(asString());
}
public <T> T asJson(Class<T> type) throws IOException {
if (headers == null || !headers.containsKey("Accept")) {
header("Accept", "application/json");
}
return JsonSerialization.readValue(asString(), type);
}
public <T> T asJson(TypeReference<T> type) throws IOException {
if (headers == null || !headers.containsKey("Accept")) {
header("Accept", "application/json");
}
return JsonSerialization.readValue(asString(), type);
}
public String asString() throws IOException {
return asResponse().asString();
}
public int asStatus() throws IOException {
return asResponse().getStatus();
}
public Response asResponse() throws IOException {
return makeRequest();
}
private HttpRequestBase createHttpRequest() {
switch(method) {
case "GET":
return new HttpGet(appendParameterToUrl(url));
case "DELETE":
return new HttpDelete(appendParameterToUrl(url));
case "HEAD":
return new HttpHead(appendParameterToUrl(url));
case "PUT":
return new HttpPut(appendParameterToUrl(url));
case "PATCH":
return new HttpPatch(appendParameterToUrl(url));
case "POST":
// explicit fall through as we want POST to be the default HTTP method
default:
return new HttpPost(url);
}
}
private Response makeRequest() throws IOException {
HttpRequestBase httpRequest = createHttpRequest();
if (httpRequest instanceof HttpPost || httpRequest instanceof HttpPut || httpRequest instanceof HttpPatch) {
if (params != null) {
((HttpEntityEnclosingRequestBase) httpRequest).setEntity(getFormEntityFromParameter());
} else if (entity instanceof HttpEntity) {
((HttpEntityEnclosingRequestBase) httpRequest).setEntity((HttpEntity) entity);
} else if (entity != null) {
if (headers == null || !headers.containsKey(HttpHeaders.CONTENT_TYPE)) {
header(HttpHeaders.CONTENT_TYPE, "application/json");
}
((HttpEntityEnclosingRequestBase) httpRequest).setEntity(getJsonEntity());
} else {
throw new IllegalStateException("No content set");
}
}
if (headers != null) {
for (Map.Entry<String, String> h : headers.entrySet()) {
httpRequest.setHeader(h.getKey(), h.getValue());
}
}
if (socketTimeOutMillis != UNDEFINED_TIMEOUT) {
requestConfigBuilder().setSocketTimeout(socketTimeOutMillis);
}
if (connectTimeoutMillis != UNDEFINED_TIMEOUT) {
requestConfigBuilder().setConnectTimeout(connectTimeoutMillis);
}
if (connectionRequestTimeoutMillis != UNDEFINED_TIMEOUT) {
requestConfigBuilder().setConnectionRequestTimeout(connectionRequestTimeoutMillis);
}
if (requestConfigBuilder != null) {
httpRequest.setConfig(requestConfigBuilder.build());
}
return new Response(client.execute(httpRequest));
}
private RequestConfig.Builder requestConfigBuilder() {
if (requestConfigBuilder == null) {
requestConfigBuilder = RequestConfig.custom();
}
return requestConfigBuilder;
}
private URI appendParameterToUrl(String url) {
try {
URIBuilder uriBuilder = new URIBuilder(url);
if (params != null) {
for (Map.Entry<String, String> p : params.entrySet()) {
uriBuilder.setParameter(p.getKey(), p.getValue());
}
}
return uriBuilder.build();
} catch (URISyntaxException ignored) {
return null;
}
}
private StringEntity getJsonEntity() throws IOException {
return new StringEntity(JsonSerialization.writeValueAsString(entity), ContentType.getByMimeType(headers.get(HttpHeaders.CONTENT_TYPE)));
}
private UrlEncodedFormEntity getFormEntityFromParameter() throws IOException{
List<NameValuePair> urlParameters = new ArrayList<>();
if (params != null) {
for (Map.Entry<String, String> p : params.entrySet()) {
urlParameters. add(new BasicNameValuePair(p.getKey(), p.getValue()));
}
}
return new UrlEncodedFormEntity(urlParameters, StandardCharsets.UTF_8);
}
public static class Response implements AutoCloseable {
private final HttpResponse response;
private int statusCode = -1;
private String responseString;
private ContentType contentType;
public Response(HttpResponse response) {
this.response = response;
}
private void readResponse() throws IOException {
if (statusCode == -1) {
statusCode = response.getStatusLine().getStatusCode();
InputStream is;
HttpEntity entity = response.getEntity();
if (entity != null) {
is = entity.getContent();
contentType = ContentType.getOrDefault(entity);
Charset charset = contentType.getCharset();
try {
HeaderIterator it = response.headerIterator();
while (it.hasNext()) {
Header header = it.nextHeader();
if (header.getName().equals("Content-Encoding") && header.getValue().equals("gzip")) {
is = new GZIPInputStream(is);
}
}
try (InputStreamReader reader = charset == null ? new InputStreamReader(is, StandardCharsets.UTF_8) :
new InputStreamReader(is, charset)) {
StringWriter writer = new StringWriter();
char[] buffer = new char[1024 * 4];
for (int n = reader.read(buffer); n != -1; n = reader.read(buffer)) {
writer.write(buffer, 0, n);
}
responseString = writer.toString();
}
} finally {
if (is != null) {
is.close();
}
}
}
}
}
public int getStatus() throws IOException {
readResponse();
return response.getStatusLine().getStatusCode();
}
public JsonNode asJson() throws IOException {
return mapper.readTree(asString());
}
public <T> T asJson(Class<T> type) throws IOException {
return JsonSerialization.readValue(asString(), type);
}
public <T> T asJson(TypeReference<T> type) throws IOException {
return JsonSerialization.readValue(asString(), type);
}
public String asString() throws IOException {
readResponse();
return responseString;
}
public String getFirstHeader(String name) throws IOException {
readResponse();
Header[] headers = response.getHeaders(name);
if (headers != null && headers.length > 0) {
return headers[0].getValue();
}
return null;
}
public List<String> getHeader(String name) throws IOException {
readResponse();
Header[] headers = response.getHeaders(name);
if (headers != null && headers.length > 0) {
return Stream.of(headers).map(Header::getValue).collect(Collectors.toList());
}
return null;
}
public Header[] getAllHeaders() throws IOException {
readResponse();
return response.getAllHeaders();
}
public ContentType getContentType() throws IOException {
readResponse();
return contentType;
}
public Charset getContentTypeCharset() throws IOException {
readResponse();
if (contentType != null) {
Charset charset = contentType.getCharset();
if (charset != null) {
return charset;
}
}
return StandardCharsets.UTF_8;
}
public void close() throws IOException {
readResponse();
}
}
}