SimpleHttp (Drill : 1.20.3 API)

java.lang.Object
- org.apache.drill.exec.store.http.util.SimpleHttp

All Implemented Interfaces:

AutoCloseable
```
public class SimpleHttp
extends Object
implements AutoCloseable
```
Performs the actual HTTP requests for the HTTP Storage Plugin. The core method is the getInputStream() method which accepts a url and opens an InputStream with that URL's contents.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SimpleHttp.BasicAuthInterceptor` Intercepts requests and adds authentication headers to the request
`static class`	`SimpleHttp.SimpleHttpBuilder`

Constructor Summary

Constructors
Constructor and Description
`SimpleHttp(HttpSubScan scanDefn, okhttp3.HttpUrl url, File tempDir, HttpProxyConfig proxyConfig, CustomErrorContext errorContext, Paginator paginator)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addProxyInfo(okhttp3.OkHttpClient.Builder builder, HttpProxyConfig proxyConfig)` Applies the proxy configuration to the OkHttp3 builder.
`static SimpleHttp.SimpleHttpBuilder`	`builder()`
`void`	`close()`
`static String`	`decodedURL(okhttp3.HttpUrl url)` Returns the URL-decoded URL.
`static String`	`getDefaultParameterValue(okhttp3.HttpUrl url, String parameter)` This function is used to extract the default parameter supplied in a URL.
`InputStream`	`getInputStream()` Returns an InputStream based on the URL and config in the scanSpec.
`int`	`getResponseCode()` Gets the HTTP response code from the HTTP call.
`String`	`getResponseMessage()` Gets the HTTP response code from the HTTP call.
`String`	`getResponseProtocol()` Gets the HTTP response code from the HTTP call.
`String`	`getResponseURL()` Gets the HTTP response code from the HTTP call.
`static List<String>`	`getURLParameters(okhttp3.HttpUrl url)` APIs are sometimes structured with parameters in the URL itself.
`static boolean`	`hasURLParameters(okhttp3.HttpUrl url)` Returns true if the url has url parameters, as indicated by the presence of {param} in a url.
`static String`	`mapURLParameters(okhttp3.HttpUrl url, Map<String,String> filters)` Used for APIs which have parameters in the URL.
`String`	`url()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleHttp
```
public SimpleHttp(HttpSubScan scanDefn,
                  okhttp3.HttpUrl url,
                  File tempDir,
                  HttpProxyConfig proxyConfig,
                  CustomErrorContext errorContext,
                  Paginator paginator)
```
- Method Detail
  - builder
```
public static SimpleHttp.SimpleHttpBuilder builder()
```
  - url
```
public String url()
```
  - addProxyInfo
```
public static void addProxyInfo(okhttp3.OkHttpClient.Builder builder,
                                HttpProxyConfig proxyConfig)
```
    Applies the proxy configuration to the OkHttp3 builder. This ensures that proxy configurations will be consistent across HTTP REST connections.
    
    Parameters:
    
    builder - The input OkHttp3 builder
    
    proxyConfig - The proxy configuration
  - getInputStream
```
public InputStream getInputStream()
```
    Returns an InputStream based on the URL and config in the scanSpec. If anything goes wrong the method throws a UserException.
    
    Returns:
    
    An Inputstream of the data from the URL call. The caller is responsible for calling close() on the InputStream.
  - getResponseCode
```
public int getResponseCode()
```
    Gets the HTTP response code from the HTTP call. Note that this value is only available after the getInputStream() method has been called.
    
    Returns:
    
    int value of the HTTP response code
  - getResponseMessage
```
public String getResponseMessage()
```
    Gets the HTTP response code from the HTTP call. Note that this value is only available after the getInputStream() method has been called.
    
    Returns:
    
    int of HTTP response code
  - getResponseProtocol
```
public String getResponseProtocol()
```
    Gets the HTTP response code from the HTTP call. Note that this value is only available after the getInputStream() method has been called.
    
    Returns:
    
    The HTTP response protocol
  - getResponseURL
```
public String getResponseURL()
```
    Gets the HTTP response code from the HTTP call. Note that this value is only available after the getInputStream() method has been called.
    
    Returns:
    
    The HTTP response URL
  - decodedURL
```
public static String decodedURL(okhttp3.HttpUrl url)
```
    Returns the URL-decoded URL. If the URL is invalid, return the original URL.
    
    Returns:
    
    Returns the URL-decoded URL
  - hasURLParameters
```
public static boolean hasURLParameters(okhttp3.HttpUrl url)
```
    Returns true if the url has url parameters, as indicated by the presence of {param} in a url.
    
    Returns:
    
    True if there are URL params, false if not
  - getURLParameters
```
public static List<String> getURLParameters(okhttp3.HttpUrl url)
```
    APIs are sometimes structured with parameters in the URL itself. For instance, to request a list of an organization's repositories in github, the URL is: https://api.github.com/orgs/{org}/repos, where you can replace the org with the actual organization name.
    
    Returns:
    
    A list of URL parameters enclosed by curly braces.
  - getDefaultParameterValue
```
public static String getDefaultParameterValue(okhttp3.HttpUrl url,
                                              String parameter)
```
    This function is used to extract the default parameter supplied in a URL. For instance, if the supplied URL is http://someapi.com/path/{p1=foo}, the function will return foo. If there is not a matching parameter or no default value, the function will return null.
    
    Parameters:
    
    url - The URL containing a default parameter
    
    parameter - The parameter for which you need the value
    
    Returns:
    
    The value for the supplied parameter
  - mapURLParameters
```
public static String mapURLParameters(okhttp3.HttpUrl url,
                                      Map<String,String> filters)
```
    Used for APIs which have parameters in the URL. This function maps the filters pushed down from the query into the URL. For example the API: github.com/orgs/{org}/repos requires a user to specify an organization and replace {org} with an actual organization. The filter is passed down from the query. Note that if a URL contains URL parameters and one is not provided in the filters, Drill will throw a UserException.
    
    Parameters:
    
    url - The HttpUrl containing URL Parameters
    
    filters - A CaseInsensitiveMap of filters
    
    Returns:
    
    A string of the URL with the URL parameters replaced by filter values
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable

Class SimpleHttp

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleHttp

Method Detail

builder

url

addProxyInfo

getInputStream

getResponseCode

getResponseMessage

getResponseProtocol

getResponseURL

decodedURL

hasURLParameters

getURLParameters

getDefaultParameterValue

mapURLParameters

close