Package org.openqa.selenium.firefox

Class GeckoDriverService.Builder

java.lang.Object

org.openqa.selenium.remote.service.DriverService.Builder<DS,B>

org.openqa.selenium.firefox.FirefoxDriverService.Builder<GeckoDriverService,GeckoDriverService.Builder>

org.openqa.selenium.firefox.GeckoDriverService.Builder

Enclosing class:

GeckoDriverService

@AutoService(Builder.class)
public static class GeckoDriverService.Builder
extends FirefoxDriverService.Builder<GeckoDriverService,GeckoDriverService.Builder>

Builder used to configure new GeckoDriverService instances.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	createArgs()
protected GeckoDriverService	createDriverService(java.io.File exe, int port, java.time.Duration timeout, java.util.List<java.lang.String> args, java.util.Map<java.lang.String,java.lang.String> environment)
protected void	loadSystemProperties()
int	score(Capabilities capabilities)	Provides a measure of how strongly this DriverService supports the given capabilities.
GeckoDriverService.Builder	usingFirefoxBinary(FirefoxBinary firefoxBinary)	Deprecated. use FirefoxOptions.setBinary(Path)
GeckoDriverService.Builder	withAllowHosts(java.lang.String allowHosts)	Values of the Host header to allow for incoming requests.
GeckoDriverService.Builder	withLogLevel(FirefoxDriverLogLevel logLevel)
GeckoDriverService.Builder	withProfileRoot(java.io.File root)	This is necessary when you do not have permissions to write to the default directory.
GeckoDriverService.Builder	withTruncatedLogs(java.lang.Boolean truncate)

Methods inherited from class org.openqa.selenium.remote.service.DriverService.Builder

build, getDefaultTimeout, getLogFile, getLogOutput, getPort, usingAnyFreePort, usingDriverExecutable, usingPort, withEnvironment, withLogFile, withLogOutput, withTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

score

public int score(Capabilities capabilities)

Description copied from class: DriverService.Builder

Provides a measure of how strongly this DriverService supports the given capabilities. A score of 0 or less indicates that this DriverService does not support instances of WebDriver that require capabilities. Typically, the score is generated by summing the number of capabilities that the driver service directly supports that are unique to the driver service (that is, things like "proxy" don't tend to count to the score).

Specified by:

score in class DriverService.Builder<GeckoDriverService,GeckoDriverService.Builder>

usingFirefoxBinary

@Deprecated
public GeckoDriverService.Builder usingFirefoxBinary(FirefoxBinary firefoxBinary)

Deprecated.

use FirefoxOptions.setBinary(Path)

Sets which browser executable the builder will use.

Parameters:

firefoxBinary - The browser executable to use.

Returns:

A self reference.

withAllowHosts

public GeckoDriverService.Builder withAllowHosts(java.lang.String allowHosts)

Values of the Host header to allow for incoming requests.

Parameters:

allowHosts - Space-separated list of host names.

Returns:

A self reference.

withLogLevel

public GeckoDriverService.Builder withLogLevel(FirefoxDriverLogLevel logLevel)

Parameters:

logLevel - which log events to record.

Returns:

A self reference.

withTruncatedLogs

public GeckoDriverService.Builder withTruncatedLogs(java.lang.Boolean truncate)

Parameters:

truncate - whether to truncate long lines in the log. Log lines are truncated by default; setting "false" removes truncation

Returns:

A self reference.

withProfileRoot

public GeckoDriverService.Builder withProfileRoot(java.io.File root)

This is necessary when you do not have permissions to write to the default directory.

Parameters:

root - location to store temporary profiles Defaults to the system temporary directory.

Returns:

A self reference.

loadSystemProperties

protected void loadSystemProperties()

Specified by:

loadSystemProperties in class DriverService.Builder<GeckoDriverService,GeckoDriverService.Builder>

createArgs

protected java.util.List<java.lang.String> createArgs()

Specified by:

createArgs in class DriverService.Builder<GeckoDriverService,GeckoDriverService.Builder>

createDriverService

protected GeckoDriverService createDriverService(java.io.File exe,
                                                 int port,
                                                 java.time.Duration timeout,
                                                 java.util.List<java.lang.String> args,
                                                 java.util.Map<java.lang.String,java.lang.String> environment)

Specified by:

createDriverService in class DriverService.Builder<GeckoDriverService,GeckoDriverService.Builder>