com.landawn.abacus.http.HttpRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of abacus-common Show documentation
Show all versions of abacus-common Show documentation
A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.
/*
* Copyright (C) 2019 HaiYang Li
*
* 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 com.landawn.abacus.http;
import java.io.File;
import java.io.OutputStream;
import java.io.Writer;
import java.util.Map;
import java.util.concurrent.Callable;
import com.landawn.abacus.exception.UncheckedIOException;
import com.landawn.abacus.util.ContinuableFuture;
import com.landawn.abacus.util.N;
/**
*
* @author Haiyang Li
* @since 1.3
*/
public final class HttpRequest {
final HttpClient httpClient;
HttpMethod httpMethod;
HttpSettings settings;
Object request;
boolean closeHttpClientAfterExecution = false;
HttpRequest(HttpClient httpClient) {
this.httpClient = httpClient;
}
/**
*
* @param httpClient
* @return
*/
public static HttpRequest create(final HttpClient httpClient) {
return new HttpRequest(httpClient);
}
/**
*
* @param url
* @return
*/
public static HttpRequest url(final String url) {
return url(url, HttpClient.DEFAULT_CONNECTION_TIMEOUT, HttpClient.DEFAULT_READ_TIMEOUT);
}
/**
*
* @param url
* @param connectionTimeoutInMillis
* @param readTimeoutInMillis
* @return
*/
public static HttpRequest url(final String url, final long connectionTimeoutInMillis, final long readTimeoutInMillis) {
return new HttpRequest(HttpClient.create(url, 1, connectionTimeoutInMillis, readTimeoutInMillis)).closeHttpClientAfterExecution(true);
}
protected HttpRequest closeHttpClientAfterExecution(boolean b) {
this.closeHttpClientAfterExecution = b;
return this;
}
/**
*
* @param user
* @param password
* @return
*/
public HttpRequest basicAuth(String user, Object password) {
checkSettings();
settings.basicAuth(user, password);
return this;
}
/**
* Set http header specified by {@code name/value}.
* If this {@code HttpSettings} already has any headers with that name, they are all replaced.
*
* @param name
* @param value
* @return
* @see HttpSettings#header(String, Object)
*/
public HttpRequest header(String name, Object value) {
checkSettings();
settings.header(name, value);
return this;
}
/**
* Set http headers specified by {@code name1/value1}, {@code name2/value2}.
* If this {@code HttpSettings} already has any headers with that name, they are all replaced.
*
* @param name1
* @param value1
* @param name2
* @param value2
* @return
* @see HttpSettings#headers(String, Object, String, Object)
*/
public HttpRequest headers(String name1, Object value1, String name2, Object value2) {
checkSettings();
settings.headers(name1, value1, name2, value2);
return this;
}
/**
* Set http headers specified by {@code name1/value1}, {@code name2/value2}, {@code name3/value3}.
* If this {@code HttpSettings} already has any headers with that name, they are all replaced.
*
* @param name1
* @param value1
* @param name2
* @param value2
* @param name3
* @param value3
* @return
* @see HttpSettings#headers(String, Object, String, Object, String, Object)
*/
public HttpRequest headers(String name1, Object value1, String name2, Object value2, String name3, Object value3) {
checkSettings();
settings.headers(name1, value1, name2, value2, name3, value3);
return this;
}
/**
* Set http headers specified by the key/value entities from {@code Map}.
* If this {@code HttpSettings} already has any headers with that name, they are all replaced.
*
* @param headers
* @return
* @see HttpSettings#headers(Map)
*/
public HttpRequest headers(Map headers) {
checkSettings();
settings.headers(headers);
return this;
}
/**
* Removes all headers on this {@code HttpSettings} and adds {@code headers}.
*
* @param headers
* @return
* @see HttpSettings#headers(HttpHeaders)
*/
public HttpRequest headers(HttpHeaders headers) {
checkSettings();
settings.headers(headers);
return this;
}
/**
*
*
* @param connectionTimeout
* @return
*/
public HttpRequest connectionTimeout(int connectionTimeout) {
checkSettings();
settings.setConnectionTimeout(connectionTimeout);
return this;
}
/**
*
*
* @param readTimeout
* @return
*/
public HttpRequest readTimeout(int readTimeout) {
checkSettings();
settings.setReadTimeout(readTimeout);
return this;
}
/**
*
*
* @param useCaches
* @return
*/
public HttpRequest useCaches(boolean useCaches) {
checkSettings();
settings.setUseCaches(useCaches);
return this;
}
/**
*
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String get() throws UncheckedIOException {
return get(String.class);
}
/**
*
* @param
* @param resultClass
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T get(final Class resultClass) throws UncheckedIOException {
return get(resultClass, null);
}
/**
*
* @param query
* @return
*/
public String get(Object query) {
return get(String.class, query);
}
/**
*
* @param
* @param resultClass
* @param query
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T get(final Class resultClass, final Object query) throws UncheckedIOException {
this.httpMethod = HttpMethod.GET;
this.request = query;
return execute(resultClass);
}
/**
*
* @param body
* @return
*/
public String post(Object body) {
return post(String.class, body);
}
/**
*
* @param
* @param resultClass
* @param body
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T post(final Class resultClass, final Object body) throws UncheckedIOException {
this.httpMethod = HttpMethod.POST;
this.request = body;
return execute(resultClass);
}
/**
*
* @param body
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String put(Object body) throws UncheckedIOException {
return put(String.class, body);
}
/**
*
* @param
* @param resultClass
* @param body
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T put(final Class resultClass, final Object body) throws UncheckedIOException {
this.httpMethod = HttpMethod.PUT;
this.request = body;
return execute(resultClass);
}
// /**
// *
// * @param body
// * @return
// * @throws UncheckedIOException the unchecked IO exception
// */
// public String patch(Object body) throws UncheckedIOException {
// return patch(String.class, body);
// }
//
// /**
// *
// * @param
// * @param resultClass
// * @param body
// * @return
// * @throws UncheckedIOException the unchecked IO exception
// */
// public T patch(final Class resultClass, final Object body) throws UncheckedIOException {
// this.httpMethod = HttpMethod.PATCH;
// this.request = body;
//
// return execute(resultClass);
// }
/**
*
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String delete() throws UncheckedIOException {
return delete(String.class);
}
/**
*
* @param
* @param resultClass
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T delete(final Class resultClass) throws UncheckedIOException {
return delete(resultClass, null);
}
/**
*
* @param query
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String delete(Object query) throws UncheckedIOException {
return delete(String.class, query);
}
/**
*
* @param
* @param resultClass
* @param query
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T delete(final Class resultClass, final Object query) throws UncheckedIOException {
this.httpMethod = HttpMethod.DELETE;
this.request = query;
return execute(resultClass);
}
/**
*
* @param httpMethod
* @return
* @throws UncheckedIOException
*/
public String execute(final HttpMethod httpMethod) throws UncheckedIOException {
return execute(String.class, httpMethod);
}
/**
*
* @param
* @param resultClass
* @param httpMethod
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T execute(final Class resultClass, final HttpMethod httpMethod) throws UncheckedIOException {
return execute(resultClass, httpMethod, null);
}
/**
*
* @param httpMethod
* @param body
* @return
* @throws UncheckedIOException
*/
public String execute(final HttpMethod httpMethod, final Object body) throws UncheckedIOException {
return execute(String.class, httpMethod, body);
}
/**
*
* @param
* @param resultClass
* @param httpMethod
* @param body
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T execute(final Class resultClass, final HttpMethod httpMethod, final Object body) throws UncheckedIOException {
N.checkArgNotNull(httpMethod, "httpMethod"); //NOSONAR
this.httpMethod = httpMethod;
this.request = body;
return execute(resultClass);
}
/**
*
* @param
* @param resultClass
* @return
*/
protected T execute(final Class resultClass) {
if (httpMethod == null) {
throw new RuntimeException("HTTP method is not set");
}
try {
return httpClient.execute(resultClass, httpMethod, request, settings);
} finally {
if (closeHttpClientAfterExecution) {
httpClient.close();
}
}
}
/**
*
*
* @param output
* @param httpMethod
* @param body
* @throws UncheckedIOException
*/
public void execute(final File output, final HttpMethod httpMethod, final Object body) throws UncheckedIOException {
N.checkArgNotNull(httpMethod, "httpMethod");
this.httpMethod = httpMethod;
this.request = body;
try {
httpClient.execute(output, this.httpMethod, this.request, settings);
} finally {
if (closeHttpClientAfterExecution) {
httpClient.close();
}
}
}
/**
*
*
* @param output
* @param httpMethod
* @param body
* @throws UncheckedIOException
*/
public void execute(final OutputStream output, final HttpMethod httpMethod, final Object body) throws UncheckedIOException {
N.checkArgNotNull(httpMethod, "httpMethod");
this.httpMethod = httpMethod;
this.request = body;
try {
httpClient.execute(output, this.httpMethod, this.request, settings);
} finally {
if (closeHttpClientAfterExecution) {
httpClient.close();
}
}
}
/**
*
*
* @param output
* @param httpMethod
* @param body
* @throws UncheckedIOException
*/
public void execute(final Writer output, final HttpMethod httpMethod, final Object body) throws UncheckedIOException {
N.checkArgNotNull(httpMethod, "httpMethod");
this.httpMethod = httpMethod;
this.request = body;
try {
httpClient.execute(output, this.httpMethod, this.request, settings);
} finally {
if (closeHttpClientAfterExecution) {
httpClient.close();
}
}
}
/**
*
*
* @return
*/
public ContinuableFuture asyncGet() {
return asyncGet(String.class);
}
/**
*
* @param
* @param resultClass
* @return
*/
public ContinuableFuture asyncGet(final Class resultClass) {
return asyncGet(resultClass, null);
}
/**
*
* @param query
* @return
*/
public ContinuableFuture asyncGet(Object query) {
return asyncGet(String.class, query);
}
/**
*
* @param
* @param resultClass
* @param query
* @return
*/
public ContinuableFuture asyncGet(final Class resultClass, final Object query) {
this.httpMethod = HttpMethod.GET;
this.request = query;
return asyncExecute(resultClass);
}
/**
*
* @param body
* @return
*/
public ContinuableFuture asyncPost(Object body) {
return asyncPost(String.class, body);
}
/**
*
* @param
* @param resultClass
* @param body
* @return
*/
public ContinuableFuture asyncPost(final Class resultClass, final Object body) {
this.httpMethod = HttpMethod.POST;
this.request = body;
return asyncExecute(resultClass);
}
/**
*
* @param body
* @return
*/
public ContinuableFuture asyncPut(Object body) {
return asyncPut(String.class, body);
}
/**
*
* @param
* @param resultClass
* @param body
* @return
*/
public ContinuableFuture asyncPut(final Class resultClass, final Object body) {
this.httpMethod = HttpMethod.PUT;
this.request = body;
return asyncExecute(resultClass);
}
// /**
// *
// * @param body
// * @return
// */
// public ContinuableFuture asyncPatch(Object body) {
// return asyncPatch(String.class, body);
// }
//
// /**
// *
// * @param
// * @param resultClass
// * @param body
// * @return
// */
// public ContinuableFuture asyncPatch(final Class resultClass, final Object body) {
// this.httpMethod = HttpMethod.PATCH;
// this.request = body;
//
// return asyncExecute(resultClass);
// }
/**
*
*
* @return
*/
public ContinuableFuture asyncDelete() {
return asyncDelete(String.class);
}
/**
*
* @param
* @param resultClass
* @return
*/
public ContinuableFuture asyncDelete(final Class resultClass) {
return asyncDelete(resultClass, null);
}
/**
*
* @param query
* @return
*/
public ContinuableFuture asyncDelete(Object query) {
return asyncDelete(String.class, query);
}
/**
*
* @param
* @param resultClass
* @param query
* @return
*/
public ContinuableFuture asyncDelete(final Class resultClass, final Object query) {
this.httpMethod = HttpMethod.DELETE;
this.request = query;
return asyncExecute(resultClass);
}
/**
*
*
* @param httpMethod
* @return
*/
public ContinuableFuture asyncExecute(final HttpMethod httpMethod) {
return asyncExecute(String.class, httpMethod);
}
/**
*
*
* @param
* @param resultClass
* @param httpMethod
* @return
*/
public ContinuableFuture asyncExecute(final Class resultClass, final HttpMethod httpMethod) {
return asyncExecute(resultClass, httpMethod, null);
}
/**
*
*
* @param httpMethod
* @param body
* @return
*/
public ContinuableFuture asyncExecute(final HttpMethod httpMethod, Object body) {
return asyncExecute(String.class, httpMethod, body);
}
/**
*
*
* @param
* @param resultClass
* @param httpMethod
* @param body
* @return
*/
public ContinuableFuture asyncExecute(final Class resultClass, final HttpMethod httpMethod, final Object body) {
this.httpMethod = httpMethod;
this.request = body;
return asyncExecute(resultClass);
}
protected ContinuableFuture asyncExecute(final Class resultClass) {
if (httpMethod == null) {
throw new RuntimeException("HTTP method is not set");
}
return httpClient._asyncExecutor.execute(() -> execute(resultClass));
}
/**
*
*
* @param output
* @param httpMethod
* @param body
* @return
*/
public ContinuableFuture asyncExecute(final File output, final HttpMethod httpMethod, final Object body) {
final Callable cmd = () -> {
execute(output, httpMethod, body);
return null;
};
return httpClient._asyncExecutor.execute(cmd);
}
/**
*
*
* @param output
* @param httpMethod
* @param body
* @return
*/
public ContinuableFuture asyncExecute(final OutputStream output, final HttpMethod httpMethod, final Object body) {
final Callable cmd = () -> {
execute(output, httpMethod, body);
return null;
};
return httpClient._asyncExecutor.execute(cmd);
}
/**
*
*
* @param output
* @param httpMethod
* @param body
* @return
*/
public ContinuableFuture asyncExecute(final Writer output, final HttpMethod httpMethod, final Object body) {
final Callable cmd = () -> {
execute(output, httpMethod, body);
return null;
};
return httpClient._asyncExecutor.execute(cmd);
}
/**
* Check settings.
*/
protected void checkSettings() {
if (settings == null) {
settings = new HttpSettings();
}
}
}