EyesBase (eyes-sdk-core-java3 3.9 API)

java.lang.Object
- com.applitools.eyes.EyesBase

public abstract class EyesBase
extends Object

Applitools Eyes Base for Java API .

Field Summary

Fields
Modifier and Type	Field and Description
`protected PropertyHandler<CutProvider>`	`cutProviderHandler`
`protected DebugScreenshotsProvider`	`debugScreenshotsProvider`
`protected EyesScreenshot`	`lastScreenshot`
`protected Logger`	`logger`
`protected PositionProvider`	`positionProvider`
`protected RunningSession`	`runningSession`
`protected PropertyHandler<ScaleProvider>`	`scaleProviderHandler`
`protected ServerConnector`	`serverConnector`
`protected SessionStartInfo`	`sessionStartInfo`
`protected static int`	`USE_DEFAULT_TIMEOUT`
`protected RectangleSize`	`viewportSize`

Constructor Summary

Constructors
Constructor and Description

EyesBase(URI serverUrl)
Creates a new EyesBaseinstance that interacts with the Eyes Server at the specified url.

Constructors
Constructor and Description
`EyesBase(URI serverUrl)` Creates a new `EyesBase`instance that interacts with the Eyes Server at the specified url.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abortIfNotClosed()` If a test is running, aborts it.
`protected void`	`addMouseTriggerBase(MouseAction action, Region control, Location cursor)` Adds a mouse trigger.
`protected void`	`addTextTriggerBase(Region control, String text)` Adds a text trigger.
`protected void`	`addUserInput(Trigger trigger)` Adds a trigger to the current list of user inputs.
`protected MatchResult`	`checkWindowBase(RegionProvider regionProvider, String tag, boolean ignoreMismatch)`
`protected MatchResult`	`checkWindowBase(RegionProvider regionProvider, String tag, boolean ignoreMismatch, int retryTimeout)` Takes a snapshot of the application under test and matches it with the expected output.
`protected void`	`clearUserInputs()` Clears the user inputs list.
`TestResults`	`close()` See `close(boolean)`.
`TestResults`	`close(boolean throwEx)` Ends the test.
`protected void`	`closeResponseTime(boolean isDeadlineExceeded)` Ends the test.
`String`	`getAgentId()`
`String`	`getApiKey()`
`protected AppEnvironment`	`getAppEnvironment()` Application environment is the environment (e.g., the host OS) which runs the application under test.
`String`	`getAppName()`
`protected abstract String`	`getBaseAgentId()`
`String`	`getBaselineEnvName()` If not `null`, determines the name of the environment of the baseline.
`String`	`getBaselineName()` Deprecated. Only available for backward compatibility. See `getBaselineEnvName()`.
`BatchInfo`	`getBatch()`
`String`	`getBranchName()`
`String`	`getDebugScreenshotsPath()`
`String`	`getDebugScreenshotsPrefix()`
`ImageMatchSettings`	`getDefaultMatchSettings()`
`static URI`	`getDefaultServerUrl()`
`String`	`getEnvName()` If not `null` specifies a name for the environment in which the application under test is running.
`FailureReports`	`getFailureReports()`
`protected String`	`getFullAgentId()`
`String`	`getHostApp()`
`String`	`getHostOS()`
`protected abstract String`	`getInferredEnvironment()`
`boolean`	`getIsDisabled()`
`boolean`	`getIsOpen()`
`LogHandler`	`getLogHandler()`
`MatchLevel`	`getMatchLevel()` Deprecated. Please use`getDefaultMatchSettings()` instead.
`int`	`getMatchTimeout()`
`String`	`getParentBranchName()`
`protected PositionProvider`	`getPositionProvider()`
`ProxySettings`	`getProxy()`
`boolean`	`getSaveDebugScreenshots()`
`boolean`	`getSaveFailedTests()`
`boolean`	`getSaveNewTests()`
`double`	`getScaleRatio()`
`protected abstract EyesScreenshot`	`getScreenshot()`
`URI`	`getServerUrl()`
`protected abstract String`	`getTitle()`
`protected Trigger[]`	`getUserInputs()`
`protected abstract RectangleSize`	`getViewportSize()`
`void`	`openBase(String appName, String testName, RectangleSize viewportSize, SessionType sessionType)` Starts a test.
`void`	`setAgentId(String agentId)`
`void`	`setApiKey(String apiKey)` Sets the API key of your applitools Eyes account.
`void`	`setAppEnvironment(String hostOS, String hostApp)` Deprecated.
`void`	`setAppName(String appName)`
`void`	`setBaselineEnvName(String baselineEnvName)` If not `null`, determines the name of the environment of the baseline.
`void`	`setBaselineName(String baselineName)` Deprecated. Only available for backward compatibility. See `setBaselineEnvName(String)`.
`void`	`setBatch(BatchInfo batch)` Sets the batch in which context future tests will run or `null` if tests are to run standalone.
`void`	`setBranchName(String branchName)` Sets the branch in which the baseline for subsequent test runs resides.
`void`	`setDebugScreenshotsPath(String pathToSave)`
`void`	`setDebugScreenshotsPrefix(String prefix)`
`void`	`setDefaultMatchSettings(ImageMatchSettings defaultMatchSettings)`
`void`	`setEnvName(String envName)` If not `null` specifies a name for the environment in which the application under test is running.
`void`	`setFailureReports(FailureReports failureReports)`
`void`	`setHostApp(String hostApp)`
`void`	`setHostOS(String hostOS)`
`void`	`setImageCut(CutProvider cutProvider)`
`void`	`setIsDisabled(boolean isDisabled)`
`void`	`setLogHandler(LogHandler logHandler)` Sets a handler of log messages generated by this API.
`void`	`setMatchLevel(MatchLevel matchLevel)` This function is deprecated.
`void`	`setMatchTimeout(int ms)` Sets the maximum time (in ms) a match operation tries to perform a match.
`void`	`setParentBranchName(String branchName)` Sets the branch under which new branches are created.
`protected void`	`setPositionProvider(PositionProvider positionProvider)`
`void`	`setProxy(ProxySettings proxySettings)` Sets the proxy settings to be used by the rest client.
`void`	`setSaveDebugScreenshots(boolean saveDebugScreenshots)`
`void`	`setSaveFailedTests(boolean saveFailedTests)` Set whether or not failed tests are saved by default.
`void`	`setSaveNewTests(boolean saveNewTests)` Set whether or not new tests are saved by default.
`void`	`setScaleRatio(Double scaleRatio)`
`void`	`setServerUrl(URI serverUrl)` Sets the current server URL used by the rest client.
`protected abstract void`	`setViewportSize(RectangleSize size)`
`protected void`	`startSession()` Start eyes session on the eyes server.
`protected MatchWindowDataWithScreenshot`	`testResponseTimeBase(RegionProvider regionProvider, Runnable action, int deadline, int timeout, long matchInterval)` Runs a timing test.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USE_DEFAULT_TIMEOUT
```
protected static final int USE_DEFAULT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - serverConnector
```
protected ServerConnector serverConnector
```
  - runningSession
```
protected RunningSession runningSession
```
  - sessionStartInfo
```
protected SessionStartInfo sessionStartInfo
```
  - viewportSize
```
protected RectangleSize viewportSize
```
  - lastScreenshot
```
protected EyesScreenshot lastScreenshot
```
  - scaleProviderHandler
```
protected PropertyHandler<ScaleProvider> scaleProviderHandler
```
  - cutProviderHandler
```
protected PropertyHandler<CutProvider> cutProviderHandler
```
  - positionProvider
```
protected PositionProvider positionProvider
```
  - logger
```
protected Logger logger
```
  - debugScreenshotsProvider
```
protected DebugScreenshotsProvider debugScreenshotsProvider
```
- Constructor Detail
  - EyesBase
```
public EyesBase(URI serverUrl)
```
    Creates a new EyesBaseinstance that interacts with the Eyes Server at the specified url.
    
    Parameters:
    
    serverUrl - The Eyes server URL.
- Method Detail
  - setAgentId
```
public void setAgentId(String agentId)
```
  - getAgentId
```
public String getAgentId()
```
    Returns:
    
    The user given agent id of the SDK.
  - 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.
  - setServerUrl
```
public void setServerUrl(URI serverUrl)
```
    Sets the current server URL used by the rest client.
    
    Parameters:
    
    serverUrl - The URI of the rest server, or null to use the default server.
  - getServerUrl
