java.lang.Object
- com.intuit.karate.driver.DriverOptions

Direct Known Subclasses:

MobileDriverOptions
```
public class DriverOptions
extends Object
```
Author:

pthomas3

Field Summary

Fields
Modifier and Type	Field	Description
`List<String>`	`addOptions`
`String`	`afterStop`
`LogAppender`	`appender`
`List<String>`	`args`
`String`	`attach`
`String`	`beforeStart`
`Logger`	`driverLogger`
`String`	`executable`
`boolean`	`headless`
`boolean`	`highlight`
`int`	`highlightDuration`
`String`	`host`
`Map<String,Object>`	`httpConfig`
`static String`	`KARATE_REF_GENERATOR`
`Logger`	`logger`
`int`	`maxPayloadSize`
`Map<String,Object>`	`options`
`Map<String,Object>`	`playwrightOptions`
`String`	`playwrightUrl`
`int`	`pollAttempts`
`int`	`pollInterval`
`int`	`port`
`String`	`processLogFile`
`Logger`	`processLogger`
`boolean`	`remoteHost`
`boolean`	`screenshotOnFailure`
`static String`	`SCROLL_JS_FUNCTION`
`boolean`	`showBrowserLog`
`boolean`	`showDriverLog`
`boolean`	`showProcessLog`
`boolean`	`start`
`boolean`	`stop`
`Target`	`target`
`int`	`timeout`
`String`	`type`
`String`	`uniqueName`
`boolean`	`useDockerHost`
`String`	`userAgent`
`String`	`userDataDir`
`String`	`videoFile`
`String`	`webDriverPath`
`Map<String,Object>`	`webDriverSession`
`String`	`webDriverUrl`
`File`	`workingDir`

Constructor Summary

Constructors
Constructor	Description
`DriverOptions(Map<String,Object> options, ScenarioRuntime sr, int defaultPort, String defaultExecutable)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`arg(String arg)`
`void`	`disableRetry()`
`static Map<String,DriverRunner>`	`driverRunners()`
`void`	`enableRetry(Integer count, Integer interval)`
`List<Element>`	`findAll(Driver driver, String locator)`
`String`	`focusJs(String locator)`
`Http`	`getHttp()`
`static String`	`getPositionJs(String locator)`
`String`	`getPreSubmitHash()`
`static String`	`getRelativePositionJs(String locator)`
`int`	`getRetryCount()`
`int`	`getRetryInterval()`
`int`	`getTimeout()`
`Map<String,Object>`	`getWebDriverSessionPayload()`
`String`	`highlight(String locator, int millis)`
`String`	`highlightAll(String locator, int millis)`
`boolean`	`isHostDockerHost()`
`boolean`	`isRemoteHost()`
`boolean`	`isRetryEnabled()`
`static String`	`karateLocator(String karateRef)`
`Map<String,Object>`	`newMapWithSelectedKeys(Map<String,Object> map, String... keys)`
`Element`	`optional(Driver driver, String locator)`
`String`	`optionSelector(String id, int index)`
`String`	`optionSelector(String locator, String text)`
`static String`	`preProcessWildCard(String locator)`
`<T> T`	`retry(java.util.function.Supplier<T> action, java.util.function.Predicate<T> condition, String logDescription, boolean failWithException)`
`String`	`scriptAllSelector(String locator, String expression)`
`String`	`scriptAllSelector(String locator, String expression, String contextNode)`
`String`	`scriptSelector(String locator, String expression)`
`String`	`scriptSelector(String locator, String expression, String contextNode)`
`static String`	`selector(String locator)`
`static String`	`selector(String locator, String contextNode)`
`void`	`setPreSubmitHash(String preSubmitHash)`
`void`	`setRetryInterval(Integer retryInterval)`
`void`	`setTimeout(Integer timeout)`
`void`	`sleep()`
`void`	`sleep(int millis)`
`static Driver`	`start(Map<String,Object> options, ScenarioRuntime sr)`
`Command`	`startProcess()`
`Command`	`startProcess(java.util.function.Consumer<String> listener)`
`Element`	`waitForAny(Driver driver, String... locators)`
`String`	`waitForUrl(Driver driver, String expected)`
`Element`	`waitUntil(Driver driver, String locator, String expression)`
`static String`	`wrapInFunctionInvoke(String text)`

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

Field Detail

options

public final Map<String,Object> options

timeout
```
public final int timeout
```

start
```
public final boolean start
```

stop
```
public final boolean stop
```

executable
```
public final String executable
```

type
```
public final String type
```

port
```
public final int port
```

host
```
public final String host
```

pollAttempts
```
public final int pollAttempts
```

pollInterval
```
public final int pollInterval
```

headless
```
public final boolean headless
```

showProcessLog
```
public final boolean showProcessLog
```

showDriverLog
```
public final boolean showDriverLog
```

showBrowserLog
```
public final boolean showBrowserLog
```

logger
```
public final Logger logger
```

appender
```
public final LogAppender appender
```

processLogger
```
public final Logger processLogger
```

driverLogger
```
public final Logger driverLogger
```

uniqueName
```
public final String uniqueName
```

workingDir
```
public final File workingDir
```

userAgent
```
public final String userAgent
```

userDataDir
```
public final String userDataDir
```

processLogFile
```
public final String processLogFile
```

maxPayloadSize
```
public final int maxPayloadSize
```

addOptions
```
public final List<String> addOptions
```

args
```
public final List<String> args
```

webDriverUrl
```
public final String webDriverUrl
```

webDriverPath
```
public final String webDriverPath
```

webDriverSession

public final Map<String,Object> webDriverSession

httpConfig

public final Map<String,Object> httpConfig

remoteHost
```
public final boolean remoteHost
```

useDockerHost
```
public final boolean useDockerHost
```

target
```
public final Target target
```

beforeStart
```
public final String beforeStart
```

afterStop
```
public final String afterStop
```

videoFile
```
public final String videoFile
```

highlight
```
public final boolean highlight
```

highlightDuration
```
public final int highlightDuration
```

attach
```
public final String attach
```

screenshotOnFailure

public final boolean screenshotOnFailure

playwrightUrl
```
public final String playwrightUrl
```

playwrightOptions

public final Map<String,Object> playwrightOptions

SCROLL_JS_FUNCTION

public static final String SCROLL_JS_FUNCTION

See Also:: Constant Field Values

KARATE_REF_GENERATOR

public static final String KARATE_REF_GENERATOR

See Also:: Constant Field Values

Constructor Detail

DriverOptions

public DriverOptions(Map<String,Object> options,
                     ScenarioRuntime sr,
                     int defaultPort,
                     String defaultExecutable)

Method Detail

isRetryEnabled
```
public boolean isRetryEnabled()
```

getPreSubmitHash
```
public String getPreSubmitHash()
```

isRemoteHost
```
public boolean isRemoteHost()
```

isHostDockerHost
```
public boolean isHostDockerHost()
```

setPreSubmitHash

public void setPreSubmitHash(String preSubmitHash)

getHttp
```
public Http getHttp()
```

arg
```
public void arg(String arg)
```

startProcess
```
public Command startProcess()
```

startProcess

public Command startProcess(java.util.function.Consumer<String> listener)

start

public static Driver start(Map<String,Object> options,
                           ScenarioRuntime sr)

driverRunners

public static Map<String,DriverRunner> driverRunners()

getWebDriverSessionPayload

public Map<String,Object> getWebDriverSessionPayload()

preProcessWildCard

public static String preProcessWildCard(String locator)

selector

public static String selector(String locator)

selector

public static String selector(String locator,
                              String contextNode)

setTimeout

public void setTimeout(Integer timeout)

getTimeout
```
public int getTimeout()
```

setRetryInterval

public void setRetryInterval(Integer retryInterval)

getRetryInterval
```
public int getRetryInterval()
```

getRetryCount
```
public int getRetryCount()
```

retry

public <T> T retry(java.util.function.Supplier<T> action,
                   java.util.function.Predicate<T> condition,
                   String logDescription,
                   boolean failWithException)

wrapInFunctionInvoke

public static String wrapInFunctionInvoke(String text)

highlight

public String highlight(String locator,
                        int millis)

highlightAll

public String highlightAll(String locator,
                           int millis)

optionSelector

public String optionSelector(String locator,
                             String text)

optionSelector

public String optionSelector(String id,
                             int index)

scriptSelector

public String scriptSelector(String locator,
                             String expression)

scriptSelector

public String scriptSelector(String locator,
                             String expression,
                             String contextNode)

scriptAllSelector

public String scriptAllSelector(String locator,
                                String expression)

scriptAllSelector

public String scriptAllSelector(String locator,
                                String expression,
                                String contextNode)

sleep
```
public void sleep()
```

sleep
```
public void sleep(int millis)
```

getRelativePositionJs

public static String getRelativePositionJs(String locator)

getPositionJs

public static String getPositionJs(String locator)

newMapWithSelectedKeys

public Map<String,Object> newMapWithSelectedKeys(Map<String,Object> map,
                                                       String... keys)

disableRetry
```
public void disableRetry()
```

enableRetry

public void enableRetry(Integer count,
                        Integer interval)

waitUntil

public Element waitUntil(Driver driver,
                         String locator,
                         String expression)

waitForUrl

public String waitForUrl(Driver driver,
                         String expected)

waitForAny

public Element waitForAny(Driver driver,
                          String... locators)

optional

public Element optional(Driver driver,
                        String locator)

karateLocator

public static String karateLocator(String karateRef)

focusJs

public String focusJs(String locator)

findAll

public List<Element> findAll(Driver driver,
                             String locator)

Class DriverOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

options

timeout

start

stop

executable

type

port

host

pollAttempts

pollInterval

headless

showProcessLog

showDriverLog

showBrowserLog

logger

appender

processLogger

driverLogger

uniqueName

workingDir

userAgent

userDataDir

processLogFile

maxPayloadSize

addOptions

args

webDriverUrl

webDriverPath

webDriverSession

httpConfig

remoteHost

useDockerHost

target

beforeStart

afterStop

videoFile

highlight

highlightDuration

attach

screenshotOnFailure

playwrightUrl

playwrightOptions

SCROLL_JS_FUNCTION

KARATE_REF_GENERATOR

Constructor Detail

DriverOptions

Method Detail

isRetryEnabled

getPreSubmitHash

isRemoteHost

isHostDockerHost

setPreSubmitHash

getHttp

arg

startProcess

startProcess

start

driverRunners

getWebDriverSessionPayload

preProcessWildCard

selector

selector

setTimeout

getTimeout

setRetryInterval

getRetryInterval

getRetryCount

retry

wrapInFunctionInvoke

highlight

highlightAll

optionSelector

optionSelector

scriptSelector