Package org.openqa.selenium.firefox

Class GeckoDriverService

java.lang.Object

org.openqa.selenium.remote.service.DriverService

org.openqa.selenium.firefox.FirefoxDriverService

org.openqa.selenium.firefox.GeckoDriverService

All Implemented Interfaces:

Closeable, AutoCloseable

public class GeckoDriverService
extends FirefoxDriverService

Manages the life and death of an GeckoDriver

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GECKO_DRIVER_EXE_PROPERTY	System property that defines the location of the GeckoDriver executable that will be used by the default service.
static final String	GECKO_DRIVER_LOG_LEVEL_PROPERTY	System property that defines the FirefoxDriverLogLevel for GeckoDriver logs.
static final String	GECKO_DRIVER_LOG_NO_TRUNCATE	Boolean system property to disable truncation of long log lines.
static final String	GECKO_DRIVER_LOG_PROPERTY	System property that defines the location of the file where GeckoDriver should write log messages to.
static final String	GECKO_DRIVER_NAME
static final String	GECKO_DRIVER_PROFILE_ROOT	System property that defines the location of the directory in which to create profiles See GeckoDriverService.Builder.withProfileRoot(File)

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

DEFAULT_TIMEOUT, LOG_NULL, LOG_STDERR, LOG_STDOUT, process

Constructor Summary

Constructors

Constructor	Description
GeckoDriverService(File executable, int port, Duration timeout, List<String> args, Map<String,String> environment)
GeckoDriverService(File executable, int port, List<String> args, Map<String,String> environment)	Deprecated. use GeckoDriverService(File, int, Duration, List, Map)

Method Summary

Modifier and Type	Method	Description
static GeckoDriverService	createDefaultService()	Configures and returns a new GeckoDriverService using the default configuration.
org.openqa.selenium.Capabilities	getDefaultDriverOptions()
String	getDriverName()
String	getDriverProperty()
protected boolean	hasShutdownEndpoint()
protected void	waitUntilAvailable()

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

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

Methods inherited from class java.lang.Object

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

Field Details

GECKO_DRIVER_NAME

public static final String GECKO_DRIVER_NAME

See Also:

• Constant Field Values

GECKO_DRIVER_EXE_PROPERTY

public static final String GECKO_DRIVER_EXE_PROPERTY

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

See Also:

• Constant Field Values

GECKO_DRIVER_LOG_PROPERTY

public static final String GECKO_DRIVER_LOG_PROPERTY

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

See Also:

• Constant Field Values

GECKO_DRIVER_LOG_LEVEL_PROPERTY

public static final String GECKO_DRIVER_LOG_LEVEL_PROPERTY

System property that defines the FirefoxDriverLogLevel for GeckoDriver logs. See GeckoDriverService.Builder.withLogLevel(FirefoxDriverLogLevel)

See Also:

• Constant Field Values

GECKO_DRIVER_LOG_NO_TRUNCATE

public static final String GECKO_DRIVER_LOG_NO_TRUNCATE

Boolean system property to disable truncation of long log lines. See GeckoDriverService.Builder.withTruncatedLogs(Boolean)

See Also:

• Constant Field Values

GECKO_DRIVER_PROFILE_ROOT

public static final String GECKO_DRIVER_PROFILE_ROOT

System property that defines the location of the directory in which to create profiles See GeckoDriverService.Builder.withProfileRoot(File)

See Also:

• Constant Field Values

Constructor Details

GeckoDriverService

@Deprecated
public GeckoDriverService(File executable,
 int port,
 List<String> args,
 Map<String,String> environment)
                   throws IOException

Deprecated.

use GeckoDriverService(File, int, Duration, List, Map)

Parameters:

executable - The GeckoDriver executable.

port - Which port to start the GeckoDriver on.

args - The arguments to the launched server.

environment - The environment for the launched server.

Throws:

IOException - If an I/O error occurs.

GeckoDriverService

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

Parameters:

executable - The GeckoDriver executable.

port - Which port to start the GeckoDriver 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 org.openqa.selenium.remote.service.DriverService

getDriverProperty

public String getDriverProperty()

Overrides:

getDriverProperty in class org.openqa.selenium.remote.service.DriverService

getDefaultDriverOptions

public org.openqa.selenium.Capabilities getDefaultDriverOptions()

Overrides:

getDefaultDriverOptions in class org.openqa.selenium.remote.service.DriverService

createDefaultService

public static GeckoDriverService createDefaultService()

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

Returns:

A new GeckoDriverService using the default configuration.

waitUntilAvailable

protected void waitUntilAvailable()

Overrides:

waitUntilAvailable in class org.openqa.selenium.remote.service.DriverService

hasShutdownEndpoint

protected boolean hasShutdownEndpoint()

Overrides:

hasShutdownEndpoint in class org.openqa.selenium.remote.service.DriverService