```
public URI getServerUrl()
```
    Returns:
    
    The URI of the eyes server.
  - setProxy
```
public void setProxy(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.
  - getProxy
```
public ProxySettings getProxy()
```
    Returns:
    
    The current proxy settings used by the server connector, or null if no proxy is set.
  - setIsDisabled
```
public void setIsDisabled(boolean isDisabled)
```
    Parameters:
    
    isDisabled - If true, all interactions with this API will be silently ignored.
  - getIsDisabled
```
public boolean getIsDisabled()
```
    Returns:
    
    Whether eyes is disabled.
  - setAppName
```
public void setAppName(String appName)
```
  - getAppName
```
public String getAppName()
```
  - setBranchName
```
public void setBranchName(String branchName)
```
    Sets the branch in which the baseline for subsequent test runs resides. If the branch does not already exist it will be created under the specified parent branch (see setParentBranchName(java.lang.String)). Changes to the baseline or model of a branch do not propagate to other branches.
    
    Parameters:
    
    branchName - Branch name or null to specify the default branch.
  - getBranchName
```
public String getBranchName()
```
    Returns:
    
    The current branch (see setBranchName(String)).
  - setParentBranchName
```
public void setParentBranchName(String branchName)
```
    Sets the branch under which new branches are created. (see setBranchName(String).
    
    Parameters:
    
    branchName - Branch name or null to specify the default branch.
  - getParentBranchName
```
public String getParentBranchName()
```
    Returns:
    
    The name of the current parent branch under which new branches will be created. (see setParentBranchName(String)).
  - clearUserInputs
```
protected void clearUserInputs()
```
    Clears the user inputs list.
  - getUserInputs
```
protected Trigger[] getUserInputs()
```
    Returns:
    
    User inputs collected between checkWindowBase invocations.
  - setMatchTimeout
```
public void setMatchTimeout(int ms)
```
    Sets the maximum time (in ms) a match operation tries to perform a match.
    
    Parameters:
    
    ms - Total number of ms to wait for a match.
  - getMatchTimeout
```
public int getMatchTimeout()
```
    Returns:
    
    The maximum time in ms (RegionProvider, String, boolean, int) waits for a match.
  - setSaveNewTests
```
public void setSaveNewTests(boolean saveNewTests)
```
    Set whether or not new tests are saved by default.
    
    Parameters:
    
    saveNewTests - True if new tests should be saved by default. False otherwise.
  - getSaveNewTests
```
public boolean getSaveNewTests()
```
    Returns:
    
    True if new tests are saved by default.
  - setSaveFailedTests
```
public void setSaveFailedTests(boolean saveFailedTests)
```
    Set whether or not failed tests are saved by default.
    
    Parameters:
    
    saveFailedTests - True if failed tests should be saved by default, false otherwise.
  - getSaveFailedTests
```
public boolean getSaveFailedTests()
```
    Returns:
    
    True if failed tests are saved by default.
  - setBatch
```
public void setBatch(BatchInfo batch)
```
    Sets the batch in which context future tests will run or null if tests are to run standalone.
    
    Parameters:
    
    batch - The batch info to set.
  - getBatch
```
public BatchInfo getBatch()
```
    Returns:
    
    The currently set batch info.
  - setFailureReports
```
public void setFailureReports(FailureReports failureReports)
```
    Parameters:
    
    failureReports - The failure reports setting.
    
    See Also:
    
    FailureReports
  - getFailureReports
```
public FailureReports getFailureReports()
```
    Returns:
    
    the failure reports setting.
  - setDefaultMatchSettings
```
public void setDefaultMatchSettings(ImageMatchSettings defaultMatchSettings)
```
  - getDefaultMatchSettings
```
public ImageMatchSettings getDefaultMatchSettings()
```
  - setMatchLevel
```
public void setMatchLevel(MatchLevel matchLevel)
```
    This function is deprecated. Please use setDefaultMatchSettings(com.applitools.eyes.ImageMatchSettings) instead.
    The test-wide match level to use when checking application screenshot with the expected output.
    
    Parameters:
    
    matchLevel - The match level setting.
    
    See Also:
    
    MatchLevel
  - getMatchLevel
```
public MatchLevel getMatchLevel()
```
    Deprecated. Please usegetDefaultMatchSettings() instead.
    
    Returns:
    
    The test-wide match level.
  - getBaseAgentId
```
protected abstract String getBaseAgentId()
```
    Returns:
    
    The base agent id of the SDK.
  - getFullAgentId
```
protected String getFullAgentId()
```
    Returns:
    
    The full agent id composed of both the base agent id and the user given agent id.
  - getIsOpen
```
public boolean getIsOpen()
```
    Returns:
    
    Whether a session is open.
  - getDefaultServerUrl
```
public static URI getDefaultServerUrl()
```
  - setLogHandler
```
public void setLogHandler(LogHandler logHandler)
```
    Sets a handler of log messages generated by this API.
    
    Parameters:
    
    logHandler - Handles log messages generated by this API.
  - getLogHandler
```
public LogHandler getLogHandler()
```
    Returns:
    
    The currently set log handler.
  - setImageCut
```
public void setImageCut(CutProvider cutProvider)
```
  - setScaleRatio
```
public void setScaleRatio(Double scaleRatio)
```
  - getScaleRatio
```
public double getScaleRatio()
```
  - setSaveDebugScreenshots
```
public void setSaveDebugScreenshots(boolean saveDebugScreenshots)
```
    Parameters:
    
    saveDebugScreenshots - If true, will save all screenshots to local directory.
  - getSaveDebugScreenshots
```
public boolean getSaveDebugScreenshots()
```
    Returns:
    
    True if screenshots saving enabled.
  - setDebugScreenshotsPath
```
public void setDebugScreenshotsPath(String pathToSave)
```
    Parameters:
    
    pathToSave - Path where you want to save the debug screenshots.
  - getDebugScreenshotsPath
```
public String getDebugScreenshotsPath()
```
    Returns:
    
    The path where you want to save the debug screenshots.
  - setDebugScreenshotsPrefix
```
public void setDebugScreenshotsPrefix(String prefix)
```
    Parameters:
    
    prefix - The prefix for the screenshots' names.
  - getDebugScreenshotsPrefix
```
public String getDebugScreenshotsPrefix()
```
    Returns:
    
    The prefix for the screenshots' names.
  - close
```
public TestResults close()
```
    See close(boolean). throwEx defaults to true.
    
    Returns:
    
    The test results.
  - close
```
public TestResults close(boolean throwEx)
```
    Ends the test.
    
    Parameters:
    
    throwEx - If true, an exception will be thrown for failed/new tests.
    
    Returns:
    
    The test results.
    
    Throws:
    
    TestFailedException - if a mismatch was found and throwEx is true.
    
    NewTestException - if this is a new test was found and throwEx is true.
  - closeResponseTime
```
protected void closeResponseTime(boolean isDeadlineExceeded)
```
    Ends the test.
    
    Parameters:
    
    isDeadlineExceeded - If true the test will fail (unless it's a new test).
    
    Throws:
    
    TestFailedException
    
    NewTestException
  - abortIfNotClosed
```
public void abortIfNotClosed()
```
    If a test is running, aborts it. Otherwise, does nothing.
  - setHostOS
```
public void setHostOS(String hostOS)
```
    Parameters:
    
    hostOS - The host OS running the AUT.
  - getHostOS
```
public String getHostOS()
```
    Returns:
    
    get the host OS running the AUT.
  - setHostApp
```
public void setHostApp(String hostApp)
```
    Parameters:
    
    hostApp - The application running the AUT (e.g., Chrome).
  - getHostApp
```
public String getHostApp()
```
    Returns:
    
    The application name running the AUT.
  - setBaselineName
```
public void setBaselineName(String baselineName)
```
    Deprecated. Only available for backward compatibility. See setBaselineEnvName(String).
    
    Parameters:
    
    baselineName - If specified, determines the baseline to compare with and disables automatic baseline inference.
  - getBaselineName
```
public String getBaselineName()
```
    Deprecated. Only available for backward compatibility. See getBaselineEnvName().
    
    Returns:
    
    The baseline name, if specified.
  - setBaselineEnvName
```
public void setBaselineEnvName(String baselineEnvName)
```
    If not null, determines the name of the environment of the baseline.
    
    Parameters:
    
    baselineEnvName - The name of the baseline's environment.
  - getBaselineEnvName
```
public String getBaselineEnvName()
```
    If not null, determines the name of the environment of the baseline.
    
    Returns:
    
    The name of the baseline's environment, or null if no such name was set.
  - setEnvName
```
public void setEnvName(String envName)
```
    If not null specifies a name for the environment in which the application under test is running.
    
    Parameters:
    
    envName - The name of the environment of the baseline.
  - getEnvName
```
public String getEnvName()
```
    If not null specifies a name for the environment in which the application under test is running.
    
    Returns:
    
    The name of the environment of the baseline, or null if no such name was set.
  - setAppEnvironment
```
@Deprecated
public void setAppEnvironment(String hostOS,
                                          String hostApp)
