continuum-java 6.5.0-SNAPSHOT API

Getting Started

Setup

First thing's first: you'll need make sure you have a continuum.json file located somewhere on your file system. Here's what a basic continuum.json file looks like, taken from one of our Continuum sample projects:


    {
      "accessEngineType": "professional",
      "ampInstanceUrl": "https://amp.levelaccess.net",
      "defaultStandardIds": [
        610, /* WCAG 2.0 Level A */
        611, /* WCAG 2.0 Level AA */
        612, /* WCAG 2.0 Level AAA */
        1387, /* WCAG 2.1 Level A */
        1388, /* WCAG 2.1 Level AA */
        1389, /* WCAG 2.1 Level AAA */
        1140, /* Section 508 and 255 (Revised 2017) */
        1471 /* WCAG 2.0 Level A & AA Baseline */
      ],
      "includePotentialAccessibilityConcerns": false,
      "ampApiToken": null,

      "proxy": {
        "host": null,
        "port": null,
        "username": null,
        "password": null
      }
    }
    

Next, you'll want to create a new instance of the Continuum class, specifying an absolute path to your continuum.json file:


        com.levelaccess.continuum.Continuum continuum = new com.levelaccess.continuum.Continuum("path/to/continuum.json");
    

You'll then want to invoke the setUp method of your new instance of Continuum using an instance of Selenium WebDriver for the browser of your choice. Here's the Selenium documentation for initializing WebDriver. With Continuum in the picture, it basically all boils down to this:


        org.openqa.selenium.WebDriver driver = new org.openqa.selenium.chrome.ChromeDriver();
        continuum.setUp(driver);
    

Optionally, we recommend using an existing Java library to manage your web drivers, like this one. This way you shouldn't need to include or rely on a particular (outdated) version of any driver; the latest version can be downloaded automatically at runtime as necessary.

The same instance of WebDriver and Continuum can be reused across multiple tests to cut down on initialization time. If for some reason you need to switch out drivers, remember to invoke Continuum's setUp method again, passing in the new driver instance.

Usage

At this point, Continuum is initialized and good to go. You can now use Selenium however you'd like, e.g. by using the driver you initialized to navigate to a particular URL that you'd like to test for accessibility:


        driver.get("http://www.google.com");
    

Once you've navigated to the page you'd like to test, invoke the appropriate Continuum method (all of which execute synchronously). For example, to run all available accessibility tests against the entirety of the current page:


        List<com.levelaccess.continuum.AccessibilityConcern> accessibilityConcerns = continuum.runAllTests();
    

You can then do whatever you like with any accessibility concerns returned, like print them out to the console, filter them for only the ones you're interested in, etc. Check out our documentation for the AccessibilityConcern class for a complete list of what's returned for each accessibility concern.

Other Continuum methods are available that allow you to only run particular tests or test against specific best practices. Continuum also allows you to only test a particular part of a page rather than the entire page. All of these methods are detailed in our documentation for the Continuum class. You have the power!

Support

Questions can be emailed to Level Access support at support@levelaccess.com.

Packages
Package
Description