MultithreadedHttpClient (Geotools modules 26-SNAPSHOT API)

Object
- MultithreadedHttpClient

All Implemented Interfaces:

Closeable, AutoCloseable, HTTPBehavior, HTTPClient, HTTPConnectionPooling, HTTPProxy
```
public class MultithreadedHttpClient
extends Object
implements HTTPClient, HTTPConnectionPooling, HTTPProxy
```
An Apache commons HTTP client based HTTPClient backed by a multithreaded connection manager that allows to reuse connections to the backing server and to limit the max number of concurrent connections.
Java System properties http.proxyHost, http.proxyPort, http.proxyUser, and http.proxyPassword are respected.
Copied from gt-wms.

Author:

groldan, awaterme

See Also:

AbstractOpenWebService.setHttpClient(HTTPClient)

Constructor Summary

Constructors
Constructor and Description

MultithreadedHttpClient()

Constructors
Constructor and Description
`MultithreadedHttpClient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`HttpClient`	`createHttpClient()`
`HTTPResponse`	`get(URL url)` Executes an HTTP GET request against the provided URL and returns the server response.
`HTTPResponse`	`get(URL url, Map<String,String> headers)` Executes an HTTP GET request against the provided URL and returns the server response.
`int`	`getConnectTimeout()`
`int`	`getMaxConnections()` Max connections kept in the pool
`String`	`getPassword()`
`int`	`getReadTimeout()`
`String`	`getUser()`
`boolean`	`isTryGzip()`
`HTTPResponse`	`post(URL url, InputStream postContent, String postContentType)` Executes an HTTP POST request against the provided URL, sending the contents of `postContent` as the POST method body and setting the Content-Type request header to `postContentType` if given, and returns the server response.
`void`	`setConnectTimeout(int connectTimeout)`
`void`	`setMaxConnections(int maxConnections)` Sets max connections kept in the pool
`void`	`setPassword(String password)`
`void`	`setReadTimeout(int readTimeout)`
`void`	`setTryGzip(boolean tryGZIP)`
`void`	`setUser(String user)`

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

- Constructor Detail
  - MultithreadedHttpClient
```
public MultithreadedHttpClient()
```
- Method Detail
  - createHttpClient
```
public HttpClient createHttpClient()
```
  - post
```
public HTTPResponse post(URL url,
                         InputStream postContent,
                         String postContentType)
                  throws IOException
```
    Description copied from interface: HTTPClient
    
    Executes an HTTP POST request against the provided URL, sending the contents of postContent as the POST method body and setting the Content-Type request header to postContentType if given, and returns the server response.
    If an HTTP authentication user and password is set, the appropriate authentication HTTP header will be sent with the request.
    If a connection timeout is set, the http connection will be set to respect that timeout.
    If a read timeout is set, the http connection will be set to respect it.
    
    Specified by:
    
    post in interface HTTPClient
    
    Parameters:
    
    url - the URL against which to execute the POST request
    
    postContent - an input stream with the contents of the POST body
    
    postContentType - the MIME type of the contents sent as the request POST body, can be null
    
    Returns:
    
    the HTTPResponse encapsulating the response to the HTTP POST request
    
    Throws:
    
    IOException
  - get
```
public HTTPResponse get(URL url)
                 throws IOException
```
    Description copied from interface: HTTPClient
    
    Executes an HTTP GET request against the provided URL and returns the server response.
    If an HTTP authentication user and password is set, the appropriate authentication HTTP header will be sent with the request.
    If a connection timeout is set, the http connection will be set to respect that timeout.
    If a read timeout is set, the http connection will be set to respect it.
    
    Specified by:
    
    get in interface HTTPClient
    
    Parameters:
    
    url - the URL to retrieve
    
    Returns:
    
    an HTTPResponse encapsulating the response to the HTTP GET request
    
    Throws:
    
    IOException
  - get
```
public HTTPResponse get(URL url,
                        Map<String,String> headers)
                 throws IOException
```
    Description copied from interface: HTTPClient
    
    Executes an HTTP GET request against the provided URL and returns the server response.
    If an HTTP authentication user and password is set, the appropriate authentication HTTP header will be sent with the request.
    If a connection timeout is set, the http connection will be set to respect that timeout.
    If a read timeout is set, the http connection will be set to respect it.
    header parameter contains additional headers to add to the request.
    
    Specified by:
    
    get in interface HTTPClient
    
    Parameters:
    
    url - the URL to retrieve
    
    headers - a list of custom headers to add to the request.
    
    Returns:
    
    an HTTPResponse encapsulating the response to the HTTP GET request
    
    Throws:
    
    IOException
  - getUser
```
public String getUser()
```
    Specified by:
    
    getUser in interface HTTPClient
    
    Returns:
    
    the HTTP BASIC Authentication user name, or null if not set
  - setUser
```
public void setUser(String user)
```
    Specified by:
    
    setUser in interface HTTPClient
    
    Parameters:
    
    user - the HTTP BASIC Authentication user name
  - getPassword
```
public String getPassword()
```
    Specified by:
    
    getPassword in interface HTTPClient
    
    Returns:
    
    the HTTP BASIC Authentication password, or null if not set
  - setPassword
```
public void setPassword(String password)
```
    Specified by:
    
    setPassword in interface HTTPClient
    
    Parameters:
    
    password - the HTTP BASIC Authentication password
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Specified by:
    
    getConnectTimeout in interface HTTPClient
    
    Returns:
    
    the tcp/ip connect timeout in seconds
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
    Specified by:
    
    setConnectTimeout in interface HTTPClient
    
    Parameters:
    
    connectTimeout - tcp/ip connect timeout in seconds
  - getReadTimeout
```
public int getReadTimeout()
```
    Specified by:
    
    getReadTimeout in interface HTTPClient
    
    Returns:
    
    the socket read timeout in seconds
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
    Specified by:
    
    setReadTimeout in interface HTTPClient
    
    Parameters:
    
    readTimeout - socket read timeout in seconds
  - getMaxConnections
```
public int getMaxConnections()
```
    Description copied from interface: HTTPConnectionPooling
    
    Max connections kept in the pool
    
    Specified by:
    
    getMaxConnections in interface HTTPConnectionPooling
    
    Returns:
  - setMaxConnections
```
public void setMaxConnections(int maxConnections)
```
    Description copied from interface: HTTPConnectionPooling
    
    Sets max connections kept in the pool
    
    Specified by:
    
    setMaxConnections in interface HTTPConnectionPooling
  - setTryGzip
```
public void setTryGzip(boolean tryGZIP)
```
    Specified by:
    
    setTryGzip in interface HTTPClient
    
    See Also:
    
    HTTPClient.setTryGzip(boolean)
  - isTryGzip
```
public boolean isTryGzip()
```
    Specified by:
    
    isTryGzip in interface HTTPClient
    
    Returns:
    
    whether gzip content encoding will be attempted; defaults to false
    
    See Also:
    
    HTTPClient.isTryGzip()
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable

Class MultithreadedHttpClient

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

MultithreadedHttpClient

Method Detail

createHttpClient

post

get

get

getUser

setUser

getPassword

setPassword

getConnectTimeout

setConnectTimeout

getReadTimeout

setReadTimeout

getMaxConnections

setMaxConnections

setTryGzip

isTryGzip

close