All Classes and Interfaces

Class
Description
Abstract class to work with fields in Page Objects.
 
 
A command codec that adheres to the W3C's WebDriver wire protocol.
 
A response codec usable as a base for both the JSON and W3C wire protocols.
 
Interface representing a single user-interaction action.
The user-facing API for emulating complex user gestures.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Used to allow a CommandExecutor using HTTP to find additional commands that should be supported.
 
 
 
Deprecated.
An element locator that will wait for the specified number of seconds for an element to appear, rather than failing instantly if it's not present.
 
 
A form of Config that is generated by looking at fields in the constructor arg that are annotated with ConfigValue.
 
Deprecated.
Represents the known architectures used in WebDriver.
 
 
 
Indicates that a class can be processed by Augmenter.
Enhance the interfaces implemented by an instance of the WebDriver based on the returned Capabilities of the driver.
Describes and provides an implementation for a particular interface for use with the Augmenter.
 
 
 
 
 
 
 
 
 
Indicates that a feature or API is in active development, and so should not be relied upon.
 
 
 
 
 
 
 
 
 
Used to identify a browser based on its name.
 
 
 
 
 
Reads information about how the current application was built.
Mechanism used to locate elements within a document.
 
 
 
 
 
 
 
 
 
 
Mechanism used to locate elements within a document using a series of lookups.
Mechanism used to locate elements within a document using a series of other lookups.
 
 
 
Marker annotation to be applied to WebElements to indicate that it never changes (that is, that the same instance in the DOM will always be used)
Describes a series of key/value pairs that encapsulate aspects of a browser.
 
 
 
Commonly seen remote webdriver capabilities.
 
 
 
 
 
 
 
 
 
A WebDriver implementation that controls a Chrome browser running on the local machine.
 
Manages the life and death of a ChromeDriver server.
Builder used to configure new ChromeDriverService instances.
Class to manage options specific to ChromeDriver.
A WebDriver implementation that controls a Chromium browser running on the local machine.
DriverCommandExecutor that understands ChromiumDriver specific commands.
 
Log levels defined by ChromeDriver
Provides manipulation of getting and setting network conditions from Chromium.
Class to manage options specific to ChromiumDriver.
Captures the last N bytes of output.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Converts Command objects to and from another representation.
 
 
Deprecated.
 
 
An action for aggregating actions and triggering all of them at the same time.
 
 
 
 
 
 
A config value is read by an AnnotatedConfig to automatically allow a Config to be created.
 
 
Exception thrown when the connection to the SafariDriver is lost.
 
 
 
 
 
 
 
 
 
A supplier that can be called multiple times, each invocation must return a new InputStream ready to read.
Deprecated.
 
 
 
 
 
 
 
 
 
Provides coordinates of an element for advanced interactions.
 
 
 
A credential stored in a virtual authenticator.
Marker interface for credentials used for authenticating a browser to a site, typically via UsernameAndPassword and Basic or Digest authentication.
Allows servers to add additional locator strategies to the Selenium Server.
 
Used to provide information about whether Selenium is running under debug mode.
 
 
 
The default element locator, which will lazily locate an element or an element list on a page.
 
Default decorator for use with PageFactory.
 
Default matching implementation for slots, loosely based on the requirements for capability matching from the WebDriver spec.
 
 
Represents a configurable attribute of the Selenium Grid.
 
Indicates that a reference to a shadow root is now "detached" --- the element no longer appears on the DOM of the page.
 
Defines an object which represents the three dimensional plane and how a device can be rotated about it.
 
 
 
 
Similar to Point - implement locally to avoid depending on GWT.
Responsible for being the central place where the Nodes on which Sessions run are determined.
 
 
 
 
 
 
 
 
 
 
 
 
The idealized set of CDP domains that Selenium itself needs.
 
 
 
An empty interface defining constants for the standard commands defined in the WebDriver JSON wire protocol.
A specialized HttpCommandExecutor that will use a DriverService that lives and dies with a single WebDriver session.
 
