com.landawn.abacus.http.AbstractHttpClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of abacus-util-se Show documentation
Show all versions of abacus-util-se 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) 2015 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.Closeable;
import java.io.File;
import java.io.OutputStream;
import java.io.Writer;
import com.landawn.abacus.exception.UncheckedIOException;
import com.landawn.abacus.util.N;
/**
* The Class AbstractHttpClient.
*
* @author Haiyang Li
* @since 0.8
*/
public abstract class AbstractHttpClient implements Closeable {
/** The Constant DEFAULT_MAX_CONNECTION. */
// ...
public static final int DEFAULT_MAX_CONNECTION = 16;
/** Unit is milliseconds. */
public static final int DEFAULT_CONNECTION_TIMEOUT = 8000;
/** The Constant DEFAULT_READ_TIMEOUT. */
public static final int DEFAULT_READ_TIMEOUT = 16000;
/** The url. */
// ...
protected final String _url;
/** The max connection. */
protected final int _maxConnection;
/** The conn timeout. */
protected final long _connectionTimeout;
/** The read timeout. */
protected final long _readTimeout;
/** The settings. */
protected final HttpSettings _settings;
/**
* Instantiates a new abstract http client.
*
* @param url
*/
protected AbstractHttpClient(String url) {
this(url, DEFAULT_MAX_CONNECTION, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT);
}
/**
* Instantiates a new abstract http client.
*
* @param url
* @param maxConnection
*/
protected AbstractHttpClient(String url, int maxConnection) {
this(url, maxConnection, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_READ_TIMEOUT);
}
/**
* Instantiates a new abstract http client.
*
* @param url
* @param maxConnection
* @param connectionTimeout
* @param readTimeout
*/
protected AbstractHttpClient(String url, int maxConnection, long connectionTimeout, long readTimeout) {
this(url, maxConnection, connectionTimeout, readTimeout, null);
}
/**
* Instantiates a new abstract http client.
*
* @param url
* @param maxConnection
* @param connectionTimeout
* @param readTimeout
* @param settings
* @throws UncheckedIOException the unchecked IO exception
*/
protected AbstractHttpClient(String url, int maxConnection, long connectionTimeout, long readTimeout, HttpSettings settings) throws UncheckedIOException {
if (N.isNullOrEmpty(url)) {
throw new IllegalArgumentException("url can't be null or empty");
}
if ((maxConnection < 0) || (connectionTimeout < 0) || (readTimeout < 0)) {
throw new IllegalArgumentException(
"maxConnection, connectionTimeout or readTimeout can't be less than 0: " + maxConnection + ", " + connectionTimeout + ", " + readTimeout);
}
this._url = url;
this._maxConnection = (maxConnection == 0) ? DEFAULT_MAX_CONNECTION : maxConnection;
this._connectionTimeout = (connectionTimeout == 0) ? DEFAULT_CONNECTION_TIMEOUT : connectionTimeout;
this._readTimeout = (readTimeout == 0) ? DEFAULT_READ_TIMEOUT : readTimeout;
this._settings = settings == null ? HttpSettings.create() : settings;
}
/**
*
* @return
*/
public String url() {
return _url;
}
/**
*
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String get() throws UncheckedIOException {
return get(String.class);
}
/**
*
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String get(final HttpSettings settings) throws UncheckedIOException {
return get(String.class, settings);
}
/**
*
* @param queryParameters
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String get(final Object queryParameters) throws UncheckedIOException {
return get(String.class, queryParameters);
}
/**
*
* @param queryParameters
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String get(final Object queryParameters, final HttpSettings settings) throws UncheckedIOException {
return get(String.class, queryParameters, settings);
}
/**
*
* @param
* @param resultClass
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T get(final Class resultClass) throws UncheckedIOException {
return get(resultClass, null, _settings);
}
/**
*
* @param
* @param resultClass
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T get(final Class resultClass, final HttpSettings settings) throws UncheckedIOException {
return get(resultClass, null, settings);
}
/**
*
* @param
* @param resultClass
* @param queryParameters
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T get(final Class resultClass, final Object queryParameters) throws UncheckedIOException {
return get(resultClass, queryParameters, _settings);
}
/**
*
* @param
* @param resultClass
* @param queryParameters
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T get(final Class resultClass, final Object queryParameters, final HttpSettings settings) throws UncheckedIOException {
return execute(resultClass, HttpMethod.GET, queryParameters, settings);
}
/**
*
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String delete() throws UncheckedIOException {
return delete(String.class);
}
/**
*
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String delete(final HttpSettings settings) throws UncheckedIOException {
return delete(String.class, settings);
}
/**
*
* @param queryParameters
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String delete(final Object queryParameters) throws UncheckedIOException {
return delete(String.class, queryParameters);
}
/**
*
* @param queryParameters
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String delete(final Object queryParameters, final HttpSettings settings) throws UncheckedIOException {
return delete(String.class, queryParameters, settings);
}
/**
*
* @param
* @param resultClass
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T delete(final Class resultClass) throws UncheckedIOException {
return delete(resultClass, null, _settings);
}
/**
*
* @param
* @param resultClass
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T delete(final Class resultClass, final HttpSettings settings) throws UncheckedIOException {
return delete(resultClass, null, settings);
}
/**
*
* @param
* @param resultClass
* @param queryParameters
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T delete(final Class resultClass, final Object queryParameters) throws UncheckedIOException {
return delete(resultClass, queryParameters, _settings);
}
/**
*
* @param
* @param resultClass
* @param queryParameters
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T delete(final Class resultClass, final Object queryParameters, final HttpSettings settings) throws UncheckedIOException {
return execute(resultClass, HttpMethod.DELETE, queryParameters, settings);
}
/**
*
* @param request
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String post(final Object request) throws UncheckedIOException {
return post(String.class, request);
}
/**
*
* @param request
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String post(final Object request, final HttpSettings settings) throws UncheckedIOException {
return post(String.class, request, settings);
}
/**
*
* @param
* @param resultClass
* @param request
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T post(final Class resultClass, final Object request) throws UncheckedIOException {
return post(resultClass, request, _settings);
}
/**
*
* @param
* @param resultClass
* @param request
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T post(final Class resultClass, final Object request, final HttpSettings settings) throws UncheckedIOException {
return execute(resultClass, HttpMethod.POST, request, settings);
}
/**
*
* @param request
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String put(final Object request) throws UncheckedIOException {
return put(String.class, request);
}
/**
*
* @param request
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String put(final Object request, final HttpSettings settings) throws UncheckedIOException {
return put(String.class, request, settings);
}
/**
*
* @param
* @param resultClass
* @param request
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T put(final Class resultClass, final Object request) throws UncheckedIOException {
return put(resultClass, request, _settings);
}
/**
*
* @param
* @param resultClass
* @param request
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T put(final Class resultClass, final Object request, final HttpSettings settings) throws UncheckedIOException {
return execute(resultClass, HttpMethod.PUT, request, settings);
}
/**
*
* @param httpMethod
* @param request
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String execute(final HttpMethod httpMethod, final Object request) throws UncheckedIOException {
return execute(String.class, httpMethod, request);
}
/**
*
* @param httpMethod
* @param request
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public String execute(final HttpMethod httpMethod, final Object request, final HttpSettings settings) throws UncheckedIOException {
return execute(String.class, httpMethod, request, settings);
}
/**
*
* @param
* @param resultClass
* @param httpMethod
* @param request
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public T execute(final Class resultClass, final HttpMethod httpMethod, final Object request) throws UncheckedIOException {
return execute(resultClass, httpMethod, request, _settings);
}
/**
* Write the specified request to request body.
*
* @param
* @param resultClass
* @param httpMethod
* @param request can be String/Map/Entity/InputStream/Reader...
* @param settings
* @return
* @throws UncheckedIOException the unchecked IO exception
*/
public abstract T execute(final Class resultClass, final HttpMethod httpMethod, final Object request, final HttpSettings settings)
throws UncheckedIOException;
/**
*
* @param output write the InputStream in the response to this specified File.
* @param httpMethod
* @param request
* @param settings
* @throws UncheckedIOException the unchecked IO exception
*/
public abstract void execute(final File output, final HttpMethod httpMethod, final Object request, final HttpSettings settings) throws UncheckedIOException;
/**
*
* @param output write the InputStream in the response to this specified OutputStream.
* @param httpMethod
* @param request
* @param settings
* @throws UncheckedIOException the unchecked IO exception
*/
public abstract void execute(final OutputStream output, final HttpMethod httpMethod, final Object request, final HttpSettings settings)
throws UncheckedIOException;
/**
*
* @param output write the InputStream in the response to this specified Writer.
* @param httpMethod
* @param request
* @param settings
* @throws UncheckedIOException the unchecked IO exception
*/
public abstract void execute(final Writer output, final HttpMethod httpMethod, final Object request, final HttpSettings settings)
throws UncheckedIOException;
/**
* Close.
*/
@Override
public void close() {
// do nothing.
}
/**
* Checks if is one way request.
*
* @param settings
* @return true, if is one way request
*/
protected boolean isOneWayRequest(HttpSettings settings) {
return _settings.isOneWayRequest() || ((settings != null) && settings.isOneWayRequest());
}
/**
* Gets the content format.
*
* @param settings
* @return
*/
protected ContentFormat getContentFormat(HttpSettings settings) {
ContentFormat contentFormat = null;
if (settings != null) {
contentFormat = settings.getContentFormat();
}
if (contentFormat == null || contentFormat == ContentFormat.NONE) {
contentFormat = _settings.getContentFormat();
}
return contentFormat;
}
/**
* Gets the content type.
*
* @param settings
* @return
*/
protected String getContentType(HttpSettings settings) {
String contentType = null;
if (settings != null) {
contentType = settings.getContentType();
}
if (N.isNullOrEmpty(contentType)) {
contentType = _settings.getContentType();
}
return contentType;
}
/**
* Gets the content encoding.
*
* @param settings
* @return
*/
protected String getContentEncoding(HttpSettings settings) {
String contentEncoding = null;
if (settings != null) {
contentEncoding = settings.getContentEncoding();
}
if (N.isNullOrEmpty(contentEncoding)) {
contentEncoding = _settings.getContentEncoding();
}
return contentEncoding;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy