org.openqa.selenium.remote.service

Class DriverService

java.lang.Object

org.openqa.selenium.remote.service.DriverService

Direct Known Subclasses:

ChromeDriverService

public class DriverService
extends java.lang.Object

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 and Description
static class	DriverService.Builder<DS extends DriverService,B extends DriverService.Builder>

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.collect.ImmutableList<java.lang.String>	args
private com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>	environment
private java.lang.String	executable
private java.util.concurrent.locks.ReentrantLock	lock Controls access to process.
private CommandLine	process A reference to the current child process.
private java.net.URL	url The base URL for the managed server.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DriverService(java.io.File executable, int port, com.google.common.collect.ImmutableList<java.lang.String> args, com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> environment)

Method Summary

Modifier and Type	Method and Description
protected static void	checkExecutable(java.io.File exe)
protected static java.io.File	findExecutable(java.lang.String exeName, java.lang.String exeProperty, java.lang.String exeDocs, java.lang.String exeDownload)
java.net.URL	getUrl()
boolean	isRunning() Checks whether the driver child process is currently running.
void	start() Starts this service if it is not already running.
void	stop() Stops this service is 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 Detail

url

private final java.net.URL url

The base URL for the managed server.

lock

private final java.util.concurrent.locks.ReentrantLock lock

Controls access to process.

process

private CommandLine process

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

executable

private final java.lang.String executable

args

private final com.google.common.collect.ImmutableList<java.lang.String> args

environment

private final com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> environment

Constructor Detail

DriverService

protected DriverService(java.io.File executable,
                        int port,
                        com.google.common.collect.ImmutableList<java.lang.String> args,
                        com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> environment)
                 throws java.io.IOException

Parameters:

executable - The driver executable.

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

Method Detail

getUrl

public java.net.URL getUrl()

Returns:

The base URL for the managed driver server.

findExecutable

protected static java.io.File findExecutable(java.lang.String exeName,
                                             java.lang.String exeProperty,
                                             java.lang.String exeDocs,
                                             java.lang.String exeDownload)

Parameters:

exeName - Name of the executable file to look for in PATH

exeProperty - Name of a system property that specifies the path to the executable file

exeDocs - The link to the driver documentation page

exeDownload - The link to the driver download page

Returns:

The driver executable as a File object

Throws:

java.lang.IllegalStateException - If the executable not found or cannot be executed

checkExecutable

protected static void checkExecutable(java.io.File exe)

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 java.io.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:

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

See Also:

stop()

waitUntilAvailable

protected void waitUntilAvailable()
                           throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

stop

public void stop()

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

See Also:

start()