DriverOptions (karate-core 0.9.6 API)

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

public class DriverOptions
extends Object

Author:: pthomas3

Field Summary

Fields
Modifier and Type	Field and Description
`List<String>`	`addOptions`
`String`	`afterStop`
`LogAppender`	`appender`
`List<String>`	`args`
`String`	`attach`
`String`	`beforeStart`
`boolean`	`disableNotifications`
`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`
`int`	`pollAttempts`
`int`	`pollInterval`
`int`	`port`
`String`	`processLogFile`
`Logger`	`processLogger`
`static String`	`SCROLL_JS_FUNCTION`
`boolean`	`showDriverLog`
`boolean`	`showProcessLog`
`boolean`	`start`
`Target`	`target`
`int`	`timeout`
`String`	`type`
`String`	`uniqueName`
`String`	`userAgent`
`String`	`userDataDir`
`String`	`videoFile`
`String`	`webDriverPath`
`Map<String,Object>`	`webDriverSession`
`String`	`webDriverUrl`
`File`	`workingDir`

Constructor Summary

Constructors
Constructor and Description
`DriverOptions(ScenarioContext context, Map<String,Object> options, LogAppender appender, int defaultPort, String defaultExecutable)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`arg(String arg)`
`void`	`disableRetry()`
`void`	`embedContent(Embed embed)`
`void`	`embedPngImage(byte[] bytes)`
`void`	`enableRetry(Integer count, Integer interval)`
`List<Element>`	`findAll(Driver driver, String locator)`
`String`	`focusJs(String locator)`
`ScenarioContext`	`getContext()`
`Http`	`getHttp()`
`String`	`getPreSubmitHash()`
`int`	`getRetryCount()`
`int`	`getRetryInterval()`
`int`	`getTimeout()`
`Map<String,Object>`	`getWebDriverSessionPayload()`
`String`	`highlight(String locator, int millis)`
`String`	`highlightAll(String locator, int millis)`
`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`	`setContext(ScenarioContext context)`
`void`	`setPreSubmitHash(String preSubmitHash)`
`void`	`setRetryInterval(Integer retryInterval)`
`void`	`setTimeout(Integer timeout)`
`void`	`sleep()`
`void`	`sleep(int millis)`
`static Driver`	`start(ScenarioContext context, Map<String,Object> options, LogAppender appender)`
`Command`	`startProcess()`
`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
```

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
```

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
```

disableNotifications

public final boolean disableNotifications

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

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
```

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(ScenarioContext context,
                     Map<String,Object> options,
                     LogAppender appender,
                     int defaultPort,
                     String defaultExecutable)

Method Detail

setContext

public void setContext(ScenarioContext context)

getContext
```
public ScenarioContext getContext()
```

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

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

setPreSubmitHash

public void setPreSubmitHash(String preSubmitHash)

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

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

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

start

public static Driver start(ScenarioContext context,
                           Map<String,Object> options,
                           LogAppender appender)

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)
```

newMapWithSelectedKeys

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

embedPngImage

public void embedPngImage(byte[] bytes)

embedContent

public void embedContent(Embed embed)

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

executable

type

port

host

pollAttempts

pollInterval

headless

showProcessLog

showDriverLog

logger

appender

processLogger

driverLogger

uniqueName

workingDir

disableNotifications

userAgent

userDataDir

processLogFile

maxPayloadSize

addOptions

args

webDriverUrl

webDriverPath

webDriverSession

httpConfig

target

beforeStart

afterStop

videoFile

highlight

highlightDuration

attach

SCROLL_JS_FUNCTION

KARATE_REF_GENERATOR

Constructor Detail

DriverOptions

Method Detail

setContext

getContext

isRetryEnabled

getPreSubmitHash

setPreSubmitHash

getHttp

arg

startProcess

start

getWebDriverSessionPayload

preProcessWildCard

selector

selector

setTimeout

getTimeout

setRetryInterval

getRetryInterval

getRetryCount

retry

wrapInFunctionInvoke

highlight

highlightAll

optionSelector

optionSelector

scriptSelector

scriptSelector

scriptAllSelector

scriptAllSelector

sleep

sleep

newMapWithSelectedKeys

embedPngImage

embedContent