HttpRequestConnector (Vault-API-Library 21.1.3 API)

java.lang.Object
- com.veeva.vault.vapil.connector.HttpRequestConnector

```
public class HttpRequestConnector
extends Object
```
HTTP request class, whether to the Vault API or other servers/APIs. This is a generic set of methods with no Vault specific information. It is used internally by VAPIL for all HTTP requests. It can also be used for integration specific HTTP calls (non-Vault).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpRequestConnector.BinaryFile` Handler for streaming a binary file in a multi-part request.
`static class`	`HttpRequestConnector.HttpMethod`
`static class`	`HttpRequestConnector.ParamType`
`static class`	`HttpRequestConnector.ResponseOption` Options for processing the HTTP response

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HTTP_CONTENT_TYPE_CSV`
`static String`	`HTTP_CONTENT_TYPE_JSON`
`static String`	`HTTP_CONTENT_TYPE_MULTIPART_FORM`
`static String`	`HTTP_CONTENT_TYPE_MULTIPART_FORM_BOUNDARY`
`static String`	`HTTP_CONTENT_TYPE_OCTET`
`static String`	`HTTP_CONTENT_TYPE_PLAINTEXT`
`static String`	`HTTP_CONTENT_TYPE_SCIM_JSON`
`static String`	`HTTP_CONTENT_TYPE_XFORM`
`static String`	`HTTP_HEADER_ACCEPT`
`static String`	`HTTP_HEADER_CONTENT_LENGTH`
`static String`	`HTTP_HEADER_CONTENT_MD5`
`static String`	`HTTP_HEADER_CONTENT_TYPE`
`static String`	`HTTP_HEADER_RANGE`

Constructor Summary

Constructors
Constructor and Description

HttpRequestConnector(String url)
Constructor for an HTTP request to a given URL

Constructors
Constructor and Description
`HttpRequestConnector(String url)` Constructor for an HTTP request to a given URL

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBinary(String mediaType, byte[] binaryContent)` Add a file in multipart/form-data request.
`void`	`addBodyParam(String name, Object value)` Add a body name/value pair to the request
`void`	`addBodyParamMultiPart(String name, Object value)` Add a body name/value pair to the request
`void`	`addFile(String mediaType, String filePath)` Add a file to the request, such as "--data-binary" POST request, in which the file is the only entity in the post request.
`void`	`addFileBinary(String name, byte[] binaryContent, String fileName)` Add a binary content of a file in multipart/form-data request.
`void`	`addFileMultiPart(String name, String filePath)` Add a file in multipart/form-data request.
`void`	`addHeaderParam(String name, Object value)` Add a header name/value pair to the request
`void`	`addQueryParam(String name, Object value)` Add a query name/value pair to the request
`void`	`addRawString(String mediaType, String rawString)` Add a string to the request, such as POST of raw data
`protected Map<String,Object>`	`encodeMap(Map<String,Object> map)` Encode the value in a map of name/value pairs
`Map<String,Object>`	`getBodyParams()`
`Map<String,Object>`	`getHeaderParams()`
`Map<String,Object>`	`getQueryParams()`
`String`	`getUrl()`
`protected String`	`getUrl(String url, Map<String,Object> queryParams)` Form a URL with request params.
`HttpResponseConnector`	`send(HttpRequestConnector.HttpMethod method)` Perform an HTTP call based on the class properties (url, queryParams, headerParams, bodyParams) for the provided HTTP Method.
`HttpResponseConnector`	`send(HttpRequestConnector.HttpMethod method, HttpRequestConnector.ResponseOption responseOption)` Perform an HTTP call based on the class properties (url, queryParams, headerParams, bodyParams) for the provided HTTP Method.
`HttpResponseConnector`	`send(HttpRequestConnector.HttpMethod method, HttpRequestConnector.ResponseOption responseOption, String outputFilePath)` Perform an HTTP call based on the class properties (url, queryParams, headerParams, bodyParams) for the provided HTTP Method.
`HttpResponseConnector`	`sendDelete()` Perform an HTTP DELETE
`HttpResponseConnector`	`sendGet()` Perform an HTTP GET with default response processing (as a string)
`HttpResponseConnector`	`sendGet(HttpRequestConnector.ResponseOption responseOption)` Perform an HTTP GET while specifying the response processing option
`HttpResponseConnector`	`sendGet(String outputFilePath)` Perform an HTTP GET and writing the response to the specified file.
`HttpResponseConnector`	`sendPost()` Perform an HTTP POST
`HttpResponseConnector`	`sendPut()` Perform an HTTP PUT
`void`	`setBodyParams(Map<String,Object> bodyParams)`
`static void`	`setGlobalTimeout(int minutes)` Set the global timeout for the HTTP Client.
`void`	`setHeaderParams(Map<String,Object> headerParams)`
`void`	`setQueryParams(Map<String,Object> queryParams)`
`void`	`setUrl(String url)`

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

- Field Detail
  - HTTP_HEADER_CONTENT_TYPE
```
public static final String HTTP_HEADER_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - HTTP_HEADER_ACCEPT
```
public static final String HTTP_HEADER_ACCEPT
```
    See Also:
    
    Constant Field Values
  - HTTP_HEADER_CONTENT_MD5
