Constructor Detail

• RemoteWebDriver

  protected RemoteWebDriver()

• RemoteWebDriver

  public RemoteWebDriver(CommandExecutor executor,
                 Capabilities desiredCapabilities,
                 Capabilities requiredCapabilities)

• RemoteWebDriver

  public RemoteWebDriver(CommandExecutor executor,
                 Capabilities desiredCapabilities)

• RemoteWebDriver

  public RemoteWebDriver(Capabilities desiredCapabilities)

• RemoteWebDriver

  public RemoteWebDriver(java.net.URL remoteAddress,
                 Capabilities desiredCapabilities,
                 Capabilities requiredCapabilities)

• RemoteWebDriver

  public RemoteWebDriver(java.net.URL remoteAddress,
                 Capabilities desiredCapabilities)

Method Detail

• setFileDetector

  public void setFileDetector(FileDetector detector)

  Set the file detector to be used when sending keyboard input. By default, this is set to a file detector that does nothing.

  Parameters:

  detector - The detector to use. Must not be null.

  See Also:

  FileDetector, LocalFileDetector, UselessFileDetector

• getSessionId

  public SessionId getSessionId()

• setSessionId

  protected void setSessionId(java.lang.String opaqueKey)

• startSession

  protected void startSession(Capabilities desiredCapabilities)

• startSession

  protected void startSession(Capabilities desiredCapabilities,
                  Capabilities requiredCapabilities)

• startClient

  protected void startClient()

  Method called before starting a new session. The default implementation is a no-op, but subtypes should override this method to define custom behavior.

• stopClient

  protected void stopClient()

  Method called after executing a quit() command. Subtypes

• getErrorHandler

  public ErrorHandler getErrorHandler()

• setErrorHandler

  public void setErrorHandler(ErrorHandler handler)

• getCommandExecutor

  public CommandExecutor getCommandExecutor()

• setCommandExecutor

  protected void setCommandExecutor(CommandExecutor executor)

• getCapabilities

  public Capabilities getCapabilities()

  Specified by:

  getCapabilities in interface HasCapabilities

  Returns:

  The capabilities of the current driver.

• get

  public void get(java.lang.String url)

  Description copied from interface: WebDriver
  Load a new web page in the current browser window. This is done using an HTTP GET operation, and the method will block until the load is complete. This will follow redirects issued either by the server or as a meta-redirect from within the returned HTML. Should a meta-redirect "rest" for any duration of time, it is best to wait until this timeout is over, since should the underlying page change whilst your test is executing the results of future calls against this interface will be against the freshly loaded page. Synonym for WebDriver.Navigation.to(String).

  Specified by:

  get in interface WebDriver

  Parameters:

  url - The URL to load. It is best to use a fully qualified URL

• getTitle

  public java.lang.String getTitle()

  Description copied from interface: WebDriver
  The title of the current page.

  Specified by:

  getTitle in interface WebDriver

  Returns:

  The title of the current page, with leading and trailing whitespace stripped, or null if one is not already set

• getCurrentUrl

  public java.lang.String getCurrentUrl()

  Description copied from interface: WebDriver
  Get a string representing the current URL that the browser is looking at.

  Specified by:

  getCurrentUrl in interface WebDriver

  Returns:

  The URL of the page currently loaded in the browser

• getScreenshotAs

  public <X> X getScreenshotAs(OutputType<X> outputType)
                    throws WebDriverException

  Description copied from interface: TakesScreenshot
  Capture the screenshot and store it in the specified location.

  For WebDriver extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference:

  • Entire page
  • Current window
  • Visible portion of the current frame
  • The screenshot of the entire display containing the browser

  For WebElement extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference: - The entire content of the HTML element - The visisble portion of the HTML element

  Specified by:

  getScreenshotAs in interface TakesScreenshot

  Type Parameters:

  X - Return type for getScreenshotAs.

  Parameters:

  outputType - target type, @see OutputType

  Returns:

  Object in which is stored information about the screenshot.

  Throws:

  WebDriverException - on failure.