```
    Deprecated.
    
    Superseded by setHostOS(String) and (String). Sets the OS (e.g., Windows) and application (e.g., Chrome) that host the application under test.
    
    Parameters:
    
    hostOS - The name of the OS hosting the application under test or null to auto-detect.
    
    hostApp - The name of the application hosting the application under test or null to auto-detect.
  - getPositionProvider
```
protected PositionProvider getPositionProvider()
```
    Returns:
    
    The currently set position provider.
  - setPositionProvider
```
protected void setPositionProvider(PositionProvider positionProvider)
```
    Parameters:
    
    positionProvider - The position provider to be used.
  - checkWindowBase
```
protected MatchResult checkWindowBase(RegionProvider regionProvider,
                                      String tag,
                                      boolean ignoreMismatch)
```
  - checkWindowBase
```
protected MatchResult checkWindowBase(RegionProvider regionProvider,
                                      String tag,
                                      boolean ignoreMismatch,
                                      int retryTimeout)
```
    Takes a snapshot of the application under test and matches it with the expected output.
    
    Parameters:
    
    regionProvider - Returns the region to check or the empty rectangle to check the entire window.
    
    tag - An optional tag to be associated with the snapshot.
    
    ignoreMismatch - Whether to ignore this check if a mismatch is found.
    
    retryTimeout - The amount of time to retry matching in milliseconds or a negative value to use the default retry timeout.
    
    Returns:
    
    The result of matching the output with the expected output.
    
    Throws:
    
    TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.
  - testResponseTimeBase
```
protected MatchWindowDataWithScreenshot testResponseTimeBase(RegionProvider regionProvider,
                                                             Runnable action,
                                                             int deadline,
                                                             int timeout,
                                                             long matchInterval)
