org.openqa.selenium.chrome

Class ChromeOptions

java.lang.Object

org.openqa.selenium.MutableCapabilities

org.openqa.selenium.chrome.ChromeOptions

All Implemented Interfaces:

java.io.Serializable, org.openqa.selenium.Capabilities

public class ChromeOptions
extends org.openqa.selenium.MutableCapabilities

Class to manage options specific to ChromeDriver.

Example usage:

 ChromeOptions options = new ChromeOptions()
 options.addExtensions(new File("/path/to/extension.crx"))
 options.setBinary(new File("/path/to/chrome"));

 // For use with ChromeDriver:
 ChromeDriver driver = new ChromeDriver(options);

 // For use with RemoteWebDriver:
 RemoteWebDriver driver = new RemoteWebDriver(
     new URL("http://localhost:4444/wd/hub"),
     new ChromeOptions());
 

Since:

Since chromedriver v17.0.963.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPABILITY Key used to store a set of ChromeOptions in a Capabilities object.

Constructor Summary

Constructors

Constructor and Description
ChromeOptions()

Method Summary

Modifier and Type	Method and Description
ChromeOptions	addArguments(java.util.List<java.lang.String> arguments) Adds additional command line arguments to be used when starting Chrome.
ChromeOptions	addArguments(java.lang.String... arguments)
ChromeOptions	addEncodedExtensions(java.util.List<java.lang.String> encoded) Adds a new Chrome extension to install on browser startup.
ChromeOptions	addEncodedExtensions(java.lang.String... encoded)
ChromeOptions	addExtensions(java.io.File... paths)
ChromeOptions	addExtensions(java.util.List<java.io.File> paths) Adds a new Chrome extension to install on browser startup.
protected int	amendHashCode()
java.util.Map<java.lang.String,java.lang.Object>	asMap()
java.lang.Object	getExperimentalOption(java.lang.String name) Deprecated. Getters are not needed in browser Options classes.
ChromeOptions	merge(org.openqa.selenium.Capabilities extraCapabilities)
ChromeOptions	setAcceptInsecureCerts(boolean acceptInsecureCerts)
ChromeOptions	setBinary(java.io.File path) Sets the path to the Chrome executable.
ChromeOptions	setBinary(java.lang.String path) Sets the path to the Chrome executable.
ChromeOptions	setExperimentalOption(java.lang.String name, java.lang.Object value) Sets an experimental option.
ChromeOptions	setHeadless(boolean headless)
ChromeOptions	setPageLoadStrategy(org.openqa.selenium.PageLoadStrategy strategy)
ChromeOptions	setProxy(org.openqa.selenium.Proxy proxy)
ChromeOptions	setUnhandledPromptBehaviour(org.openqa.selenium.UnexpectedAlertBehaviour behaviour)

Methods inherited from class org.openqa.selenium.MutableCapabilities

setCapability, setCapability, setCapability, setCapability

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openqa.selenium.Capabilities

getBrowserName, getVersion, is, isJavascriptEnabled

Field Detail

CAPABILITY

public static final java.lang.String CAPABILITY

Key used to store a set of ChromeOptions in a Capabilities object.

See Also:

Constant Field Values

Constructor Detail

ChromeOptions

public ChromeOptions()

Method Detail

merge

public ChromeOptions merge(org.openqa.selenium.Capabilities extraCapabilities)

Specified by:

merge in interface org.openqa.selenium.Capabilities

Overrides:

merge in class org.openqa.selenium.MutableCapabilities

setBinary

public ChromeOptions setBinary(java.io.File path)

Sets the path to the Chrome executable. This path should exist on the machine which will launch Chrome. The path should either be absolute or relative to the location of running ChromeDriver server.

Parameters:

path - Path to Chrome executable.

setBinary

public ChromeOptions setBinary(java.lang.String path)

Sets the path to the Chrome executable. This path should exist on the machine which will launch Chrome. The path should either be absolute or relative to the location of running ChromeDriver server.

Parameters:

path - Path to Chrome executable.

addArguments

public ChromeOptions addArguments(java.lang.String... arguments)

Parameters:

arguments - The arguments to use when starting Chrome.

See Also:

addArguments(java.util.List)

addArguments

public ChromeOptions addArguments(java.util.List<java.lang.String> arguments)

Adds additional command line arguments to be used when starting Chrome. For example:

   options.setArguments(
       "load-extension=/path/to/unpacked_extension",
       "allow-outdated-plugins");
 

Each argument may contain an option "--" prefix: "--foo" or "foo". Arguments with an associated value should be delimitted with an "=": "foo=bar".

Parameters:

arguments - The arguments to use when starting Chrome.

addExtensions

public ChromeOptions addExtensions(java.io.File... paths)

Parameters:

paths - Paths to the extensions to install.

See Also:

addExtensions(java.util.List)

addExtensions

public ChromeOptions addExtensions(java.util.List<java.io.File> paths)

Adds a new Chrome extension to install on browser startup. Each path should specify a packed Chrome extension (CRX file).

Parameters:

paths - Paths to the extensions to install.

addEncodedExtensions

public ChromeOptions addEncodedExtensions(java.lang.String... encoded)

Parameters:

encoded - Base64 encoded data of the extensions to install.

See Also:

addEncodedExtensions(java.util.List)

addEncodedExtensions

public ChromeOptions addEncodedExtensions(java.util.List<java.lang.String> encoded)

Adds a new Chrome extension to install on browser startup. Each string data should specify a Base64 encoded string of packed Chrome extension (CRX file).

Parameters:

encoded - Base64 encoded data of the extensions to install.

setExperimentalOption

public ChromeOptions setExperimentalOption(java.lang.String name,
                                           java.lang.Object value)

Sets an experimental option. Useful for new ChromeDriver options not yet exposed through the ChromeOptions API.

Parameters:

name - Name of the experimental option.

value - Value of the experimental option, which must be convertible to JSON.

getExperimentalOption

@Deprecated
public java.lang.Object getExperimentalOption(java.lang.String name)

Deprecated. Getters are not needed in browser Options classes.

Returns the value of an experimental option.

Parameters:

name - The option name.

Returns:

The option value, or null if not set.

setPageLoadStrategy

public ChromeOptions setPageLoadStrategy(org.openqa.selenium.PageLoadStrategy strategy)

setUnhandledPromptBehaviour

public ChromeOptions setUnhandledPromptBehaviour(org.openqa.selenium.UnexpectedAlertBehaviour behaviour)

setAcceptInsecureCerts

public ChromeOptions setAcceptInsecureCerts(boolean acceptInsecureCerts)

setHeadless

public ChromeOptions setHeadless(boolean headless)

setProxy

public ChromeOptions setProxy(org.openqa.selenium.Proxy proxy)

amendHashCode

protected int amendHashCode()

asMap

public java.util.Map<java.lang.String,java.lang.Object> asMap()

Specified by:

asMap in interface org.openqa.selenium.Capabilities

Overrides:

asMap in class org.openqa.selenium.MutableCapabilities