Manages the life and death of a native executable driver server.
 
 
 
A WebDriver implementation that controls an Edge browser running on the local machine.
 
Manages the life and death of the MSEdgeDriver
Builder used to configure new EdgeDriverService instances.
Class to manage options specific to EdgeDriver.
 
Indicates that a click could not be properly executed because the target element was obscured in some way.
 
 
A factory for producing ElementLocators.
Thrown to indicate that although a WebElement is present on the DOM, it is not in a state that can be interacted with.
 
This interface allows a custom Interaction to be JSON encoded for the W3C wire format.
 
 
EnumCoercer<T extends Enum>
 
Exposes environment variables as config settings by mapping "section.option" to "SECTION_OPTION".
Identifies the ephemeral port range for a given environment.
 
Deprecated, for removal: This API element is subject to removal in a future version.
 
Maps exceptions to status codes for sending over the wire.
Exception used as a place holder if the server returns an error without a stack trace.
 
 
 
 
 
 
 
 
 
 
 
This decorator creates a wrapper around an arbitrary WebDriver instance that notifies registered listeners about events happening in this WebDriver and derived objects, such as WebElements and Alert.
 
 
 
 
 
 
 
 
Models a condition that might reasonably be expected to eventually evaluate to something that is neither null nor false.
Canned ExpectedConditions which are generally useful within webdriver tests.
 
 
 
Represents an account displayed in a FedCM account list.
Represents an open dialog of the Federated Credential Management API.
 
 
Allows the PageFactory to decorate fields.
Used for identifying whether a sequence of chars represents the path to a file.
 
Utility methods for common filesystem activities
Can be wrapped around an HttpHandler in order to either modify incoming HttpRequests or outgoing HttpResponses using the well-known "Filter" pattern.
 
Used to mark a field on a Page Object to indicate that lookup should use a series of @FindBy tags It will then search for all elements that match any of the FindBy criteria.
 
Used to mark a field on a Page Object to indicate an alternative mechanism for locating the element or a list of elements.
 
Used to mark a field on a Page Object to indicate that lookup should use a series of @FindBy tags in a chain as described in ByChained
 