```
    Runs a timing test.
    
    Parameters:
    
    regionProvider - Returns the region to check or the empty rectangle to check the entire window.
    
    action - An action to run in parallel to starting the test, or null if no such action is required.
    
    deadline - The expected amount of time until finding a match. (Seconds)
    
    timeout - The maximum amount of time to retry matching. (Seconds)
    
    matchInterval - The interval for testing for a match. (Milliseconds)
    
    Returns:
    
    The earliest match found, or null if no match was found.
  - openBase
```
public void openBase(String appName,
                     String testName,
                     RectangleSize viewportSize,
                     SessionType sessionType)
```
    Starts a test.
    
    Parameters:
    
    appName - The name of the application under test.
    
    testName - The test name.
    
    viewportSize - The client's viewport size (i.e., the visible part of the document's body) or null to allow any viewport size.
    
    sessionType - The type of test (e.g., Progression for timing tests), or null to use the default.
  - getViewportSize
```
protected abstract RectangleSize getViewportSize()
```
    Returns:
    
    The viewport size of the AUT.
  - setViewportSize
```
protected abstract void setViewportSize(RectangleSize size)
```
    Parameters:
    
    size - The required viewport size.
  - getInferredEnvironment
```
protected abstract String getInferredEnvironment()
```
    Returns:
    
    The inferred environment string or null if none is available. The inferred string is in the format "source:info" where source is either "useragent" or "pos". Information associated with a "useragent" source is a valid browser user agent string. Information associated with a "pos" source is a string of the format "process-name;os-name" where "process-name" is the name of the main module of the executed process and "os-name" is the OS name.
  - getScreenshot
```
protected abstract EyesScreenshot getScreenshot()
```
    Returns:
    
    An updated screenshot.
  - getTitle
```
protected abstract String getTitle()
```
    Returns:
    
    The current title of of the AUT.
  - addUserInput
```
protected void addUserInput(Trigger trigger)
```
    Adds a trigger to the current list of user inputs.
    
    Parameters:
    
    trigger - The trigger to add to the user inputs list.
  - addTextTriggerBase
```
protected void addTextTriggerBase(Region control,
                                  String text)
