com.applitools.eyes

Class ServerConnector

java.lang.Object

com.applitools.eyes.RestClient

com.applitools.eyes.ServerConnector

All Implemented Interfaces:

IServerConnector

public class ServerConnector
extends RestClient
implements IServerConnector

Provides an API for communication with the Applitools agent

Nested Class Summary

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

RestClient.HttpMethodCall

Field Summary

Fields inherited from class com.applitools.eyes.RestClient

endPoint, jsonMapper, logger, restClient, serverUrl

Constructor Summary

Constructors

Constructor and Description
ServerConnector()
ServerConnector(Logger logger)
ServerConnector(Logger logger, URI serverUrl)
ServerConnector(URI serverUrl)

Method Summary

Modifier and Type	Method and Description
void	deleteSession(TestResults testResults)
void	downloadString(URL uri, boolean isSecondRetry, IDownloadListener listener)
String	getApiKey()
AbstractProxySettings	getProxy()
URI	getServerUrl()
MatchResult	matchWindow(RunningSession runningSession, MatchWindowData matchData) Matches the current window (held by the WebDriver) to the expected window.
String	postDomSnapshot(String domJson)
void	setApiKey(String apiKey) Sets the API key of your applitools Eyes account.
void	setProxy(AbstractProxySettings abstractProxySettings) Sets the proxy settings to be used by the rest client.
void	setServerUrl(URI serverUrl) Sets the current server URL used by the rest client.
RunningSession	startSession(SessionStartInfo sessionStartInfo) Starts a new running session in the agent.
TestResults	stopSession(RunningSession runningSession, boolean isAborted, boolean save) Stops the running session.

Methods inherited from class com.applitools.eyes.RestClient

getLogger, getProxyBase, getReadResponseError, getServerUrlBase, getTimeout, parseResponseWithJsonData, sendLongRequest, setLogger, setProxyBase, setServerUrlBase, setTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.applitools.eyes.IServerConnector

getLogger, getTimeout, setLogger

Constructor Detail

ServerConnector

public ServerConnector(Logger logger,
                       URI serverUrl)

Parameters:

logger - A logger instance.

serverUrl - The URI of the Eyes server.

ServerConnector

public ServerConnector(Logger logger)

Parameters:

logger - A logger instance.

ServerConnector

public ServerConnector(URI serverUrl)

Parameters:

serverUrl - The URI of the Eyes server.

ServerConnector

public ServerConnector()

Method Detail

setApiKey

public void setApiKey(String apiKey)

Sets the API key of your applitools Eyes account.

Specified by:

setApiKey in interface IServerConnector

Parameters:

apiKey - The api key to set.

getApiKey

public String getApiKey()

Specified by:

getApiKey in interface IServerConnector

Returns:

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

setProxy

public void setProxy(AbstractProxySettings abstractProxySettings)

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

Specified by:

setProxy in interface IServerConnector

Parameters:

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

getProxy

public AbstractProxySettings getProxy()

Specified by:

getProxy in interface IServerConnector

Returns:

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

setServerUrl

public void setServerUrl(URI serverUrl)

Sets the current server URL used by the rest client.

Specified by:

setServerUrl in interface IServerConnector

Parameters:

serverUrl - The URI of the rest server.

getServerUrl

public URI getServerUrl()

Specified by:

getServerUrl in interface IServerConnector

Returns:

The URI of the eyes server.

startSession

public RunningSession startSession(SessionStartInfo sessionStartInfo)
                            throws EyesException

Starts a new running session in the agent. Based on the given parameters, this running session will either be linked to an existing session, or to a completely new session.

Specified by:

startSession in interface IServerConnector

Parameters:

sessionStartInfo - The start parameters for the session.

Returns:

RunningSession object which represents the current running session

Throws:

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

stopSession

public TestResults stopSession(RunningSession runningSession,
                               boolean isAborted,
                               boolean save)
                        throws EyesException

Stops the running session.

Specified by:

stopSession in interface IServerConnector

Parameters:

runningSession - The running session to be stopped.

Returns:

TestResults object for the stopped running session

Throws:

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

deleteSession

public void deleteSession(TestResults testResults)

Specified by:

deleteSession in interface IServerConnector

matchWindow

public MatchResult matchWindow(RunningSession runningSession,
                               MatchWindowData matchData)
                        throws EyesException

Matches the current window (held by the WebDriver) to the expected window.

Specified by:

matchWindow in interface IServerConnector

Parameters:

runningSession - The current agent's running session.

matchData - Encapsulation of a capture taken from the application.

Returns:

The results of the window matching.

Throws:

EyesException - For invalid status codes, or response parsing failed.

downloadString

public void downloadString(URL uri,
                           boolean isSecondRetry,
                           IDownloadListener listener)

Specified by:

downloadString in interface IServerConnector

postDomSnapshot

public String postDomSnapshot(String domJson)

Specified by:

postDomSnapshot in interface IServerConnector