Package org.apache.pinot.common.utils.http

Class HttpClient

java.lang.Object

org.apache.pinot.common.utils.http.HttpClient

All Implemented Interfaces:

AutoCloseable

public class HttpClient
extends Object
implements AutoCloseable

The HTTPClient wraps around a CloseableHttpClient to provide a reusable client for making HTTP requests.

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUTH_HTTP_HEADER
static int	DEFAULT_SOCKET_TIMEOUT_MS
static int	DELETE_REQUEST_SOCKET_TIMEOUT_MS
static int	GET_REQUEST_SOCKET_TIMEOUT_MS
static String	JSON_CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
HttpClient()
HttpClient(SSLContext sslContext)

Method Summary

Modifier and Type	Method	Description
static void	addHeadersAndParameters(org.apache.http.client.methods.RequestBuilder requestBuilder, List<org.apache.http.Header> headers, List<org.apache.http.NameValuePair> parameters)
void	close()
int	downloadFile(URI uri, int socketTimeoutMs, File dest, AuthProvider authProvider, List<org.apache.http.Header> httpHeaders)	Download a file using default settings, with an optional auth token
File	downloadUntarFileStreamed(URI uri, int socketTimeoutMs, File dest, AuthProvider authProvider, List<org.apache.http.Header> httpHeaders, long maxStreamRateInByte)	Download and untar in a streamed manner a file using default settings, with an optional auth token
protected org.apache.http.client.methods.CloseableHttpResponse	execute(org.apache.http.client.methods.HttpUriRequest request)
static HttpClient	getInstance()
SimpleHttpResponse	sendDeleteRequest(URI uri)	Deprecated due to lack of auth header support.
SimpleHttpResponse	sendDeleteRequest(URI uri, Map<String,String> headers)
SimpleHttpResponse	sendDeleteRequest(URI uri, Map<String,String> headers, AuthProvider authProvider)
SimpleHttpResponse	sendGetRequest(URI uri)	Deprecated due to lack of auth header support.
SimpleHttpResponse	sendGetRequest(URI uri, Map<String,String> headers)
SimpleHttpResponse	sendGetRequest(URI uri, Map<String,String> headers, AuthProvider authProvider)
SimpleHttpResponse	sendJsonPostRequest(URI uri, String jsonRequestBody)
SimpleHttpResponse	sendJsonPostRequest(URI uri, String jsonRequestBody, Map<String,String> headers)
SimpleHttpResponse	sendJsonPostRequest(URI uri, String jsonRequestBody, Map<String,String> headers, AuthProvider authProvider)
SimpleHttpResponse	sendJsonPutRequest(URI uri, String jsonRequestBody)
SimpleHttpResponse	sendJsonPutRequest(URI uri, String jsonRequestBody, Map<String,String> headers)
SimpleHttpResponse	sendJsonPutRequest(URI uri, String jsonRequestBody, Map<String,String> headers, AuthProvider authProvider)
SimpleHttpResponse	sendMultipartPostRequest(String url, String body)
SimpleHttpResponse	sendMultipartPostRequest(String url, String body, Map<String,String> headers)
SimpleHttpResponse	sendMultipartPutRequest(String url, String body)
SimpleHttpResponse	sendMultipartPutRequest(String url, String body, Map<String,String> headers)
SimpleHttpResponse	sendPostRequest(URI uri, org.apache.http.HttpEntity payload, Map<String,String> headers)	Deprecated due to lack of auth header support.
SimpleHttpResponse	sendPostRequest(URI uri, org.apache.http.HttpEntity payload, Map<String,String> headers, AuthProvider authProvider)
SimpleHttpResponse	sendPutRequest(URI uri, org.apache.http.HttpEntity payload, Map<String,String> headers)	Deprecated due to lack of auth header support.
SimpleHttpResponse	sendPutRequest(URI uri, org.apache.http.HttpEntity payload, Map<String,String> headers, AuthProvider authProvider)
SimpleHttpResponse	sendRequest(org.apache.http.client.methods.HttpUriRequest request)
static void	setTimeout(org.apache.http.client.methods.RequestBuilder requestBuilder, int socketTimeoutMs)
static SimpleHttpResponse	wrapAndThrowHttpException(SimpleHttpResponse resp)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SOCKET_TIMEOUT_MS

