Package org.openqa.selenium.edge

Class EdgeDriverService

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public class EdgeDriverService
extends org.openqa.selenium.remote.service.DriverService
    Manages the life and death of the EdgeDriver (MicrosoftWebDriver or MSEdgeDriver).

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String EDGE_DRIVER_ALLOWED_IPS_PROPERTY
      System property that defines comma-separated list of remote IPv4 addresses which are allowed to connect to MSEdgeDriver.
      static java.lang.String EDGE_DRIVER_DISABLE_BUILD_CHECK
      System property that defines whether the MSEdgeDriver executable should check for build version compatibility between MSEdgeDriver and the browser.
      static java.lang.String EDGE_DRIVER_EXE_PROPERTY
      System property that defines the location of the EdgeDriver executable that will be used by the default service.
      static java.lang.String EDGE_DRIVER_LOG_PROPERTY
      System property that defines the default location where MicrosoftWebDriver output is logged.
      static java.lang.String EDGE_DRIVER_SILENT_OUTPUT_PROPERTY
      Boolean system property that defines whether the MSEdgeDriver executable should be started in silent mode.
      static java.lang.String EDGE_DRIVER_VERBOSE_LOG_PROPERTY
      Boolean system property that defines whether the MicrosoftWebDriver executable should be started with verbose logging.

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

        DEFAULT_TIMEOUT, process

    • Constructor Summary

      Constructors 
      Constructor Description
      EdgeDriverService​(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)  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static EdgeDriverService createDefaultService()
      Configures and returns a new EdgeDriverService using the default configuration.

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

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

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • EDGE_DRIVER_EXE_PROPERTY

        public static final java.lang.String EDGE_DRIVER_EXE_PROPERTY
        System property that defines the location of the EdgeDriver executable that will be used by the default service.
        See Also:
        Constant Field Values

      • EDGE_DRIVER_LOG_PROPERTY

        public static final java.lang.String EDGE_DRIVER_LOG_PROPERTY
        System property that defines the default location where MicrosoftWebDriver output is logged.
        See Also:
        Constant Field Values

      • EDGE_DRIVER_VERBOSE_LOG_PROPERTY

        public static final java.lang.String EDGE_DRIVER_VERBOSE_LOG_PROPERTY
        Boolean system property that defines whether the MicrosoftWebDriver executable should be started with verbose logging.
        See Also:
        Constant Field Values

      • EDGE_DRIVER_SILENT_OUTPUT_PROPERTY

        public static final java.lang.String EDGE_DRIVER_SILENT_OUTPUT_PROPERTY
        Boolean system property that defines whether the MSEdgeDriver executable should be started in silent mode.
        See Also:
        Constant Field Values

      • EDGE_DRIVER_ALLOWED_IPS_PROPERTY

        public static final java.lang.String EDGE_DRIVER_ALLOWED_IPS_PROPERTY
        System property that defines comma-separated list of remote IPv4 addresses which are allowed to connect to MSEdgeDriver.
        See Also:
        Constant Field Values

      • EDGE_DRIVER_DISABLE_BUILD_CHECK

        public static final java.lang.String EDGE_DRIVER_DISABLE_BUILD_CHECK
        System property that defines whether the MSEdgeDriver executable should check for build version compatibility between MSEdgeDriver and the browser.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EdgeDriverService

        public EdgeDriverService​(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 EdgeDriver executable.
        port - Which port to start the EdgeDriver 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 EdgeDriverService createDefaultService()
        Configures and returns a new EdgeDriverService using the default configuration. In this configuration, the service will use the MSEdgeDriver executable identified by the EDGE_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 ChromiumEdgeDriverService using the default configuration.