HttpClient (Ibello API 1.21.1 API)

```
public interface HttpClient
```
This interface describes a HTTP client which sends a single request and receives a response.
A new instance of this interface can be configured with it's fluent methods. These methods return the same HttpClient instance so the configuration can be performed with method call chain. At the end of this chain the sendAndReceive() method should be called which executes the call and returns with the response.

The client instance has some default configuration.
- Default HTTP method is GET. This can be changed with the method(HttpMethod) method.
- Default request charset is UTF-8. This can be changed with charset(Charset) method.
- Default request MIME type is "text/plain". This can be changed with mimeType(String) method.
- By default the "Accept" header is added to the request with "text/html" value. This can be changed with the accept(String) method.
Example HTTP API call:
```
 String data = ...;
 HttpResponse<String> response = httpClient()
     .url("http://myservice.xy/service")
     .body(data)
     .basicAuthorization("user", "pwd")
     .sendAndReceive();
 
```
Author:

Kornél Simon

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`HttpClient`	`accept(String mimeType)` Sets the "Accept" header of the HTTP request.
`HttpClient`	`authorization(String authorization)` Sets the "Authorization" header of the HTTP request.
`HttpClient`	`basicAuthorization(String username, String password)` Sets the "Authorization" header of the HTTP request.
`HttpClient`	`bearerAuthorization(String token)` Sets the "Authorization" header of the HTTP request.
`<T> HttpClient`	`body(T object)` Sets the body of the HTTP request.
`HttpClient`	`charset(Charset charset)` Sets the charset of the HTTP request's content.
`HttpClient`	`charset(String charsetName)` Sets the charset of the HTTP request's content.
`HttpClient`	`header(String name, String value)` Adds a HTTP header to the request.
`HttpClient`	`method(HttpMethod method)` Sets the HTTP method of the request.
`HttpClient`	`mimeType(String mimeType)` Sets the MIME type of the HTTP request's content.
`HttpResponse<String>`	`sendAndReceive()` Executes the HTTP request: sends the request and receives the response.
`HttpClient`	`url(String url)` Sets the URL of the HTTP request.
`HttpClient`	`url(URL url)` Sets the URL of the HTTP request.
`HttpClient`	`withoutCertificateValidation()` Turns off SSL certificate validation.

- Method Detail
  - url
```
HttpClient url(String url)
```
    Sets the URL of the HTTP request. The argument can be:
    - a full absolute URL with protocol and hostname, eg. http://localhost:8080/page,
    - a relative URL, eg. /page or index.html.
    If the URL is absolute, then it will be used by the HTTP client.
    
    If the URL is relative, then it will be appended to the value of the ibello.url.base configuration property, and the result URL will be used.
    Parameters:
    
    url - relative or absolute URL
    
    Returns:
    
    this HttpClient instance
    
    Throws:
    
    NullPointerException - when the argument is null
  - url
```
HttpClient url(URL url)
```
    Sets the URL of the HTTP request.
    
    Parameters:
    
    url - the URL
    
    Returns:
    
    this HttpClient instance
    
    Throws:
    
    NullPointerException - when the argument is null
  - method
```
HttpClient method(HttpMethod method)
```
    Sets the HTTP method of the request.
    
    Parameters:
    
    method - the HTTP method
    
    Returns:
    
    this HttpClient instance
  - mimeType
```
HttpClient mimeType(String mimeType)
```
    Sets the MIME type of the HTTP request's content.
    
    Parameters:
    
    mimeType - a valid MIME type
    
    Returns:
    
    this HttpClient instance
  - charset
```
HttpClient charset(Charset charset)
```
    Sets the charset of the HTTP request's content.
    
    Parameters:
    
    charset - a java Charset instance
    
    Returns:
    
    this HttpClient instance
  - charset
```
HttpClient charset(String charsetName)
```
    Sets the charset of the HTTP request's content.
    
    Parameters:
    
    charsetName - the name of the charset
    
    Returns:
    
    this HttpClient instance
  - body
```
<T> HttpClient body(T object)
```
    Sets the body of the HTTP request. The parameter can be:
    - a File instance, in this case a multipart attachment will be added to the body,
    - an InputStream instance, in this case the content of the stream will be the request body,
    - or anything else - which will be transformed to a String.
    Type Parameters:
    
    T - the type of the body object
    
    Parameters:
    
    object - the object to be sent
    
    Returns:
    
    this HttpClient instance
  - header
```
HttpClient header(String name,
                  String value)
```
    Adds a HTTP header to the request.
    
    Parameters:
    
    name - the name of the header
    
    value - the value of the header
    
    Returns:
    
    this HttpClient instance
  - accept
```
HttpClient accept(String mimeType)
```
    Sets the "Accept" header of the HTTP request.
    
    Parameters:
    
    mimeType - a valid MIME type
    
    Returns:
    
    this HttpClient instance
  - authorization
```
HttpClient authorization(String authorization)
```
    Sets the "Authorization" header of the HTTP request.
    
    Parameters:
    
    authorization - the value of the Authorization header
    
    Returns:
    
    this HttpClient instance
  - basicAuthorization
```
HttpClient basicAuthorization(String username,
                              String password)
```
    Sets the "Authorization" header of the HTTP request. It will be a "Basic" authorization value with the given username and password.
    
    Parameters:
    
    username - the authorization username
    
    password - the authorization password
    
    Returns:
    
    this HttpClient instance
  - bearerAuthorization
```
HttpClient bearerAuthorization(String token)
```
    Sets the "Authorization" header of the HTTP request. It will be a "Bearer" authorization value with the given token.
    
    Parameters:
    
    token - the authorization token
    
    Returns:
    
    this HttpClient instance
  - withoutCertificateValidation
```
HttpClient withoutCertificateValidation()
```
    Turns off SSL certificate validation. This is useful if the SSL certificate of the host is not valid from any reason but we need to communicate with it with HTTPS protocol.
    
    Returns:
    
    this HttpClient instance
  - sendAndReceive
```
HttpResponse<String> sendAndReceive()
                             throws IOException,
                                    IllegalArgumentException
```
    Executes the HTTP request: sends the request and receives the response. It automatically transforms the response to a java string.
    
    Returns:
    
    the response as java string
    
    Throws:
    
    IOException - if the communication with the REST server failed
    
    IllegalArgumentException - if the response of the REST server was invalid

Interface HttpClient

Method Summary

Method Detail

url

url

method

mimeType

charset

charset

body

header

accept

authorization

basicAuthorization

bearerAuthorization

withoutCertificateValidation

sendAndReceive