io.neow3j.protocol.http.HttpService Maven / Gradle / Ivy
Show all versions of core Show documentation
package io.neow3j.protocol.http;
import io.neow3j.protocol.Service;
import io.neow3j.protocol.core.Request;
import io.neow3j.protocol.core.Response;
import io.neow3j.protocol.exceptions.ClientConnectionException;
import io.neow3j.utils.Async;
import okhttp3.Headers;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.RequestBody;
import okhttp3.ResponseBody;
import okhttp3.logging.HttpLoggingInterceptor;
import okio.Buffer;
import okio.BufferedSource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ExecutorService;
/**
* HTTP implementation of the Service API.
*/
public class HttpService extends Service {
public static final MediaType JSON_MEDIA_TYPE = MediaType.parse("application/json; charset=utf-8");
public static final String DEFAULT_URL = "http://localhost:10333/";
private static final Logger log = LoggerFactory.getLogger(HttpService.class);
private final String url;
private final boolean includeRawResponses;
private OkHttpClient httpClient;
private HashMap headers = new HashMap<>();
/**
* Create an {@link HttpService} instance.
*
* @param url the URL to the HTTP service (JSON-RPC).
* @param httpClient the HTTP client instance.
* @param executorService an external ExecutorService where asynchronous {@link Request} calls should run.
* @param includeRawResponses option to include or not raw responses on the {@link Response} object.
*/
public HttpService(String url, OkHttpClient httpClient,
ExecutorService executorService,
boolean includeRawResponses) {
super(executorService, includeRawResponses);
this.url = url;
this.httpClient = httpClient;
this.includeRawResponses = includeRawResponses;
}
/**
* Create an {@link HttpService} instance.
*
* An internal {@link ExecutorService} is used to run asynchronous {@link Request} calls,
* defined by {@link Async#defaultExecutorService()}.
*
* @param url the URL to the HTTP service (JSON-RPC).
* @param httpClient the HTTP client instance.
* @param includeRawResponses option to include or not raw responses on the {@link Response} object.
*/
public HttpService(String url, OkHttpClient httpClient, boolean includeRawResponses) {
this(url, httpClient, null, includeRawResponses);
}
/**
* Create an {@link HttpService} instance.
*
* The URL is set to {@link HttpService#DEFAULT_URL}.
*
* @param httpClient the HTTP client instance.
* @param executorService an external ExecutorService where asynchronous {@link Request} calls should run.
* @param includeRawResponses option to include or not raw responses on the {@link Response} object.
*/
public HttpService(OkHttpClient httpClient, ExecutorService executorService, boolean includeRawResponses) {
this(DEFAULT_URL, httpClient, executorService, includeRawResponses);
}
/**
* Create an {@link HttpService} instance.
*
* The URL is set to {@link HttpService#DEFAULT_URL}.
*
* An internal {@link ExecutorService} is used to run asynchronous {@link Request} calls,
* defined by {@link Async#defaultExecutorService()}.
*
* @param httpClient the HTTP client instance.
* @param includeRawResponses option to include or not raw responses on the {@link Response} object.
*/
public HttpService(OkHttpClient httpClient, boolean includeRawResponses) {
this(DEFAULT_URL, httpClient, includeRawResponses);
}
/**
* Create an {@link HttpService} instance.
*
* The {@link #includeRawResponses} is set to false.
*
* @param url the URL to the HTTP service (JSON-RPC).
* @param httpClient the HTTP client instance.
* @param executorService an external ExecutorService where asynchronous {@link Request} calls should run.
*/
public HttpService(String url, OkHttpClient httpClient, ExecutorService executorService) {
this(url, httpClient, executorService, false);
}
/**
* Create an {@link HttpService} instance.
*
* An internal {@link ExecutorService} is used to run asynchronous {@link Request} calls,
* defined by {@link Async#defaultExecutorService()}.
*
* The {@link #includeRawResponses} is set to false.
*
* @param url the URL to the HTTP service (JSON-RPC).
* @param httpClient the HTTP client instance.
*/
public HttpService(String url, OkHttpClient httpClient) {
this(url, httpClient, false);
}
/**
* Create an {@link HttpService} instance.
*
* The HTTP client used is set by default by {@link #createOkHttpClient()}.
*
* The {@link #includeRawResponses} is set to false.
*
* @param url the URL to the HTTP service (JSON-RPC).
* @param executorService an external ExecutorService where asynchronous {@link Request} calls should run.
*/
public HttpService(String url, ExecutorService executorService) {
this(url, createOkHttpClient(), executorService);
}
/**
* Create an {@link HttpService} instance.
*
* An internal {@link ExecutorService} is used to run asynchronous {@link Request} calls,
* defined by {@link Async#defaultExecutorService()}.
*
* The HTTP client used is set by default by {@link #createOkHttpClient()}.
*
* The {@link #includeRawResponses} is set to false.
*
* @param url the URL to the HTTP service (JSON-RPC).
*/
public HttpService(String url) {
this(url, createOkHttpClient());
}
/**
* Create an {@link HttpService} instance.
*
* The HTTP client used is set by default by {@link #createOkHttpClient()}.
*
* @param url the URL to the HTTP service (JSON-RPC).
* @param executorService an external ExecutorService where asynchronous {@link Request} calls should run.
* @param includeRawResponses option to include or not raw responses on the {@link Response} object.
*/
public HttpService(String url, ExecutorService executorService, boolean includeRawResponses) {
this(url, createOkHttpClient(), executorService, includeRawResponses);
}
/**
* Create an {@link HttpService} instance.
*
* An internal {@link ExecutorService} is used to run asynchronous {@link Request} calls,
* defined by {@link Async#defaultExecutorService()}.
*
* The HTTP client used is set by default by {@link #createOkHttpClient()}.
*
* @param url the URL to the HTTP service (JSON-RPC).
* @param includeRawResponses option to include or not raw responses on the {@link Response} object.
*/
public HttpService(String url, boolean includeRawResponses) {
this(url, createOkHttpClient(), includeRawResponses);
}
/**
* Create an {@link HttpService} instance.
*
* The URL is set to {@link HttpService#DEFAULT_URL}.
*
* The {@link #includeRawResponses} is set to false.
*
* @param httpClient the HTTP client instance.
* @param executorService an external ExecutorService where asynchronous {@link Request} calls should run.
*/
public HttpService(OkHttpClient httpClient, ExecutorService executorService) {
this(DEFAULT_URL, httpClient, executorService);
}
/**
* Create an {@link HttpService} instance.
*
* An internal {@link ExecutorService} is used to run asynchronous {@link Request} calls,
* defined by {@link Async#defaultExecutorService()}.
*
* The URL is set to {@link HttpService#DEFAULT_URL}.
*
* The {@link #includeRawResponses} is set to false.
*
* @param httpClient the HTTP client instance.
*/
public HttpService(OkHttpClient httpClient) {
this(DEFAULT_URL, httpClient);
}
/**
* Create an {@link HttpService} instance.
*
* The HTTP client used is set by default by {@link #createOkHttpClient()}.
*
* The URL is set to {@link HttpService#DEFAULT_URL}.
*
* @param executorService an external ExecutorService where asynchronous {@link Request} calls should run.
* @param includeRawResponses option to include or not raw responses on the {@link Response} object.
*/
public HttpService(ExecutorService executorService, boolean includeRawResponses) {
this(DEFAULT_URL, executorService, includeRawResponses);
}
/**
* Create an {@link HttpService} instance.
*
* An internal {@link ExecutorService} is used to run asynchronous {@link Request} calls,
* defined by {@link Async#defaultExecutorService()}.
*
* The HTTP client used is set by default by {@link #createOkHttpClient()}.
*
* The URL is set to {@link HttpService#DEFAULT_URL}.
*
* @param includeRawResponses option to include or not raw responses on the {@link Response} object.
*/
public HttpService(boolean includeRawResponses) {
this(DEFAULT_URL, includeRawResponses);
}
public HttpService() {
this(DEFAULT_URL);
}
private static OkHttpClient createOkHttpClient() {
OkHttpClient.Builder builder = new OkHttpClient.Builder();
configureLogging(builder);
return builder.build();
}
private static void configureLogging(OkHttpClient.Builder builder) {
if (log.isDebugEnabled()) {
HttpLoggingInterceptor logging = new HttpLoggingInterceptor(log::debug);
logging.setLevel(HttpLoggingInterceptor.Level.BODY);
builder.addInterceptor(logging);
}
}
@Override
protected InputStream performIO(String request) throws IOException {
RequestBody requestBody = RequestBody.create(JSON_MEDIA_TYPE, request);
Headers headers = buildHeaders();
okhttp3.Request httpRequest = new okhttp3.Request.Builder()
.url(url)
.headers(headers)
.post(requestBody)
.build();
okhttp3.Response response = httpClient.newCall(httpRequest).execute();
ResponseBody responseBody = response.body();
if (response.isSuccessful()) {
if (responseBody != null) {
return buildInputStream(responseBody);
} else {
return null;
}
} else {
int code = response.code();
String text = responseBody == null ? "N/A" : responseBody.string();
throw new ClientConnectionException("Invalid response received: " + code + "; " + text);
}
}
private InputStream buildInputStream(ResponseBody responseBody) throws IOException {
InputStream inputStream = responseBody.byteStream();
if (includeRawResponses) {
// we have to buffer the entire input payload, so that after processing
// it can be re-read and used to populate the rawResponse field.
BufferedSource source = responseBody.source();
source.request(Long.MAX_VALUE); // Buffer the entire body
Buffer buffer = source.buffer();
long size = buffer.size();
if (size > Integer.MAX_VALUE) {
throw new UnsupportedOperationException("Non-integer input buffer size specified: " + size);
}
int bufferSize = (int) size;
BufferedInputStream bufferedinputStream = new BufferedInputStream(inputStream, bufferSize);
bufferedinputStream.mark(inputStream.available());
return bufferedinputStream;
} else {
return inputStream;
}
}
private Headers buildHeaders() {
return Headers.of(headers);
}
/**
* Adds an HTTP header to all {@link Request}
* calls used by this service.
*
* @param key the header name (e.g., "Authorization").
* @param value the header value (e.g., "Bearer secretBearer").
*/
public void addHeader(String key, String value) {
headers.put(key, value);
}
/**
* Adds multiple HTTP headers to all {@link Request}
* calls used by this service.
*
* @param headersToAdd a key-value map containing keys (e.g., "Authorization")
* and values (e.g., "Bearer secretBearer").
*/
public void addHeaders(Map headersToAdd) {
headers.putAll(headersToAdd);
}
/**
* Get all custom headers set to this service.
*
* @return the map containing custom headers set.
*/
public HashMap getHeaders() {
return headers;
}
@Override
public void close() {
}
}