com.applitools.connectivity

Class RestClient

java.lang.Object

com.applitools.connectivity.RestClient

public class RestClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	RestClient.HttpMethodCall An interface used as base for anonymous classes wrapping Http Method calls.
protected static interface	RestClient.HttpRequestBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected String	agentId
protected com.fasterxml.jackson.databind.ObjectMapper	jsonMapper
protected Logger	logger
protected HttpClient	restClient
protected URI	serverUrl

Constructor Summary

Constructors

Constructor and Description
RestClient(Logger logger, URI serverUrl, int timeout)

Method Summary

Modifier and Type	Method and Description
protected byte[]	downloadFile(Response response)
String	getAgentId()
Logger	getLogger()
AbstractProxySettings	getProxy()
protected String	getReadResponseError(String errMsg, int statusCode, String statusPhrase, String responseBody) Builds an error message which includes the response model.
protected URI	getServerUrlBase()
int	getTimeout()
protected void	initClient()
protected AsyncRequest	makeEyesRequest(RestClient.HttpRequestBuilder builder)
protected <T> T	parseResponseWithJsonData(Response response, List<Integer> validHttpStatusCodes, com.fasterxml.jackson.core.type.TypeReference<T> resultType) Generic handling of response with model.
void	sendAsyncRequest(AsyncRequestCallback callback, String url, String method, Map<String,String> queryParams, String... accept)
void	sendAsyncRequest(AsyncRequestCallback callback, String url, String method, String... accept)
void	sendAsyncRequest(AsyncRequest request, String method, AsyncRequestCallback callback)
void	sendAsyncRequest(AsyncRequest request, String method, AsyncRequestCallback callback, Object data, String contentType)
Response	sendHttpRequest(String url, String method, Map<String,String> queryParams, String... accept)
Response	sendHttpRequest(String url, String method, Object data, String contentType, String... accept)
Response	sendHttpRequest(String url, String method, String... accept) Send a synchronous request to the server
protected void	sendLongRequest(AsyncRequest request, String method, AsyncRequestCallback callback, String data, String mediaType)
void	setAgentId(String agentId)
void	setLogger(Logger logger)
void	setProxy(AbstractProxySettings proxySettings)
protected void	setServerUrlBase(URI serverUrl)
void	setTimeout(int timeout)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected Logger logger

restClient

protected HttpClient restClient

serverUrl

protected URI serverUrl

agentId

protected String agentId

jsonMapper

protected com.fasterxml.jackson.databind.ObjectMapper jsonMapper

Constructor Detail

RestClient

public RestClient(Logger logger,
                  URI serverUrl,
                  int timeout)

Parameters:

logger - Logger instance.

serverUrl - The URI of the rest server.

Method Detail

setLogger

public void setLogger(Logger logger)

getLogger

public Logger getLogger()

setProxy

public void setProxy(AbstractProxySettings proxySettings)

getProxy

public AbstractProxySettings getProxy()

setTimeout

public void setTimeout(int timeout)

getTimeout

public int getTimeout()

setServerUrlBase

protected void setServerUrlBase(URI serverUrl)

getServerUrlBase

protected URI getServerUrlBase()

setAgentId

public void setAgentId(String agentId)

getAgentId

public String getAgentId()

initClient

protected void initClient()

sendAsyncRequest

public void sendAsyncRequest(AsyncRequestCallback callback,
                             String url,
                             String method,
                             String... accept)

sendAsyncRequest

public void sendAsyncRequest(AsyncRequestCallback callback,
                             String url,
                             String method,
                             Map<String,String> queryParams,
                             String... accept)

sendAsyncRequest

public void sendAsyncRequest(AsyncRequest request,
                             String method,
                             AsyncRequestCallback callback)

sendAsyncRequest

public void sendAsyncRequest(AsyncRequest request,
                             String method,
                             AsyncRequestCallback callback,
                             Object data,
                             String contentType)

makeEyesRequest

protected AsyncRequest makeEyesRequest(RestClient.HttpRequestBuilder builder)

sendHttpRequest

public Response sendHttpRequest(String url,
                                String method,
                                String... accept)

Send a synchronous request to the server

sendHttpRequest

public Response sendHttpRequest(String url,
                                String method,
                                Map<String,String> queryParams,
                                String... accept)

sendHttpRequest

public Response sendHttpRequest(String url,
                                String method,
                                Object data,
                                String contentType,
                                String... accept)

sendLongRequest

protected void sendLongRequest(AsyncRequest request,
                               String method,
                               AsyncRequestCallback callback,
                               String data,
                               String mediaType)
                        throws EyesException

Throws:

EyesException

getReadResponseError

protected String getReadResponseError(String errMsg,
                                      int statusCode,
                                      String statusPhrase,
                                      String responseBody)

Builds an error message which includes the response model.

Parameters:

errMsg - The error message.

statusCode - The response status code.

statusPhrase - The response status phrase.

responseBody - The response body.

Returns:

An error message which includes the response model.

parseResponseWithJsonData

protected <T> T parseResponseWithJsonData(Response response,
                                          List<Integer> validHttpStatusCodes,
                                          com.fasterxml.jackson.core.type.TypeReference<T> resultType)
                                   throws EyesException

Generic handling of response with model. Response Handling includes the following: 1. Verify that we are able to read response model. 2. verify that the status code is valid 3. Parse the response model from JSON to the relevant type.

Type Parameters:

T - The return value type.

Parameters:

response - The response to parse.

validHttpStatusCodes - The list of acceptable status codes.

resultType - The class object of the type of result this response should be parsed to.

Returns:

The parse response of the type given in resultType.

Throws:

EyesException - For invalid status codes or if the response parsing failed.

downloadFile

protected byte[] downloadFile(Response response)