• findElements

  public java.util.List<WebElement> findElements(By by)

  Description copied from interface: WebDriver
  Find all elements within the current page using the given mechanism. This method is affected by the 'implicit wait' times in force at the time of execution. When implicitly waiting, this method will return as soon as there are more than 0 items in the found collection, or will return an empty list if the timeout is reached.

  Specified by:

  findElements in interface SearchContext

  Specified by:

  findElements in interface WebDriver

  Parameters:

  by - The locating mechanism to use

  Returns:

  A list of all WebElements, or an empty list if nothing matches

  See Also:

  By, WebDriver.Timeouts

• findElement

  public WebElement findElement(By by)

  Description copied from interface: WebDriver
  Find the first WebElement using the given method. This method is affected by the 'implicit wait' times in force at the time of execution. The findElement(..) invocation will return a matching row, or try again repeatedly until the configured timeout is reached. findElement should not be used to look for non-present elements, use WebDriver.findElements(By) and assert zero length response instead.

  Specified by:

  findElement in interface SearchContext

  Specified by:

  findElement in interface WebDriver

  Parameters:

  by - The locating mechanism

  Returns:

  The first matching element on the current page

  See Also:

  By, WebDriver.Timeouts

• findElement

  protected WebElement findElement(java.lang.String by,
                       java.lang.String using)

• setFoundBy

  protected void setFoundBy(SearchContext context,
                WebElement element,
                java.lang.String by,
                java.lang.String using)

• findElements

  protected java.util.List<WebElement> findElements(java.lang.String by,
                                        java.lang.String using)

• findElementById

  public WebElement findElementById(java.lang.String using)

  Specified by:

  findElementById in interface FindsById

• findElementsById

  public java.util.List<WebElement> findElementsById(java.lang.String using)

  Specified by:

  findElementsById in interface FindsById

• findElementByLinkText

  public WebElement findElementByLinkText(java.lang.String using)

  Specified by:

  findElementByLinkText in interface FindsByLinkText

• findElementsByLinkText

  public java.util.List<WebElement> findElementsByLinkText(java.lang.String using)

  Specified by:

  findElementsByLinkText in interface FindsByLinkText

• findElementByPartialLinkText

  public WebElement findElementByPartialLinkText(java.lang.String using)

  Specified by:

  findElementByPartialLinkText in interface FindsByLinkText

• findElementsByPartialLinkText

  public java.util.List<WebElement> findElementsByPartialLinkText(java.lang.String using)

  Specified by:

  findElementsByPartialLinkText in interface FindsByLinkText

• findElementByTagName

  public WebElement findElementByTagName(java.lang.String using)

  Specified by:

  findElementByTagName in interface FindsByTagName

• findElementsByTagName

  public java.util.List<WebElement> findElementsByTagName(java.lang.String using)

  Specified by:

  findElementsByTagName in interface FindsByTagName

• findElementByName

  public WebElement findElementByName(java.lang.String using)

  Specified by:

  findElementByName in interface FindsByName

• findElementsByName

  public java.util.List<WebElement> findElementsByName(java.lang.String using)

  Specified by:

  findElementsByName in interface FindsByName

• findElementByClassName

  public WebElement findElementByClassName(java.lang.String using)

  Specified by:

  findElementByClassName in interface FindsByClassName

• findElementsByClassName

  public java.util.List<WebElement> findElementsByClassName(java.lang.String using)

  Specified by:

  findElementsByClassName in interface FindsByClassName

• findElementByCssSelector

  public WebElement findElementByCssSelector(java.lang.String using)

  Specified by:

  findElementByCssSelector in interface FindsByCssSelector

• findElementsByCssSelector

  public java.util.List<WebElement> findElementsByCssSelector(java.lang.String using)

  Specified by:

  findElementsByCssSelector in interface FindsByCssSelector

• findElementByXPath

  public WebElement findElementByXPath(java.lang.String using)

  Specified by:

  findElementByXPath in interface FindsByXPath

• findElementsByXPath

  public java.util.List<WebElement> findElementsByXPath(java.lang.String using)

  Specified by:

  findElementsByXPath in interface FindsByXPath

• getPageSource

  public java.lang.String getPageSource()

  Description copied from interface: WebDriver
  Get the source of the last loaded page. If the page has been modified after loading (for example, by Javascript) there is no guarantee that the returned text is that of the modified page. Please consult the documentation of the particular driver being used to determine whether the returned text reflects the current state of the page or the text last sent by the web server. The page source returned is a representation of the underlying DOM: do not expect it to be formatted or escaped in the same way as the response sent from the web server. Think of it as an artist's impression.

  Specified by:

  getPageSource in interface WebDriver

  Returns:

  The source of the current page

• close

  public void close()

  Description copied from interface: WebDriver
  Close the current window, quitting the browser if it's the last window currently open.

  Specified by:

  close in interface WebDriver

• quit

  public void quit()

  Description copied from interface: WebDriver
  Quits this driver, closing every associated window.

  Specified by:

  quit in interface WebDriver

• getWindowHandles

  public java.util.Set<java.lang.String> getWindowHandles()

  Description copied from interface: WebDriver
  Return a set of window handles which can be used to iterate over all open windows of this WebDriver instance by passing them to WebDriver.switchTo().WebDriver.Options.window()

  Specified by:

  getWindowHandles in interface WebDriver

  Returns:

  A set of window handles which can be used to iterate over all open windows.

• getWindowHandle

  public java.lang.String getWindowHandle()

  Description copied from interface: WebDriver
  Return an opaque handle to this window that uniquely identifies it within this driver instance. This can be used to switch to this window at a later date

  Specified by:

  getWindowHandle in interface WebDriver

• executeScript

  public java.lang.Object executeScript(java.lang.String script,
                               java.lang.Object... args)

  Description copied from interface: JavascriptExecutor
  Executes JavaScript in the context of the currently selected frame or window. The script fragment provided will be executed as the body of an anonymous function.

  Within the script, use document to refer to the current document. Note that local variables will not be available once the script has finished executing, though global variables will persist.

  If the script has a return value (i.e. if the script contains a return statement), then the following steps will be taken:

  • For an HTML element, this method returns a WebElement
  • For a decimal, a Double is returned
  • For a non-decimal number, a Long is returned
  • For a boolean, a Boolean is returned
  • For all other cases, a String is returned.
  • For an array, return a List<Object> with each object following the rules above. We support nested lists.
  • Unless the value is null or there is no return value, in which null is returned

  Arguments must be a number, a boolean, a String, WebElement, or a List of any combination of the above. An exception will be thrown if the arguments do not meet these criteria. The arguments will be made available to the JavaScript via the "arguments" magic variable, as if the function were called via "Function.apply"

  Specified by:

  executeScript in interface JavascriptExecutor

  Parameters:

  script - The JavaScript to execute

  args - The arguments to the script. May be empty

  Returns:

  One of Boolean, Long, String, List or WebElement. Or null.

• executeAsyncScript

  public java.lang.Object executeAsyncScript(java.lang.String script,
                                    java.lang.Object... args)

  Description copied from interface: JavascriptExecutor
  Execute an asynchronous piece of JavaScript in the context of the currently selected frame or window. Unlike executing synchronous JavaScript, scripts executed with this method must explicitly signal they are finished by invoking the provided callback. This callback is always injected into the executed function as the last argument.

  The first argument passed to the callback function will be used as the script's result. This value will be handled as follows:

  • For an HTML element, this method returns a WebElement
  • For a number, a Long is returned
  • For a boolean, a Boolean is returned
  • For all other cases, a String is returned.
  • For an array, return a List<Object> with each object following the rules above. We support nested lists.
  • Unless the value is null or there is no return value, in which null is returned

  The default timeout for a script to be executed is 0ms. In most cases, including the examples below, one must set the script timeout WebDriver.Timeouts.setScriptTimeout(long, java.util.concurrent.TimeUnit) beforehand to a value sufficiently large enough.

  Example #1: Performing a sleep in the browser under test.

  long start = System.currentTimeMillis();
     ((JavascriptExecutor) driver).executeAsyncScript(
         "window.setTimeout(arguments[arguments.length - 1], 500);");
     System.out.println(
         "Elapsed time: " + System.currentTimeMillis() - start);
   

  Example #2: Synchronizing a test with an AJAX application:

  WebElement composeButton = driver.findElement(By.id("compose-button"));
     composeButton.click();
     ((JavascriptExecutor) driver).executeAsyncScript(
         "var callback = arguments[arguments.length - 1];" +
         "mailClient.getComposeWindowWidget().onload(callback);");
     driver.switchTo().frame("composeWidget");
     driver.findElement(By.id("to")).sendKeys("[email protected]");
   

  Example #3: Injecting a XMLHttpRequest and waiting for the result:

  Object response = ((JavascriptExecutor) driver).executeAsyncScript(
         "var callback = arguments[arguments.length - 1];" +
         "var xhr = new XMLHttpRequest();" +
         "xhr.open('GET', '/resource/data.json', true);" +
         "xhr.onreadystatechange = function() {" +
         "  if (xhr.readyState == 4) {" +
         "    callback(xhr.responseText);" +
         "  }" +
         "};" +
         "xhr.send();");
     JsonObject json = new JsonParser().parse((String) response);
     assertEquals("cheese", json.get("food").getAsString());
   

  Script arguments must be a number, a boolean, a String, WebElement, or a List of any combination of the above. An exception will be thrown if the arguments do not meet these criteria. The arguments will be made available to the JavaScript via the "arguments" variable.

  Specified by:

  executeAsyncScript in interface JavascriptExecutor

  Parameters:

  script - The JavaScript to execute.

  args - The arguments to the script. May be empty.

  Returns:

  One of Boolean, Long, String, List, WebElement, or null.

  See Also:

  WebDriver.Timeouts.setScriptTimeout(long, java.util.concurrent.TimeUnit)

• switchTo

  public WebDriver.TargetLocator switchTo()

  Description copied from interface: WebDriver
  Send future commands to a different frame or window.

  Specified by:

  switchTo in interface WebDriver

  Returns:

  A TargetLocator which can be used to select a frame or window

  See Also:

  WebDriver.TargetLocator

• navigate

  public WebDriver.Navigation navigate()

  Description copied from interface: WebDriver
  An abstraction allowing the driver to access the browser's history and to navigate to a given URL.

  Specified by:

  navigate in interface WebDriver

  Returns:

  A WebDriver.Navigation that allows the selection of what to do next

• manage

  public WebDriver.Options manage()

  Description copied from interface: WebDriver
  Gets the Option interface

  Specified by:

  manage in interface WebDriver

  Returns:

  An option interface

  See Also:

  WebDriver.Options

• setElementConverter

  protected void setElementConverter(org.openqa.selenium.remote.internal.JsonToWebElementConverter converter)

• getElementConverter

  protected org.openqa.selenium.remote.internal.JsonToWebElementConverter getElementConverter()

• setLogLevel

  public void setLogLevel(java.util.logging.Level level)

  Sets the RemoteWebDriver's client log level.

  Parameters:

  level - The log level to use.

• execute

  protected Response execute(java.lang.String driverCommand,
                 java.util.Map<java.lang.String,?> parameters)

• execute

  protected Response execute(java.lang.String command)

• getExecuteMethod

  protected ExecuteMethod getExecuteMethod()

• getKeyboard

  public Keyboard getKeyboard()

  Specified by:

  getKeyboard in interface HasInputDevices

• getMouse

  public Mouse getMouse()

  Specified by:

  getMouse in interface HasInputDevices

• log

  protected void log(SessionId sessionId,
         java.lang.String commandName,
         java.lang.Object toLog,
         RemoteWebDriver.When when)

  Override this to be notified at key points in the execution of a command.

  Parameters:

  sessionId - the session id.

  commandName - the command that is being executed.

  toLog - any data that might be interesting.

• getFileDetector

  public FileDetector getFileDetector()

• toString

  public java.lang.String toString()

  Overrides:

  toString in class java.lang.Object