blueice / jbrowserdriver

A programmable, embedded web browser driver compatible with the Selenium WebDriver spec -- fast, headless, WebKit-based, 100% pure Java, and no browser dependencies

jBrowserDriver

A programmable, embedded web browser driver compatible with the Selenium WebDriver spec -- fast, headless, WebKit-based, 100% pure Java, and no browser dependencies

Licensed under the Apache License v2.0 (details).

Machine Publishers, LLC provides commercial support and consulting for jBrowserDriver.

---

Download

Get a ZIP archive of the latest release.

Or install via Maven:

<dependency>
  <groupId>com.machinepublishers</groupId>
  <artifactId>jbrowserdriver</artifactId>
  <version>[0.12.0, 2.0)</version>
</dependency>

For other install options, see the Central Repository.

Prerequisites

There's no need to install any web browser and this works fine on a server (headless). Java 8 (Oracle JDK/JRE or OpenJDK) is required.

Currently only Java is supported (Scala, Groovy, etc might have compatibility issues--pull requests or paid support could help address this gap). As a workaround for non-Java tech stacks, Selenium Server is recommended.

Linux users: on Debian/Ubuntu install the following, apt-get install openjdk-8-jdk openjfx

Usage

For specific details, refer to the API documentation.

Use this library like any other Selenium WebDriver or RemoteWebDriver. It also works with Selenium Server (use browser name "jbrowserdriver").

You can optionally create a Settings object, configure it, and pass it to the JBrowserDriver constructor to specify a proxy, request headers, time zone, user agent, or navigator details. By default, the browser mimics the fingerprint of Tor Browser.

Settings can alternately be configured using Java system properties or Selenium Capabilities. See Settings builder documentation for details.

Each instance of JBrowserDriver is backed by a separate Java process, so any native browser crashes will not take down your app.

Example:

import org.openqa.selenium.WebDriver;
import com.machinepublishers.jbrowserdriver.Timezone;
import com.machinepublishers.jbrowserdriver.JBrowserDriver;
import com.machinepublishers.jbrowserdriver.Settings;
    
public class Example {
  public static void main(String[] args) {

    // You can optionally pass a Settings object here,
    // constructed using Settings.Builder
    JBrowserDriver driver = new JBrowserDriver(Settings.builder().
      timezone(Timezone.AMERICA_NEWYORK).build());

    // This will block for the page load and any
    // associated AJAX requests
    driver.get("http://example.com");

    // You can get status code unlike other Selenium drivers.
    // It blocks for AJAX requests and page loads after clicks 
    // and keyboard events.
    System.out.println(driver.getStatusCode());

    // Returns the page source in its current state, including
    // any DOM updates that occurred after page load
    System.out.println(driver.getPageSource());
    
    // Close the browser. Allows this thread to terminate.
    driver.quit();
  }
}

Building

Install and configure Maven v3.x (which is also available in most Linux package repos) and then from the project root run mvn clean compile install. To use in Eclipse, either import the existing Java project from the root directory or import the pom.xml file via the M2E plugin. However, if you merely want to use this as a dependency in a separate project, see the Download section.

Contributing

Pull requests are welcome, and we ask contributors to agree to the CLA. Feel free to discuss bugs and new features by opening a new issue.

---

Copyright (C) 2014-2016 Machine Publishers, LLC