com.applitools.connectivity

Class UfgConnector

java.lang.Object

com.applitools.connectivity.RestClient

com.applitools.connectivity.UfgConnector

public class UfgConnector
extends RestClient

Nested Class Summary

Nested classes/interfaces inherited from class com.applitools.connectivity.RestClient

RestClient.HttpMethodCall, RestClient.HttpRequestBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CLIENT_TIMEOUT
static String	EMULATED_DEVICES_PATH
static String	IOS_DEVICES_PATH
static int	MAX_CONNECTION_RETRIES
protected AtomicReference<RenderingInfo>	renderingInfo

Fields inherited from class com.applitools.connectivity.RestClient

agentId, jsonMapper, logger, restClient, serverUrl

Constructor Summary

Constructors

Constructor and Description
UfgConnector()
UfgConnector(com.applitools.eyes.Logger logger)
UfgConnector(com.applitools.eyes.Logger logger, URI serverUrl)
UfgConnector(com.applitools.eyes.Logger logger, URI serverUrl, int timeout)

Method Summary

Modifier and Type	Method and Description
void	checkResourceStatus(com.applitools.eyes.TaskListener<Boolean[]> listener, Set<String> testIds, String renderId, HashObject... hashes)
Future<?>	downloadResource(URI url, String userAgent, String refererUrl, Set<Cookie> cookies, com.applitools.eyes.TaskListener<RGridResource> listener)
Future<?>	downloadResource(URI url, String userAgent, String refererUrl, Set<Cookie> cookies, com.applitools.eyes.TaskListener<RGridResource> listener, int attemptNumber, boolean shouldSendReferer)
String	getApiKey()
Map<String,DeviceSize>	getDevicesSizes(String path)
<T> T	getFromServer(RestClient.HttpRequestBuilder builder, com.fasterxml.jackson.core.type.TypeReference<T> typeReference) Sends a synchronous HTTP GET Request to the server and returns the typed response
<T> T	getFromUrl(String url, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
void	getJobInfo(com.applitools.eyes.TaskListener<JobInfo[]> listener, RenderRequest[] browserInfos)
RenderingInfo	getRenderInfo()
Map<String,String>	getUserAgents()
void	render(com.applitools.eyes.TaskListener<List<RunningRender>> listener, List<RenderRequest> renderRequests)
Future<?>	renderPutResource(Set<String> testIds, String renderID, RGridResource resource, com.applitools.eyes.TaskListener<Void> listener)
Future<?>	renderPutResource(Set<String> testIds, String renderId, RGridResource resource, com.applitools.eyes.TaskListener<Void> listener, int attemptNumber)
void	renderStatusById(com.applitools.eyes.TaskListener<List<RenderStatusResults>> listener, List<String> testIds, List<String> renderIds)
void	sendAsyncRequest(com.applitools.connectivity.api.AsyncRequestCallback callback, String url, String method, String... accept)
void	setApiKey(String apiKey) Sets the API key of your applitools Eyes account.
void	setRenderingInfo(RenderingInfo renderInfo)
boolean	wasApiKeySet()

Methods inherited from class com.applitools.connectivity.RestClient

downloadFile, getAgentId, getLogger, getProxy, getReadResponseError, getServerUrlBase, getTimeout, initClient, makeEyesRequest, parseResponseWithJsonData, sendAsyncRequest, sendAsyncRequest, sendAsyncRequest, sendHttpRequest, sendHttpRequest, sendHttpRequest, sendLongRequest, setAgentId, setLogger, setProxy, setServerUrlBase, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLIENT_TIMEOUT

public static final int DEFAULT_CLIENT_TIMEOUT

See Also:

Constant Field Values

MAX_CONNECTION_RETRIES

public static final int MAX_CONNECTION_RETRIES

See Also:

Constant Field Values

IOS_DEVICES_PATH

public static final String IOS_DEVICES_PATH

See Also:

Constant Field Values

EMULATED_DEVICES_PATH

public static final String EMULATED_DEVICES_PATH

See Also:

Constant Field Values

renderingInfo

protected final AtomicReference<RenderingInfo> renderingInfo

Constructor Detail

UfgConnector

public UfgConnector(com.applitools.eyes.Logger logger,
                    URI serverUrl,
                    int timeout)

UfgConnector

public UfgConnector(com.applitools.eyes.Logger logger,
                    URI serverUrl)

UfgConnector

public UfgConnector(com.applitools.eyes.Logger logger)

UfgConnector

public UfgConnector()

Method Detail

setApiKey

public void setApiKey(String apiKey)

Sets the API key of your applitools Eyes account.

Parameters:

apiKey - The api key to set.

getApiKey

public String getApiKey()

Returns:

The currently set API key or null if no key is set.

wasApiKeySet

public boolean wasApiKeySet()

sendAsyncRequest

public void sendAsyncRequest(com.applitools.connectivity.api.AsyncRequestCallback callback,
                             String url,
                             String method,
                             String... accept)

Overrides:

sendAsyncRequest in class RestClient

setRenderingInfo

public void setRenderingInfo(RenderingInfo renderInfo)

getFromServer

public <T> T getFromServer(RestClient.HttpRequestBuilder builder,
                           com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

Sends a synchronous HTTP GET Request to the server and returns the typed response

Type Parameters:

T - The type of the returned value

Parameters:

builder - Builder for creating the request

typeReference - The type of the returned value

Returns:

The parsed response

getRenderInfo

public RenderingInfo getRenderInfo()

getDevicesSizes

public Map<String,DeviceSize> getDevicesSizes(String path)

getUserAgents

public Map<String,String> getUserAgents()

getFromUrl

public <T> T getFromUrl(String url,
                        com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

downloadResource

public Future<?> downloadResource(URI url,
                                  String userAgent,
                                  String refererUrl,
                                  Set<Cookie> cookies,
                                  com.applitools.eyes.TaskListener<RGridResource> listener)

downloadResource

public Future<?> downloadResource(URI url,
                                  String userAgent,
                                  String refererUrl,
                                  Set<Cookie> cookies,
                                  com.applitools.eyes.TaskListener<RGridResource> listener,
                                  int attemptNumber,
                                  boolean shouldSendReferer)

renderPutResource

public Future<?> renderPutResource(Set<String> testIds,
                                   String renderID,
                                   RGridResource resource,
                                   com.applitools.eyes.TaskListener<Void> listener)

renderPutResource

public Future<?> renderPutResource(Set<String> testIds,
                                   String renderId,
                                   RGridResource resource,
                                   com.applitools.eyes.TaskListener<Void> listener,
                                   int attemptNumber)

render

public void render(com.applitools.eyes.TaskListener<List<RunningRender>> listener,
                   List<RenderRequest> renderRequests)

renderStatusById

public void renderStatusById(com.applitools.eyes.TaskListener<List<RenderStatusResults>> listener,
                             List<String> testIds,
                             List<String> renderIds)

checkResourceStatus

public void checkResourceStatus(com.applitools.eyes.TaskListener<Boolean[]> listener,
                                Set<String> testIds,
                                String renderId,
                                HashObject... hashes)

getJobInfo

public void getJobInfo(com.applitools.eyes.TaskListener<JobInfo[]> listener,
                       RenderRequest[] browserInfos)