com.applitools.eyes

Class RestClient

java.lang.Object

com.applitools.eyes.RestClient

Direct Known Subclasses:

Jersey2xServerConnector

public class RestClient
extends Object

Provides common rest client functionality.

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.ws.rs.client.WebTarget	endPoint
protected com.fasterxml.jackson.databind.ObjectMapper	jsonMapper
protected Logger	logger
protected javax.ws.rs.client.Client	restClient
protected URI	serverUrl

Constructor Summary

Constructors

Constructor and Description
RestClient(Logger logger, URI serverUrl) Creates a rest client instance with timeout default of 5 minutes and no proxy settings.
RestClient(Logger logger, URI serverUrl, int timeout)

Method Summary

Modifier and Type	Method and Description
ProxySettings	getProxyBase()
protected String	getReadResponseError(String errMsg, int statusCode, String statusPhrase, String responseBody) Builds an error message which includes the response data.
protected URI	getServerUrlBase()
int	getTimeout()
protected <T> T	parseResponseWithJsonData(javax.ws.rs.core.Response response, List<Integer> validHttpStatusCodes, Class<T> resultType) Generic handling of response with data.
protected javax.ws.rs.core.Response	sendLongRequest(RestClient.HttpMethodCall method, String name)
void	setProxyBase(ProxySettings proxySettings) Sets the proxy settings to be used by the rest client.
protected void	setServerUrlBase(URI serverUrl) Sets the current server URL used by the rest client.
void	setTimeout(int timeout) Sets the connect and read timeouts for web requests.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Logger logger

restClient

protected javax.ws.rs.client.Client restClient

serverUrl

protected URI serverUrl

endPoint

protected javax.ws.rs.client.WebTarget endPoint

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.

timeout - Connect/Read timeout in milliseconds. 0 equals infinity.

RestClient

public RestClient(Logger logger,
                  URI serverUrl)

Creates a rest client instance with timeout default of 5 minutes and no proxy settings.

Parameters:

logger - A logger instance.

serverUrl - The URI of the rest server.

Method Detail

setProxyBase

public void setProxyBase(ProxySettings proxySettings)

Sets the proxy settings to be used by the rest client.

Parameters:

proxySettings - The proxy settings to be used by the rest client. If null then no proxy is set.

getProxyBase

public ProxySettings getProxyBase()

Returns:

The current proxy settings used by the rest client, or null if no proxy is set.

setTimeout

public void setTimeout(int timeout)

Sets the connect and read timeouts for web requests.

Parameters:

timeout - Connect/Read timeout in milliseconds. 0 equals infinity.

getTimeout

public int getTimeout()

Returns:

The timeout for web requests (in seconds).

setServerUrlBase

protected void setServerUrlBase(URI serverUrl)

Sets the current server URL used by the rest client.

Parameters:

serverUrl - The URI of the rest server.

getServerUrlBase

protected URI getServerUrlBase()

Returns:

The URI of the eyes server.

sendLongRequest

protected javax.ws.rs.core.Response sendLongRequest(RestClient.HttpMethodCall method,
                                                    String name)
                                             throws EyesException

Throws:

EyesException

getReadResponseError

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

Builds an error message which includes the response data.

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 data.

parseResponseWithJsonData

protected <T> T parseResponseWithJsonData(javax.ws.rs.core.Response response,
                                          List<Integer> validHttpStatusCodes,
                                          Class<T> resultType)
                                   throws EyesException

Generic handling of response with data. Response Handling includes the following: 1. Verify that we are able to read response data. 2. verify that the status code is valid 3. Parse the response data 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.