public static final int DEFAULT_SOCKET_TIMEOUT_MS

See Also:

Constant Field Values

GET_REQUEST_SOCKET_TIMEOUT_MS

public static final int GET_REQUEST_SOCKET_TIMEOUT_MS

See Also:

Constant Field Values

DELETE_REQUEST_SOCKET_TIMEOUT_MS

public static final int DELETE_REQUEST_SOCKET_TIMEOUT_MS

See Also:

Constant Field Values

AUTH_HTTP_HEADER

public static final String AUTH_HTTP_HEADER

See Also:

Constant Field Values

JSON_CONTENT_TYPE

public static final String JSON_CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

HttpClient

public HttpClient()

HttpClient

public HttpClient(@Nullable
                  SSLContext sslContext)

Method Detail

getInstance

public static HttpClient getInstance()

sendGetRequest

public SimpleHttpResponse sendGetRequest(URI uri)
                                  throws IOException

Deprecated due to lack of auth header support. May break for deployments with auth enabled

Throws:

IOException

See Also:

sendGetRequest(URI, Map, AuthProvider)

sendGetRequest

public SimpleHttpResponse sendGetRequest(URI uri,
                                         @Nullable
                                         Map<String,String> headers)
                                  throws IOException

Throws:

IOException

sendGetRequest

public SimpleHttpResponse sendGetRequest(URI uri,
                                         @Nullable
                                         Map<String,String> headers,
                                         @Nullable
                                         AuthProvider authProvider)
                                  throws IOException

Throws:

IOException

sendDeleteRequest

public SimpleHttpResponse sendDeleteRequest(URI uri)
                                     throws IOException

Deprecated due to lack of auth header support. May break for deployments with auth enabled

Throws:

IOException

See Also:

sendDeleteRequest(URI, Map, AuthProvider)

sendDeleteRequest

public SimpleHttpResponse sendDeleteRequest(URI uri,
                                            @Nullable
                                            Map<String,String> headers)
                                     throws IOException

Throws:

IOException

sendDeleteRequest

public SimpleHttpResponse sendDeleteRequest(URI uri,
                                            @Nullable
                                            Map<String,String> headers,
                                            @Nullable
                                            AuthProvider authProvider)
                                     throws IOException

Throws:

IOException

sendPostRequest

public SimpleHttpResponse sendPostRequest(URI uri,
                                          @Nullable
                                          org.apache.http.HttpEntity payload,
                                          @Nullable
                                          Map<String,String> headers)
                                   throws IOException

Deprecated due to lack of auth header support. May break for deployments with auth enabled

Throws:

IOException

See Also:

sendPostRequest(URI, HttpEntity, Map, AuthProvider)

sendPostRequest

public SimpleHttpResponse sendPostRequest(URI uri,
                                          @Nullable
                                          org.apache.http.HttpEntity payload,
                                          @Nullable
                                          Map<String,String> headers,
                                          @Nullable
                                          AuthProvider authProvider)
                                   throws IOException

Throws:

IOException

sendPutRequest

public SimpleHttpResponse sendPutRequest(URI uri,
                                         @Nullable
                                         org.apache.http.HttpEntity payload,
                                         @Nullable
                                         Map<String,String> headers)
                                  throws IOException

Deprecated due to lack of auth header support. May break for deployments with auth enabled

Throws:

IOException

See Also:

sendPutRequest(URI, HttpEntity, Map, AuthProvider)

sendPutRequest

public SimpleHttpResponse sendPutRequest(URI uri,
                                         @Nullable
                                         org.apache.http.HttpEntity payload,
                                         @Nullable
                                         Map<String,String> headers,
                                         @Nullable
                                         AuthProvider authProvider)
                                  throws IOException

Throws:

IOException

sendJsonPostRequest

public SimpleHttpResponse sendJsonPostRequest(URI uri,
                                              @Nullable
                                              String jsonRequestBody)
                                       throws IOException

Throws:

IOException

sendJsonPostRequest

public SimpleHttpResponse sendJsonPostRequest(URI uri,
                                              @Nullable
                                              String jsonRequestBody,
                                              @Nullable
                                              Map<String,String> headers)
                                       throws IOException

