com.applitools.eyes

Class Jersey2xServerConnector

java.lang.Object

com.applitools.eyes.RestClient

com.applitools.eyes.Jersey2xServerConnector

All Implemented Interfaces:

ServerConnector

public class Jersey2xServerConnector
extends RestClient
implements ServerConnector

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

Modifier and Type	Field and Description
protected String	apiKey
protected String	sdkName

Fields inherited from class com.applitools.eyes.RestClient

endPoint, jsonMapper, logger, restClient, serverUrl

Constructor Summary

Constructors

Constructor and Description
Jersey2xServerConnector(Logger logger, String sdkName, URI serverUrl)

Method Summary

Modifier and Type	Method and Description
String	getApiKey()
ProxySettings	getProxy()
URI	getServerUrl()
MatchResult	matchWindow(RunningSession runningSession, MatchWindowData matchData) Matches the current window (held by the WebDriver) to the expected window.
void	setApiKey(String apiKey) Sets the API key of your applitools Eyes account.
void	setProxy(ProxySettings proxySettings) 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

getProxyBase, getReadResponseError, getServerUrlBase, getTimeout, parseResponseWithJsonData, sendLongRequest, 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.ServerConnector

getTimeout

Field Detail

sdkName

protected String sdkName

apiKey

protected String apiKey

Constructor Detail

Jersey2xServerConnector

public Jersey2xServerConnector(Logger logger,
                               String sdkName,
                               URI serverUrl)

Parameters:

logger - A logger instance.

sdkName - An identifier for the current agent. Can be any string.

serverUrl - The URI of the Eyes server.

Method Detail

setApiKey

public void setApiKey(String apiKey)

Sets the API key of your applitools Eyes account.

Specified by:

setApiKey in interface ServerConnector

Parameters:

apiKey - The api key to set.

getApiKey

public String getApiKey()

Specified by:

getApiKey in interface ServerConnector

Returns:

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

setProxy

public void setProxy(ProxySettings proxySettings)

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

Specified by:

setProxy in interface ServerConnector

Parameters:

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

getProxy

public ProxySettings getProxy()

Specified by:

getProxy in interface ServerConnector

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 ServerConnector

Parameters:

serverUrl - The URI of the rest server.

getServerUrl

public URI getServerUrl()

Specified by:

getServerUrl in interface ServerConnector

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 ServerConnector

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 ServerConnector

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.

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 ServerConnector

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.