HttpClient (HelloSign Java SDK 4.0.12 API)

java.lang.Object
- com.hellosign.sdk.http.HttpClient

```
public class HttpClient
extends Object
```
Abstracts HTTP requests.

Author:

cpaul

Constructor Summary

Constructors
Constructor and Description

HttpClient()

Constructors
Constructor and Description
`HttpClient()`

Method Summary

Methods
Modifier and Type	Method and Description
`File`	`asFile(String fileName)` Executes the request and returns the response as a File.
`int`	`asHttpCode()` Executes the request and returns the HTTP response code.
`org.json.JSONObject`	`asJson()` Executes the request and returns the response as a JSONObject.
`HttpClient`	`delete(String url)` Initializes a DELETE request to the given URL.
`HttpClient`	`get(String url)` Initializes a GET request to the given URL.
`String`	`getLastResponse()` Returns the response to the last HTTP request as a string.
`long`	`getLastResponseAsFile(File f)` Returns the last HTTP request body as a file.
`Integer`	`getLastResponseCode()` Returns the HTTP status code for the last request.
`HttpClient`	`options(String url)` Makes an OPTIONS request to the given URL
`HttpClient`	`post(String url)` Initializes a POST request to the given URL.
`HttpClient`	`put(String url)` Makes a PUT request to the given URL
`HttpClient`	`withAuth(Authentication auth)`
`HttpClient`	`withGetParam(String key, String value)`
`HttpClient`	`withGetParams(Map<String,String> params)`
`HttpClient`	`withPostField(String key, Serializable value)`
`HttpClient`	`withPostFields(Map<String,Serializable> fields)`

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

- Constructor Detail
  - HttpClient
```
public HttpClient()
```
- Method Detail
  - withAuth
```
public HttpClient withAuth(Authentication auth)
```
  - withGetParam
```
public HttpClient withGetParam(String key,
                      String value)
```
  - withGetParams
```
public HttpClient withGetParams(Map<String,String> params)
```
  - withPostField
```
public HttpClient withPostField(String key,
                       Serializable value)
```
  - withPostFields
```
public HttpClient withPostFields(Map<String,Serializable> fields)
```
  - getLastResponse
```
public String getLastResponse()
```
    Returns the response to the last HTTP request as a string.
    
    Returns:
    String or null if the request has not been created
  - getLastResponseCode
```
public Integer getLastResponseCode()
```
    Returns the HTTP status code for the last request.
    
    Returns:
    Integer or null if the request has not been created
  - getLastResponseAsFile
```
public long getLastResponseAsFile(File f)
                           throws HelloSignException
```
    Returns the last HTTP request body as a file.
    
    Parameters:
    f - File that should contain the response
    
    Returns:
    long bytes written
    
    Throws:
    
    HelloSignException - thrown if there is a problem writing to the file or reading the response stream
  - asJson
```
public org.json.JSONObject asJson()
                           throws HelloSignException
```
    Executes the request and returns the response as a JSONObject.
    
    Returns:
    JSONObject response
    
    Throws:
    
    HelloSignException - thrown if there is a problem executing the request
  - asFile
```
public File asFile(String fileName)
            throws HelloSignException
```
    Executes the request and returns the response as a File.
    
    Parameters:
    fileName - String name of destination file
    
    Returns:
    File response
    
    Throws:
    
    HelloSignException - thrown if there is a problem executing the request
  - asHttpCode
```
public int asHttpCode()
               throws HelloSignException
```
    Executes the request and returns the HTTP response code.
    
    Returns:
    int HTTP response code
    
    Throws:
    
    HelloSignException - thrown if no request has been performed
  - get
```
public HttpClient get(String url)
               throws HelloSignException
```
    Initializes a GET request to the given URL.
    
    Parameters:
    url - String url
    
    Returns:
    HttpClient
    
    Throws:
    
    HelloSignException - thrown if the url is invalid
  - post
```
public HttpClient post(String url)
                throws HelloSignException
```
    Initializes a POST request to the given URL.
    
    Parameters:
    url - String url
    
    Returns:
    HttpClient
    
    Throws:
    
    HelloSignException - thrown if the url is invalid
  - delete
```
public HttpClient delete(String url)
                  throws HelloSignException
```
    Initializes a DELETE request to the given URL.
    
    Parameters:
    url - String url
    
    Returns:
    HttpClient
    
    Throws:
    
    HelloSignException - thrown if the url is invalid
  - put
```
public HttpClient put(String url)
               throws HelloSignException
```
    Makes a PUT request to the given URL
    
    Parameters:
    url - String url
    
    Returns:
    HttpClient
    
    Throws:
    
    HelloSignException - thrown if the url is invalid
  - options
```
public HttpClient options(String url)
                   throws HelloSignException
```
    Makes an OPTIONS request to the given URL
    
    Parameters:
    url - String URL
    
    Returns:
    HttpClient
    
    Throws:
    
    HelloSignException - thrown if the URL is invalid

Class HttpClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpClient

Method Detail

withAuth

withGetParam

withGetParams

withPostField

withPostFields

getLastResponse

getLastResponseCode

getLastResponseAsFile

asJson

asFile

asHttpCode

get

post

delete

put

options