```
    Adds a text trigger.
    
    Parameters:
    
    control - The control's position relative to the window.
    
    text - The trigger's text.
  - addMouseTriggerBase
```
protected void addMouseTriggerBase(MouseAction action,
                                   Region control,
                                   Location cursor)
```
    Adds a mouse trigger.
    
    Parameters:
    
    action - Mouse action.
    
    control - The control on which the trigger is activated (location is relative to the window).
    
    cursor - The cursor's position relative to the control.
  - getAppEnvironment
```
protected AppEnvironment getAppEnvironment()
```
    Application environment is the environment (e.g., the host OS) which runs the application under test.
    
    Returns:
    
    The current application environment.
  - startSession
```
protected void startSession()
```
    Start eyes session on the eyes server.

Class EyesBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USE_DEFAULT_TIMEOUT

serverConnector

runningSession

sessionStartInfo

viewportSize

lastScreenshot

scaleProviderHandler

cutProviderHandler

positionProvider

logger

debugScreenshotsProvider

Constructor Detail

EyesBase

Method Detail

setAgentId

getAgentId

setApiKey

getApiKey

setServerUrl

getServerUrl

setProxy

getProxy

setIsDisabled

getIsDisabled

setAppName

getAppName

setBranchName

getBranchName

setParentBranchName

getParentBranchName

clearUserInputs

getUserInputs

setMatchTimeout

getMatchTimeout

setSaveNewTests

getSaveNewTests

setSaveFailedTests

getSaveFailedTests

setBatch

getBatch

setFailureReports

getFailureReports

setDefaultMatchSettings

getDefaultMatchSettings

setMatchLevel

getMatchLevel

getBaseAgentId

getFullAgentId

getIsOpen

getDefaultServerUrl

setLogHandler

getLogHandler

setImageCut

setScaleRatio

getScaleRatio

setSaveDebugScreenshots

getSaveDebugScreenshots

setDebugScreenshotsPath

getDebugScreenshotsPath

setDebugScreenshotsPrefix

getDebugScreenshotsPrefix

close

close

closeResponseTime

abortIfNotClosed

setHostOS

getHostOS

setHostApp

getHostApp

setBaselineName

getBaselineName

setBaselineEnvName

getBaselineEnvName

setEnvName