Throws:

IOException

sendJsonPostRequest

public SimpleHttpResponse sendJsonPostRequest(URI uri,
                                              @Nullable
                                              String jsonRequestBody,
                                              @Nullable
                                              Map<String,String> headers,
                                              @Nullable
                                              AuthProvider authProvider)
                                       throws IOException

Throws:

IOException

sendJsonPutRequest

public SimpleHttpResponse sendJsonPutRequest(URI uri,
                                             @Nullable
                                             String jsonRequestBody)
                                      throws IOException

Throws:

IOException

sendJsonPutRequest

public SimpleHttpResponse sendJsonPutRequest(URI uri,
                                             @Nullable
                                             String jsonRequestBody,
                                             @Nullable
                                             Map<String,String> headers)
                                      throws IOException

Throws:

IOException

sendJsonPutRequest

public SimpleHttpResponse sendJsonPutRequest(URI uri,
                                             @Nullable
                                             String jsonRequestBody,
                                             @Nullable
                                             Map<String,String> headers,
                                             @Nullable
                                             AuthProvider authProvider)
                                      throws IOException

Throws:

IOException

sendRequest

public SimpleHttpResponse sendRequest(org.apache.http.client.methods.HttpUriRequest request)
                               throws IOException

Throws:

IOException

execute

protected org.apache.http.client.methods.CloseableHttpResponse execute(org.apache.http.client.methods.HttpUriRequest request)
                                                                throws IOException

Throws:

IOException

sendMultipartPostRequest

public SimpleHttpResponse sendMultipartPostRequest(String url,
                                                   String body)
                                            throws IOException

Throws:

IOException

sendMultipartPostRequest

public SimpleHttpResponse sendMultipartPostRequest(String url,
                                                   String body,
                                                   @Nullable
                                                   Map<String,String> headers)
                                            throws IOException

Throws:

IOException

sendMultipartPutRequest

public SimpleHttpResponse sendMultipartPutRequest(String url,
                                                  String body)
                                           throws IOException

Throws:

IOException

sendMultipartPutRequest

public SimpleHttpResponse sendMultipartPutRequest(String url,
                                                  String body,
                                                  @Nullable
                                                  Map<String,String> headers)
                                           throws IOException

Throws:

IOException

downloadFile

public int downloadFile(URI uri,
                        int socketTimeoutMs,
                        File dest,
                        AuthProvider authProvider,
                        List<org.apache.http.Header> httpHeaders)
                 throws IOException,
                        HttpErrorStatusException

Download a file using default settings, with an optional auth token

Parameters:

uri - URI

socketTimeoutMs - Socket timeout in milliseconds

dest - File destination

authProvider - auth provider

httpHeaders - http headers

Returns:

Response status code

Throws:

IOException

HttpErrorStatusException

downloadUntarFileStreamed

public File downloadUntarFileStreamed(URI uri,
                                      int socketTimeoutMs,
                                      File dest,
                                      AuthProvider authProvider,
                                      List<org.apache.http.Header> httpHeaders,
                                      long maxStreamRateInByte)
                               throws IOException,
                                      HttpErrorStatusException

Download and untar in a streamed manner a file using default settings, with an optional auth token

Parameters:

uri - URI

socketTimeoutMs - Socket timeout in milliseconds

dest - File destination

authProvider - auth provider

httpHeaders - http headers

maxStreamRateInByte - limit the rate to write download-untar stream to disk, in bytes -1 for no disk write limit, 0 for limit the writing to min(untar, download) rate

Returns:

The untarred directory

Throws:

IOException

HttpErrorStatusException

wrapAndThrowHttpException

public static SimpleHttpResponse wrapAndThrowHttpException(SimpleHttpResponse resp)
                                                    throws HttpErrorStatusException

Throws:

HttpErrorStatusException

addHeadersAndParameters

public static void addHeadersAndParameters(org.apache.http.client.methods.RequestBuilder requestBuilder,
                                           @Nullable
                                           List<org.apache.http.Header> headers,
                                           @Nullable
                                           List<org.apache.http.NameValuePair> parameters)

setTimeout

public static void setTimeout(org.apache.http.client.methods.RequestBuilder requestBuilder,
                              int socketTimeoutMs)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException