Package org.openqa.selenium.chrome

Class ChromeDriverService

java.lang.Object

org.openqa.selenium.remote.service.DriverService

org.openqa.selenium.chrome.ChromeDriverService

All Implemented Interfaces:

Closeable, AutoCloseable

public class ChromeDriverService
extends DriverService

Manages the life and death of a ChromeDriver server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChromeDriverService.Builder	Builder used to configure new ChromeDriverService instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHROME_DRIVER_ALLOWED_IPS_PROPERTY	System property that defines comma-separated list of remote IPv4 addresses which are allowed to connect to ChromeDriver.
static final String	CHROME_DRIVER_APPEND_LOG_PROPERTY	Boolean system property that defines whether ChromeDriver should append to existing log file.
static final String	CHROME_DRIVER_DISABLE_BUILD_CHECK	System property that defines whether the ChromeDriver executable should check for build version compatibility between ChromeDriver and the browser.
static final String	CHROME_DRIVER_EXE_PROPERTY	System property that defines the location of the ChromeDriver executable that will be used by the default service.
static final String	CHROME_DRIVER_LOG_LEVEL_PROPERTY	System property that defines the ChromiumDriverLogLevel for ChromeDriver logs.
static final String	CHROME_DRIVER_LOG_PROPERTY	System property that defines the location of the file where ChromeDriver should write log messages to.
static final String	CHROME_DRIVER_NAME
static final String	CHROME_DRIVER_READABLE_TIMESTAMP	System property that toggles the formatting of the timestamps of the logs
static final String	CHROME_DRIVER_SILENT_OUTPUT_PROPERTY	Boolean system property that defines whether the ChromeDriver executable should be started in silent mode.
static final String	CHROME_DRIVER_VERBOSE_LOG_PROPERTY	Boolean system property that defines whether the ChromeDriver executable should be started with verbose logging.

Fields inherited from class org.openqa.selenium.remote.service.DriverService

DEFAULT_TIMEOUT, LOG_NULL, LOG_STDERR, LOG_STDOUT, process

Constructor Summary

Constructors

Constructor	Description
ChromeDriverService(File executable, int port, Duration timeout, List<String> args, Map<String,String> environment)

Method Summary

Modifier and Type	Method	Description
static ChromeDriverService	createDefaultService()	Configures and returns a new ChromeDriverService using the default configuration.
Capabilities	getDefaultDriverOptions()
String	getDriverName()
String	getDriverProperty()

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

close, getArgs, getDriverExecutable, getEnvironment, getExecutable, getOutputStream, getTimeout, getUrl, getUrl, hasShutdownEndpoint, isRunning, sendOutputTo, setExecutable, start, stop, waitUntilAvailable

Methods inherited from class java.lang.Object

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

Field Details

CHROME_DRIVER_NAME

public static final String CHROME_DRIVER_NAME

See Also:

• Constant Field Values

CHROME_DRIVER_EXE_PROPERTY

public static final String CHROME_DRIVER_EXE_PROPERTY

System property that defines the location of the ChromeDriver executable that will be used by the default service.

See Also:

• Constant Field Values

CHROME_DRIVER_READABLE_TIMESTAMP

public static final String CHROME_DRIVER_READABLE_TIMESTAMP

System property that toggles the formatting of the timestamps of the logs

See Also:

• Constant Field Values

CHROME_DRIVER_LOG_PROPERTY

public static final String CHROME_DRIVER_LOG_PROPERTY

System property that defines the location of the file where ChromeDriver should write log messages to.

See Also:

• Constant Field Values

CHROME_DRIVER_LOG_LEVEL_PROPERTY

public static final String CHROME_DRIVER_LOG_LEVEL_PROPERTY

System property that defines the ChromiumDriverLogLevel for ChromeDriver logs.

See Also:

• Constant Field Values

CHROME_DRIVER_APPEND_LOG_PROPERTY

public static final String CHROME_DRIVER_APPEND_LOG_PROPERTY

Boolean system property that defines whether ChromeDriver should append to existing log file.

See Also:

• Constant Field Values

CHROME_DRIVER_VERBOSE_LOG_PROPERTY

public static final String CHROME_DRIVER_VERBOSE_LOG_PROPERTY

Boolean system property that defines whether the ChromeDriver executable should be started with verbose logging.

See Also:

• Constant Field Values

CHROME_DRIVER_SILENT_OUTPUT_PROPERTY

public static final String CHROME_DRIVER_SILENT_OUTPUT_PROPERTY

Boolean system property that defines whether the ChromeDriver executable should be started in silent mode.

See Also:

• Constant Field Values

CHROME_DRIVER_ALLOWED_IPS_PROPERTY

public static final String CHROME_DRIVER_ALLOWED_IPS_PROPERTY

System property that defines comma-separated list of remote IPv4 addresses which are allowed to connect to ChromeDriver.

See Also:

• Constant Field Values

CHROME_DRIVER_DISABLE_BUILD_CHECK

public static final String CHROME_DRIVER_DISABLE_BUILD_CHECK

System property that defines whether the ChromeDriver executable should check for build version compatibility between ChromeDriver and the browser.

See Also:

• Constant Field Values

Constructor Details

ChromeDriverService

public ChromeDriverService(File executable,
 int port,
 Duration timeout,
 List<String> args,
 Map<String,String> environment)
                    throws IOException

Parameters:

executable - The ChromeDriver executable.

port - Which port to start the ChromeDriver on.

timeout - Timeout waiting for driver server to start.

args - The arguments to the launched server.

environment - The environment for the launched server.

Throws:

IOException - If an I/O error occurs.

Method Details

getDriverName

public String getDriverName()

Overrides:

getDriverName in class DriverService

getDriverProperty

public String getDriverProperty()

Overrides:

getDriverProperty in class DriverService

getDefaultDriverOptions

public Capabilities getDefaultDriverOptions()

Overrides:

getDefaultDriverOptions in class DriverService

createDefaultService

public static ChromeDriverService createDefaultService()

Configures and returns a new ChromeDriverService using the default configuration. In this configuration, the service will use the ChromeDriver executable identified by DriverFinder.getDriverPath() (DriverService, Capabilities)}. Each service created by this method will be configured to use a free port on the current system.

Returns:

A new ChromeDriverService using the default configuration.