Package org.openqa.selenium.remote.service

Class DriverService

java.lang.Object

org.openqa.selenium.remote.service.DriverService

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ChromeDriverService, EdgeDriverService, FirefoxDriverService, InternetExplorerDriverService, SafariDriverService, SafariTechPreviewDriverService

public class DriverService
extends Object
implements Closeable

Manages the life and death of a native executable driver server. It is expected that the driver server implements the WebDriver Wire Protocol. In particular, it should implement /status command that is used to check if the server is alive. In addition to this, it is supposed that the driver server implements /shutdown hook that is used to stop the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DriverService.Builder<DS extends DriverService,B extends DriverService.Builder<?,?>>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Duration	DEFAULT_TIMEOUT
static final String	LOG_NULL
static final String	LOG_STDERR
static final String	LOG_STDOUT
protected ExternalProcess	process	A reference to the current child process.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()
protected List<String>	getArgs()
protected Capabilities	getDefaultDriverOptions()
protected File	getDriverExecutable()
protected String	getDriverName()
String	getDriverProperty()
protected Map<String,String>	getEnvironment()
String	getExecutable()
protected OutputStream	getOutputStream()
protected Duration	getTimeout()
URL	getUrl()
protected URL	getUrl(int port)
protected boolean	hasShutdownEndpoint()
boolean	isRunning()	Checks whether the driver child process is currently running.
void	sendOutputTo(OutputStream outputStream)
void	setExecutable(String executable)
void	start()	Starts this service if it is not already running.
void	stop()	Stops this service if it is currently running.
protected void	waitUntilAvailable()

Methods inherited from class java.lang.Object

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

Field Details

LOG_NULL

public static final String LOG_NULL

See Also:

• Constant Field Values

LOG_STDERR

public static final String LOG_STDERR

See Also:

• Constant Field Values

LOG_STDOUT

public static final String LOG_STDOUT

See Also:

• Constant Field Values

DEFAULT_TIMEOUT

protected static final Duration DEFAULT_TIMEOUT

process

protected ExternalProcess process

A reference to the current child process. Will be null whenever this service is not running. Protected by lock.

Constructor Details

DriverService

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

Parameters:

executable - The driver executable.

port - Which port to start the driver server 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

getExecutable

public String getExecutable()

setExecutable

public void setExecutable(String executable)

getArgs

protected List<String> getArgs()

getEnvironment

protected Map<String,String> getEnvironment()

getUrl

protected URL getUrl(int port)
              throws IOException

Throws:

IOException

getDefaultDriverOptions

protected Capabilities getDefaultDriverOptions()

getDriverName

protected String getDriverName()

getDriverProperty

public String getDriverProperty()

getDriverExecutable

protected File getDriverExecutable()

getUrl

public URL getUrl()

Returns:

The base URL for the managed driver server.

isRunning

public boolean isRunning()

Checks whether the driver child process is currently running.

Returns:

Whether the driver child process is still running.

start

public void start()
           throws IOException

Starts this service if it is not already running. This method will block until the server has been fully started and is ready to handle commands.

Throws:

IOException - If an error occurs while spawning the child process.

See Also:

• stop()

getTimeout

protected Duration getTimeout()

waitUntilAvailable

protected void waitUntilAvailable()

stop

public void stop()

Stops this service if it is currently running. This method will attempt to block until the server has been fully shutdown.

See Also:

• start()

hasShutdownEndpoint

protected boolean hasShutdownEndpoint()

sendOutputTo

public void sendOutputTo(OutputStream outputStream)

getOutputStream

protected OutputStream getOutputStream()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable