Package com.applitools.eyes

Class EyesRunner

java.lang.Object

com.applitools.eyes.EyesRunner

All Implemented Interfaces:

AutoCloseable

public abstract class EyesRunner
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	BASE_AGENT_ID	name of the client sdk
protected CommandExecutor	commandExecutor	command executor
protected static String[]	COMMANDS	list of commands sent to the server.
protected static AbstractSDKListener	listener	the universal server listener.
protected com.applitools.eyes.Logger	logger
protected Reference	managerRef	this reference has to be used in order to perform manager related actions (EyesManager.openEyes, EyesManager.closeAllEyes)
protected static String	PROTOCOL	the protocol to be used
protected static String	VERSION	version of the client sdk

Constructor Summary

Constructors

Constructor	Description
EyesRunner()	used for instantiating Classic Runner
EyesRunner(String baseAgentId, String version)	used for instantiating Classic Runner
EyesRunner(String baseAgentId, String version, AbstractSDKListener listener)
EyesRunner(String baseAgentId, String version, RunnerOptions runnerOptions)	used for instantiating VisualGrid Runner
EyesRunner(String baseAgentId, String version, RunnerOptions runnerOptions, AbstractSDKListener listener)	used for instantiating VisualGrid Runner
EyesRunner(String baseAgentId, String version, String protocol, String[] commands, AbstractSDKListener listener)	used for instantiating Classic Runner
EyesRunner(String baseAgentId, String version, String protocol, String[] commands, AbstractSDKListener listener, RunnerOptions runnerOptions)	used for instantiating VisualGrid Runner

Method Summary

Modifier and Type	Method	Description
void	close()
String	getAgentId()
TestResultsSummary	getAllTestResults()
TestResultsSummary	getAllTestResults(boolean shouldThrowException)
CommandExecutor	getCommandExecutor()	command executor
com.applitools.eyes.Logger	getLogger()
Reference	getManagerRef()	manager reference
com.applitools.eyes.AbstractProxySettings	getProxy()
protected Refer	getRefer()
Boolean	getRemoveDuplicateTests()
protected StaleElementReferenceException	getStaleElementException()
Boolean	isDontCloseBatches()
void	logSessionResultsAndThrowException(boolean throwEx, TestResults results)
protected void	runServer(String baseAgentId, String version)
protected void	runServer(String baseAgentId, String version, String protocol, String[] commands, AbstractSDKListener listener)
void	setCommandExecutor(CommandExecutor commandExecutor)
void	setDontCloseBatches(boolean dontCloseBatches)
void	setLogHandler(com.applitools.eyes.LogHandler logHandler)
void	setManagerRef(Reference managerRef)
void	setProxy(com.applitools.eyes.AbstractProxySettings proxySettings)
void	setRemoveDuplicateTests(Boolean removeDuplicateTests)

Methods inherited from class java.lang.Object

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

Field Detail

commandExecutor

protected CommandExecutor commandExecutor

command executor

managerRef

protected Reference managerRef

this reference has to be used in order to perform manager related actions (EyesManager.openEyes, EyesManager.closeAllEyes)

BASE_AGENT_ID

protected static String BASE_AGENT_ID

name of the client sdk

VERSION

protected static String VERSION

version of the client sdk

PROTOCOL

protected static String PROTOCOL

the protocol to be used

COMMANDS

protected static String[] COMMANDS

list of commands sent to the server.

listener

protected static AbstractSDKListener listener

the universal server listener.

logger

protected com.applitools.eyes.Logger logger

Constructor Detail

EyesRunner

public EyesRunner()

used for instantiating Classic Runner

EyesRunner

public EyesRunner(String baseAgentId,
                  String version)

used for instantiating Classic Runner

EyesRunner

public EyesRunner(String baseAgentId,
                  String version,
                  AbstractSDKListener listener)

EyesRunner

public EyesRunner(String baseAgentId,
                  String version,
                  RunnerOptions runnerOptions)

used for instantiating VisualGrid Runner

EyesRunner

public EyesRunner(String baseAgentId,
                  String version,
                  RunnerOptions runnerOptions,
                  AbstractSDKListener listener)

used for instantiating VisualGrid Runner

EyesRunner

public EyesRunner(String baseAgentId,
                  String version,
                  String protocol,
                  String[] commands,
                  AbstractSDKListener listener)

used for instantiating Classic Runner

EyesRunner

public EyesRunner(String baseAgentId,
                  String version,
                  String protocol,
                  String[] commands,
                  AbstractSDKListener listener,
                  RunnerOptions runnerOptions)

used for instantiating VisualGrid Runner

Method Detail

runServer

protected void runServer(String baseAgentId,
                         String version)

runServer

protected void runServer(String baseAgentId,
                         String version,
                         String protocol,
                         String[] commands,
                         AbstractSDKListener listener)

getAllTestResults

public TestResultsSummary getAllTestResults(boolean shouldThrowException)

setLogHandler

public void setLogHandler(com.applitools.eyes.LogHandler logHandler)

logSessionResultsAndThrowException

public void logSessionResultsAndThrowException(boolean throwEx,
                                               TestResults results)

getStaleElementException

protected StaleElementReferenceException getStaleElementException()

getAllTestResults

public TestResultsSummary getAllTestResults()

setDontCloseBatches

public void setDontCloseBatches(boolean dontCloseBatches)

isDontCloseBatches

public Boolean isDontCloseBatches()

setRemoveDuplicateTests

public void setRemoveDuplicateTests(Boolean removeDuplicateTests)

getRemoveDuplicateTests

public Boolean getRemoveDuplicateTests()

getLogger

public com.applitools.eyes.Logger getLogger()

setProxy

public void setProxy(com.applitools.eyes.AbstractProxySettings proxySettings)

getProxy

public com.applitools.eyes.AbstractProxySettings getProxy()

getAgentId

public String getAgentId()

getManagerRef

public Reference getManagerRef()

manager reference

setManagerRef

public void setManagerRef(Reference managerRef)

Parameters:

managerRef - The manager reference

getCommandExecutor

public CommandExecutor getCommandExecutor()

command executor

setCommandExecutor

public void setCommandExecutor(CommandExecutor commandExecutor)

Parameters:

commandExecutor - The command executor

getRefer

protected Refer getRefer()

close

public void close()

Specified by:

close in interface AutoCloseable