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 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_APPEND_LOG_PROPERTY
      System property that defines the ChromiumDriverLogLevel for MSEdgeDriver logs.
      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 MSEdgeDriver executable that will be used by the default service.
      static java.lang.String EDGE_DRIVER_LOG_LEVEL_PROPERTY
      System property that defines the log level when MSEdgeDriver output is logged.
      static java.lang.String EDGE_DRIVER_LOG_PROPERTY
      System property that defines the location of the file where MSEdgeDriver should write log messages to.
      static java.lang.String EDGE_DRIVER_NAME  
      static java.lang.String EDGE_DRIVER_READABLE_TIMESTAMP
      System property that toggles the formatting of the timestamps of the logs
      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 MSEdgeDriver executable should be started with verbose logging.

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

        DEFAULT_TIMEOUT, LOG_NULL, LOG_STDERR, LOG_STDOUT, 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 Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static EdgeDriverService createDefaultService()
      Configures and returns a new EdgeDriverService using the default configuration.
      org.openqa.selenium.Capabilities getDefaultDriverOptions()  
      java.lang.String getDriverName()  
      java.lang.String getDriverProperty()  

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

        close, findExePath, getArgs, getDriverExecutable, getEnvironment, getExecutable, getOutputStream, getTimeout, getUrl, getUrl, hasShutdownEndpoint, isRunning, sendOutputTo, setExecutable, 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_NAME

        public static final java.lang.String EDGE_DRIVER_NAME
        See Also:
        Constant Field Values

      • EDGE_DRIVER_EXE_PROPERTY

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

      • EDGE_DRIVER_READABLE_TIMESTAMP

        public static final java.lang.String EDGE_DRIVER_READABLE_TIMESTAMP
        System property that toggles the formatting of the timestamps of the logs
        See Also:
        Constant Field Values

      • EDGE_DRIVER_LOG_PROPERTY

        public static final java.lang.String EDGE_DRIVER_LOG_PROPERTY
        System property that defines the location of the file where MSEdgeDriver should write log messages to.
        See Also:
        Constant Field Values

      • EDGE_DRIVER_LOG_LEVEL_PROPERTY

        public static final java.lang.String EDGE_DRIVER_LOG_LEVEL_PROPERTY
        System property that defines the log level when MSEdgeDriver output is logged.
        See Also:
        Constant Field Values

      • EDGE_DRIVER_APPEND_LOG_PROPERTY

        public static final java.lang.String EDGE_DRIVER_APPEND_LOG_PROPERTY
        System property that defines the ChromiumDriverLogLevel for MSEdgeDriver logs.
        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 MSEdgeDriver 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 MSEdgeDriver executable.
        port - Which port to start the MSEdgeDriver 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

      • getDriverName

        public java.lang.String getDriverName()
        Overrides:
        getDriverName in class org.openqa.selenium.remote.service.DriverService

      • getDriverProperty

        public java.lang.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 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 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 EdgeDriverService using the default configuration.