```
public static final String HTTP_HEADER_CONTENT_MD5
```
    See Also:
    
    Constant Field Values
  - HTTP_HEADER_RANGE
```
public static final String HTTP_HEADER_RANGE
```
    See Also:
    
    Constant Field Values
  - HTTP_HEADER_CONTENT_LENGTH
```
public static final String HTTP_HEADER_CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
  - HTTP_CONTENT_TYPE_CSV
```
public static final String HTTP_CONTENT_TYPE_CSV
```
    See Also:
    
    Constant Field Values
  - HTTP_CONTENT_TYPE_JSON
```
public static final String HTTP_CONTENT_TYPE_JSON
```
    See Also:
    
    Constant Field Values
  - HTTP_CONTENT_TYPE_SCIM_JSON
```
public static final String HTTP_CONTENT_TYPE_SCIM_JSON
```
    See Also:
    
    Constant Field Values
  - HTTP_CONTENT_TYPE_OCTET
```
public static final String HTTP_CONTENT_TYPE_OCTET
```
    See Also:
    
    Constant Field Values
  - HTTP_CONTENT_TYPE_PLAINTEXT
```
public static final String HTTP_CONTENT_TYPE_PLAINTEXT
```
    See Also:
    
    Constant Field Values
  - HTTP_CONTENT_TYPE_XFORM
```
public static final String HTTP_CONTENT_TYPE_XFORM
```
    See Also:
    
    Constant Field Values
  - HTTP_CONTENT_TYPE_MULTIPART_FORM
```
public static final String HTTP_CONTENT_TYPE_MULTIPART_FORM
```
    See Also:
    
    Constant Field Values
  - HTTP_CONTENT_TYPE_MULTIPART_FORM_BOUNDARY
```
public static final String HTTP_CONTENT_TYPE_MULTIPART_FORM_BOUNDARY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpRequestConnector
```
public HttpRequestConnector(String url)
```
    Constructor for an HTTP request to a given URL
    
    Parameters:
    
    url - Endpoint for the HTTP call
- Method Detail
  - send
```
public HttpResponseConnector send(HttpRequestConnector.HttpMethod method)
```
    Perform an HTTP call based on the class properties (url, queryParams, headerParams, bodyParams) for the provided HTTP Method. Responses are returned as a string.
    
    Parameters:
    
    method - The HttpMethod for the request (GET, POST, PUT, DELETE)
    
    Returns:
    
    The HTTP response from the request, returned as a string
  - send
```
public HttpResponseConnector send(HttpRequestConnector.HttpMethod method,
                                  HttpRequestConnector.ResponseOption responseOption)
```
    Perform an HTTP call based on the class properties (url, queryParams, headerParams, bodyParams) for the provided HTTP Method. Responses are returned based on the provided response option input.
    
    Parameters:
    
    method - The HttpMethod for the request (GET, POST, PUT, DELETE)
    
    responseOption - The format to return the HTTP response
    
    Returns:
    
    The HTTP response from the request, returned in format as specified by responseOption
  - send
```
public HttpResponseConnector send(HttpRequestConnector.HttpMethod method,
                                  HttpRequestConnector.ResponseOption responseOption,
                                  String outputFilePath)
```
    Perform an HTTP call based on the class properties (url, queryParams, headerParams, bodyParams) for the provided HTTP Method. Responses are returned based on the provided response option input. An output file is optionally written for streamed data.
    
    Parameters:
    
    method - The HttpMethod for the request (GET, POST, PUT, DELETE)
    
    responseOption - The format to return the HTTP response
    
    outputFilePath - Optional output file to write, pass null to ignore
    
    Returns:
    
    The HTTP response from the request, returned in format as specific by responseOption
  - sendGet
```
public HttpResponseConnector sendGet()
```
    Perform an HTTP GET with default response processing (as a string)
    
    Returns:
    
    The HTTP response from the request, returned as a string
  - sendGet
```
public HttpResponseConnector sendGet(HttpRequestConnector.ResponseOption responseOption)
```
    Perform an HTTP GET while specifying the response processing option
    
    Parameters:
    
    responseOption - Option for processing the response as string, inputstream, byte array, etc.
    
    Returns:
    
    The HTTP response from the request, returned in format as specified by responseOption
  - sendGet
```
public HttpResponseConnector sendGet(String outputFilePath)
```
    Perform an HTTP GET and writing the response to the specified file.
    
    Parameters:
    
    outputFilePath - The output file path to write to
    
    Returns:
    
    The HTTP response from the request
  - sendPost
```
public HttpResponseConnector sendPost()
```
    Perform an HTTP POST
    
    Returns:
    
    The HTTP response from the request
  - sendPut
```
public HttpResponseConnector sendPut()
```
    Perform an HTTP PUT
    
    Returns:
    
    The HTTP response from the request
  - sendDelete
```
public HttpResponseConnector sendDelete()
```
    Perform an HTTP DELETE
    
    Returns:
    
    The HTTP response from the request
  - getUrl
```
protected String getUrl(String url,
                        Map<String,Object> queryParams)
```
    Form a URL with request params. The request param values are encoding for sending.
    
    Parameters:
    
    url - Endpoint for the HTTP call
    
    queryParams - (Optional) Request parameters to add to the URL string. Pass null if none.
    
    Returns:
    
    Formed URL with request params
  - encodeMap
```
protected Map<String,Object> encodeMap(Map<String,Object> map)
```
    Encode the value in a map of name/value pairs
    
    Parameters:
    
    map - Name/Value pairs to encode
    
    Returns:
    
    Encoded map
  - getUrl
```
public String getUrl()
```
  - getQueryParams
```
public Map<String,Object> getQueryParams()
```
  - getHeaderParams
```
public Map<String,Object> getHeaderParams()
```
  - getBodyParams
```
public Map<String,Object> getBodyParams()
```
  - setUrl
```
public void setUrl(String url)
```
  - setQueryParams
```
public void setQueryParams(Map<String,Object> queryParams)
```
  - setHeaderParams
```
public void setHeaderParams(Map<String,Object> headerParams)
```
  - setBodyParams
```
public void setBodyParams(Map<String,Object> bodyParams)
```
  - addQueryParam
```
public void addQueryParam(String name,
                          Object value)
```
    Add a query name/value pair to the request
    
    Parameters:
    
    name - The parameter name
    
    value - The parameter value
  - addHeaderParam
```
public void addHeaderParam(String name,
                           Object value)
```
    Add a header name/value pair to the request
    
    Parameters:
    
    name - The parameter name
    
    value - The parameter value
  - addBodyParam
```
public void addBodyParam(String name,
                         Object value)
```
    Add a body name/value pair to the request
    
    Parameters:
    
    name - The body parameter name
    
    value - The body parameter value
  - addBodyParamMultiPart
```
public void addBodyParamMultiPart(String name,
                                  Object value)
```
    Add a body name/value pair to the request
    
    Parameters:
    
    name - The body parameter name
    
    value - The body parameter value
  - addFile
```
public void addFile(String mediaType,
                    String filePath)
```
    Add a file to the request, such as "--data-binary" POST request, in which the file is the only entity in the post request.
    
    Parameters:
    
    mediaType - The media type of the file
    
    filePath - Absolute file path of file to stream in the request
  - addRawString
```
public void addRawString(String mediaType,
                         String rawString)
```
    Add a string to the request, such as POST of raw data
    
    Parameters:
    
    mediaType - The media type of the raw string
    
    rawString - The data as a string
  - addBinary
```
public void addBinary(String mediaType,
                      byte[] binaryContent)
```
    Add a file in multipart/form-data request.
    
    Parameters:
    
    mediaType - The media type of the raw string
    
    binaryContent - Absolute file path of file to upload
  - addFileMultiPart
```
public void addFileMultiPart(String name,
                             String filePath)
```
    Add a file in multipart/form-data request.
    
    Parameters:
    
    name - The name of the body param in the multipart/form-data request
    
    filePath - Absolute file path of file to upload
  - addFileBinary
```
public void addFileBinary(String name,
                          byte[] binaryContent,
                          String fileName)
```
    Add a binary content of a file in multipart/form-data request.
    
    Parameters:
    
    name - The name of the body param in the multipart/form-data request
    
    binaryContent - Binary content of the file
    
    fileName - The name of the file for receiving server to create
  - setGlobalTimeout
```
public static void setGlobalTimeout(int minutes)
```
    Set the global timeout for the HTTP Client. Default = 60 minutes.
    
    Can only be set before any and all HTTP calls are first executed
    
    Parameters:
    
    minutes - Number of minutes before http timeout occurs

Class HttpRequestConnector

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HTTP_HEADER_CONTENT_TYPE

HTTP_HEADER_ACCEPT

HTTP_HEADER_CONTENT_MD5

HTTP_HEADER_RANGE

HTTP_HEADER_CONTENT_LENGTH

HTTP_CONTENT_TYPE_CSV

HTTP_CONTENT_TYPE_JSON

HTTP_CONTENT_TYPE_SCIM_JSON

HTTP_CONTENT_TYPE_OCTET

HTTP_CONTENT_TYPE_PLAINTEXT

HTTP_CONTENT_TYPE_XFORM

HTTP_CONTENT_TYPE_MULTIPART_FORM

HTTP_CONTENT_TYPE_MULTIPART_FORM_BOUNDARY

Constructor Detail

HttpRequestConnector

Method Detail

send

send

send

sendGet

sendGet

sendGet

sendPost

sendPut

sendDelete

getUrl

encodeMap

getUrl

getQueryParams

getHeaderParams

getBodyParams

setUrl

setQueryParams

setHeaderParams

setBodyParams

addQueryParam

addHeaderParam

addBodyParam

addBodyParamMultiPart

addFile

addRawString

addBinary

addFileMultiPart

addFileBinary

setGlobalTimeout