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:

java.io.Closeable, java.lang.AutoCloseable

public class GeckoDriverService
extends FirefoxDriverService

Manages the life and death of an GeckoDriver aka 'wires'.

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 java.lang.String	GECKO_DRIVER_EXE_PROPERTY	System property that defines the location of the GeckoDriver executable that will be used by the default service.

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

DEFAULT_TIMEOUT, process

Constructor Summary

Constructors

Constructor	Description
GeckoDriverService(java.io.File executable, int port, java.time.Duration timeout, java.util.List<java.lang.String> args, java.util.Map<java.lang.String,java.lang.String> environment)
GeckoDriverService(java.io.File executable, int port, java.util.List<java.lang.String> args, java.util.Map<java.lang.String,java.lang.String> environment)

Method Summary

Modifier and Type	Method	Description
static GeckoDriverService	createDefaultService()	Configures and returns a new GeckoDriverService using the default configuration.
protected boolean	hasShutdownEndpoint()
protected void	waitUntilAvailable()

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

checkExecutable, close, findExecutable, getArgs, getEnvironment, getOutputStream, getTimeout, getUrl, getUrl, isRunning, sendOutputTo, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

GECKO_DRIVER_EXE_PROPERTY

public static final java.lang.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

Constructor Detail

GeckoDriverService

public GeckoDriverService(java.io.File executable,
                          int port,
                          java.util.List<java.lang.String> args,
                          java.util.Map<java.lang.String,java.lang.String> environment)
                   throws java.io.IOException

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:

java.io.IOException - If an I/O error occurs.

GeckoDriverService

public GeckoDriverService(java.io.File executable,
                          int port,
                          java.time.Duration timeout,
                          java.util.List<java.lang.String> args,
                          java.util.Map<java.lang.String,java.lang.String> environment)
                   throws java.io.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:

java.io.IOException - If an I/O error occurs.

Method Detail

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 GECKO_DRIVER_EXE_PROPERTY system property. 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