Enumerates Firefox channels, according to https://wiki.mozilla.org/RapidRelease
Represents the valid values for the command context used for executing Firefox driver commands.
An implementation of the {#link WebDriver} interface that drives Firefox.
 
Log levels defined by GeckoDriver
 
 
Manage firefox specific settings in a way that geckodriver can understand.
 
 
An implementation of the Wait interface that may have its timeout and polling interval configured on the fly.
Deprecated, for removal: This API element is subject to removal in a future version.
 
Manages the life and death of an GeckoDriver
Builder used to configure new GeckoDriverService instances.
 
 
 
 
 
 
 
 
Meant to be used together with {#link @ScheduledExecutedService.scheduleAtFixedRate}.
 
 
Indicates that a driver supports authenticating to a website in some way.
 
Used by classes to indicate that they can describe the Capabilities they possess.
Used by classes to indicate that they can cast devices to available sink targets.
Used by classes to indicate that they can execute Command DevTools commands.
Used by classes to indicate that they can change the context commands operate in.
Used by classes to indicate that they can open the browser debugger.
 
Indicates that a driver supports downloading remote files.
Used by classes to indicate that they can install and uninstall browser extensions on the fly.
Used by classes to indicate that they can interact with FedCM dialogs.
Used by classes to indicate that they can take a full page screenshot.
Used by classes to indicate that they can launch a Chromium app.
Allows an implementation of something to be marked as startable and stoppable, allowing its lifecycle to be controlled.
 
Used by classes to indicate that they can simulate different network conditions.
Used by classes to indicate that they can adjust permissions compatible items.
Used by classes to indicate that they can take adjust permissions.
 
 
Interface implemented by each driver that allows access to the virtual authenticator API.
 
 
 
Indicates that a Node health check failed.
 
 
 
Defines a simple client for making HTTP requests.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Models an input source as defined and used by the W3C WebDriver spec.
Indicates that navigation caused by the user agent hit a certificate warning, which is usually the result of an expired or invalid TLS certificate.
 
Used as the basis of Sequences for the W3C WebDriver spec Action commands.
Indicates that a class can be used with the W3C WebDriver Actions commands.
 
 
 
 
Manages the life and death of an IEDriverServer.
Builder used to configure new InternetExplorerDriverService instances.
Options for configuring the use of IE.
 
Thrown when attempting to add a cookie under a different domain than the current URL.
Indicates that a WebElement is in a state that means actions cannot be performed with it.
 
Created by evgeniyat on 13.05.16
 
 
 
Indicates that a driver can execute JavaScript, providing access to the mechanism to do so.
 
 
 
 
The Json class is the entrypoint for the JSON processing features of the Selenium API.
 
 
The JsonInput class defines the operations used to deserialize JSON strings into Java objects.
The JsonOutput class defines the operations used to serialize Java objects into JSON strings.
Reconstitutes WebElements from their JSON representation.
Used to specify the pending JSON element type.
Representations of pressable keys that aren't text.
 
Represents any abstraction of something that can be loaded.
 
Detects files on the local disk.
Stores and retrieves logs in-process (i.e.
An in-memory implementation of the list of new session requests.
 
 
 
 
Deprecated.
 
 
 
Deprecated, for removal: This API element is subject to removal in a future version.
Use the chaining of LocateNodeParameters methods to add optional parameters.
 
 
Deprecated.
Deprecated.
This functionality is no longer supported
 
 
 
 
Represent a pool of LogEntry.
 
 
Represents a single log statement.
 
A custom handler used to record log entries.
 
Represents the logging preferences.
 
 
 
Interface for providing logs.
Supported log types.
 
 
 
 
 
 
 
 
 
 
 
 
Indicates that the target provided to the actions move() method is invalid - outside of the size of the window.
Output stream demultiplexer
 
 
 
 
 
 
 
 
Deprecated.
ConnectionType is a bitmask to represent a device's network connection
Provides a mechanism for stubbing out responses to requests in drivers which implement HasDevTools.
 
Provides information about the local network interfaces.
 
 
 
 
 
 
 
 
 
 
Indicates that a user has tried to access an alert when one is not present.
 
A place where individual webdriver sessions are running.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A form of Config that is generated by looking at fields in the constructor arg that are annotated with ConfigValue.
 
 
Deprecated.
 
Thrown by org.openqa.selenium.remote.service.DriverFinder#getResult(DriverService, Capabilities).
Thrown by any command being called after WebDriver.quit().
Indicates that an element does not have a shadow root.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Defines the output type for a screenshot.
Factory class to make using Page Objects simpler and easier.
 
 
 
 
 
 
 
 
Indicates that a given InputSource should pause for a given duration.
 
 
Represents the known and supported Platforms that WebDriver runs on.
A copy of java.awt.Point, to remove dependency on awt.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Used to specify the strategy used to assign values during deserialization.
 
 
 
Configuration parameters for using proxies in WebDriver.
 
 
 
 
 
 
 
 
 
 
Used for finding elements by their location on a page, rather than their position on the DOM.
 
 
 
 
 
 
 
 
Deprecated.
LocalStorage can be managed by executing JavaScript.
Deprecated.
This functionality is no longer supported
 
Deprecated.
This functionality is no longer supported
 
 
 
 
 
Abstract class designed to do things like protocol conversion.
 
 
Deprecated.
LocalStorage can be managed by executing JavaScript.
Deprecated, for removal: This API element is subject to removal in a future version.
 
 
 
 
Create a new Selenium session using the W3C WebDriver protocol.
 
Provides remote access to the WebStorage API.
 
 
 
 
A utility class to check arguments (preconditions) and state.
 
 
 
 
 
 
 
 
 
 
Converts Response objects to and from another representation.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A simple router that is aware of the selenium-protocol.
 
 
 
A WebDriver implementation that controls Safari using a browser extension (consequently, only Safari 5.1+ is supported).
 
Manages the life and death of SafariDriver.
Builder used to configure new SafariDriverService instances.
Class to manage options specific to SafariDriver.
 
Manages the life and death of SafariDriver Technology Preview.
Builder used to configure new SafariTechPreviewDriverService instances.
Represents possible screen orientations.
 
 
 
 
Thrown when an async execute script command does not complete in enough time.
 
 
 
Models a SELECT tag, providing helper methods to select and deselect options.
 
This implementation is still in beta, and may change.
 
 
 
 
A sequence of action objects for a given InputSource for use with the W3C Action commands.
 
 
Server<T extends Server>
 
 
 
 
Represents a running instance of a WebDriver session.
 
 
 
 
 
 
 
Unique identifier of attached debugging session.
 
Contains the logs for a session divided by supported log types.
Provides a stable API for looking up where on the Grid a particular webdriver instance is running.
 
 
 
Indicates that a session could not be created.
 
 
 
 
Deprecated.
 
 
 
 
Abstraction around Thread.sleep(long) to permit better testability.
 
 
 
Used to determine how a Slot can match its stereotype to the capabilities sent in a particular New Session request.
Used to determine which Node to send a particular New Session request to.
A LoadableComponent which might not have finished loading when load() returns.
 
One of the allowing types for an InputSource.
 
 
 
 
 
 
 
 
 
Indicates that a reference to an element is now "stale" --- the element no longer appears on the DOM of the page.
 
 
 
 
 
 
An HttpHandler that obeys the contracted required by a Kubernetes health check, but which reads a selenium `/status` endpoint.
 
Deprecated.
 
 
 
Indicates a driver or an HTML element that can capture a screenshot and store it in different ways.
 
 
 
 
 
 
A wrapper around temporary filesystem behaviour.
Custom java.util.logging formatter providing compact output.
 
Multithreaded client code should use this to assert that it accesses webdriver in a thread-safe manner.
Thrown when a command does not complete in enough time.
 
 
 
 
 
 
 
 
 
 
Thrown when a driver fails to set a cookie.
 
 
 
 
Indicates there was a problem communicating with the browser being controlled or the Selenium server.
Used to indicate that a command used by the remote webdriver is unsupported.
Polls a URL until a HTTP 200 response is received.
 
 
 
 
A bad implementation of URL Templates, but enough for our needs.
A file detector that never finds anything.
A combination of username and password to use when authenticating a browser with a website.
 
 
 
 
 
Represents a virtual authenticator.
Options for the creation of virtual authenticators.
 
 
A command codec that adheres to the W3C's WebDriver wire protocol.
A response codec that adheres to the W3C WebDriver wire protocol.
A generic interface for waiting until a condition is true or not null.
WebDriver is a remote control interface that enables introspection and control of user agents (browsers).
 
An interface for managing stuff you would do in a browser menu
Used to locate a given frame or window.
An interface for managing timeout behavior for WebDriver instances.
 
This class helps to create decorators for instances of WebDriver and derived objects, such as WebElements and Alert, that can extend or modify their "regular" behavior.
 
 
Describes, in general terms, a webdriver instance.
Classes that implement this interface are intended to be used with EventFiringDecorator, read documentation for this class to find detailed usage description.
A specialization of FluentWait that uses WebDriver instances.
Represents an HTML element.
Deprecated.
This class has moved to a new location.
Converts RemoteWebElement objects, which may be wrapped, into their JSON representation as defined by the WebDriver wire protocol.
 
 
Deprecated.
 
 
 
Represents the type of new browser window that may be created.
 
This interface indicates that the implementing class knows about the driver that contains it and can export it.
Indicates that there is an underlying element that can be used
An EventBus backed by ZeroMQ.