org.openqa.selenium.remote

Class RemoteWebDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

All Implemented Interfaces:

org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

Direct Known Subclasses:

FirefoxDriver, MarionetteDriver

public class RemoteWebDriver
extends java.lang.Object
implements org.openqa.selenium.WebDriver, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.HasCapabilities, org.openqa.selenium.TakesScreenshot

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	RemoteWebDriver.RemoteAlert
private class	RemoteWebDriver.RemoteNavigation
protected class	RemoteWebDriver.RemoteTargetLocator
protected class	RemoteWebDriver.RemoteWebDriverOptions
static class	RemoteWebDriver.When

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

Field Summary

Fields

Modifier and Type	Field and Description
private org.openqa.selenium.Capabilities	capabilities
private JsonToWebElementConverter	converter
private ErrorHandler	errorHandler
private ExecuteMethod	executeMethod
private CommandExecutor	executor
private FileDetector	fileDetector
private RemoteKeyboard	keyboard
private java.util.logging.Level	level
private LocalLogs	localLogs
private static java.util.logging.Logger	logger
private RemoteMouse	mouse
private org.openqa.selenium.logging.Logs	remoteLogs
private SessionId	sessionId
private int	w3cComplianceLevel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteWebDriver()
	RemoteWebDriver(org.openqa.selenium.Capabilities desiredCapabilities)
	RemoteWebDriver(CommandExecutor executor, org.openqa.selenium.Capabilities desiredCapabilities)
	RemoteWebDriver(CommandExecutor executor, org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities)
	RemoteWebDriver(java.net.URL remoteAddress, org.openqa.selenium.Capabilities desiredCapabilities)
	RemoteWebDriver(java.net.URL remoteAddress, org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities)

Method Summary

Modifier and Type	Method and Description
void	close()
(package private) static java.lang.String	cssEscape(java.lang.String using)
protected Response	execute(java.lang.String command)
protected Response	execute(java.lang.String driverCommand, java.util.Map<java.lang.String,?> parameters)
java.lang.Object	executeAsyncScript(java.lang.String script, java.lang.Object... args)
java.lang.Object	executeScript(java.lang.String script, java.lang.Object... args)
org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By by)
protected org.openqa.selenium.WebElement	findElement(java.lang.String by, java.lang.String using)
org.openqa.selenium.WebElement	findElementByClassName(java.lang.String using)
org.openqa.selenium.WebElement	findElementByCssSelector(java.lang.String using)
org.openqa.selenium.WebElement	findElementById(java.lang.String using)
org.openqa.selenium.WebElement	findElementByLinkText(java.lang.String using)
org.openqa.selenium.WebElement	findElementByName(java.lang.String using)
org.openqa.selenium.WebElement	findElementByPartialLinkText(java.lang.String using)
org.openqa.selenium.WebElement	findElementByTagName(java.lang.String using)
org.openqa.selenium.WebElement	findElementByXPath(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by)
protected java.util.List<org.openqa.selenium.WebElement>	findElements(java.lang.String by, java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElementsByClassName(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElementsByCssSelector(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElementsById(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElementsByLinkText(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElementsByName(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElementsByPartialLinkText(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElementsByTagName(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElementsByXPath(java.lang.String using)
void	get(java.lang.String url)
org.openqa.selenium.Capabilities	getCapabilities()
CommandExecutor	getCommandExecutor()
java.lang.String	getCurrentUrl()
protected JsonToWebElementConverter	getElementConverter()
ErrorHandler	getErrorHandler()
protected ExecuteMethod	getExecuteMethod()
FileDetector	getFileDetector()
org.openqa.selenium.interactions.Keyboard	getKeyboard()
org.openqa.selenium.interactions.Mouse	getMouse()
java.lang.String	getPageSource()
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> outputType)
SessionId	getSessionId()
java.lang.String	getTitle()
int	getW3CStandardComplianceLevel()
java.lang.String	getWindowHandle()
java.util.Set<java.lang.String>	getWindowHandles()
private void	init(org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities)
private boolean	isJavascriptEnabled()
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.
org.openqa.selenium.WebDriver.Options	manage()
org.openqa.selenium.WebDriver.Navigation	navigate()
void	quit()
protected void	setCommandExecutor(CommandExecutor executor)
protected void	setElementConverter(JsonToWebElementConverter converter)
void	setErrorHandler(ErrorHandler handler)
void	setFileDetector(FileDetector detector) Set the file detector to be used when sending keyboard input.
protected void	setFoundBy(org.openqa.selenium.SearchContext context, org.openqa.selenium.WebElement element, java.lang.String by, java.lang.String using)
void	setLogLevel(java.util.logging.Level level) Sets the RemoteWebDriver's client log level.
protected void	setSessionId(java.lang.String opaqueKey)
protected void	startClient() Method called before starting a new session.
protected void	startClient(org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities) Method called before starting a new session.
protected void	startSession(org.openqa.selenium.Capabilities desiredCapabilities)
protected void	startSession(org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities)
protected void	stopClient() Method called after executing a quit() command.
protected void	stopClient(org.openqa.selenium.Capabilities desiredCapabilities, org.openqa.selenium.Capabilities requiredCapabilities) Method called after executing a quit() command.
org.openqa.selenium.WebDriver.TargetLocator	switchTo()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

private static final java.util.logging.Logger logger

level

private java.util.logging.Level level

errorHandler

private ErrorHandler errorHandler

executor

private CommandExecutor executor

capabilities

private org.openqa.selenium.Capabilities capabilities

sessionId

private SessionId sessionId

fileDetector

private FileDetector fileDetector

executeMethod

private ExecuteMethod executeMethod

converter

private JsonToWebElementConverter converter

keyboard

private RemoteKeyboard keyboard

mouse

private RemoteMouse mouse

remoteLogs

private org.openqa.selenium.logging.Logs remoteLogs

localLogs

private LocalLogs localLogs

w3cComplianceLevel

private int w3cComplianceLevel

Constructor Detail

RemoteWebDriver

protected RemoteWebDriver()

RemoteWebDriver

public RemoteWebDriver(CommandExecutor executor,
                       org.openqa.selenium.Capabilities desiredCapabilities,
                       org.openqa.selenium.Capabilities requiredCapabilities)

RemoteWebDriver

public RemoteWebDriver(CommandExecutor executor,
                       org.openqa.selenium.Capabilities desiredCapabilities)

RemoteWebDriver

public RemoteWebDriver(org.openqa.selenium.Capabilities desiredCapabilities)

RemoteWebDriver

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

RemoteWebDriver

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

Method Detail

getW3CStandardComplianceLevel

public int getW3CStandardComplianceLevel()

init

private void init(org.openqa.selenium.Capabilities desiredCapabilities,
                  org.openqa.selenium.Capabilities requiredCapabilities)

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(org.openqa.selenium.Capabilities desiredCapabilities)

startSession

protected void startSession(org.openqa.selenium.Capabilities desiredCapabilities,
                            org.openqa.selenium.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.

startClient

protected void startClient(org.openqa.selenium.Capabilities desiredCapabilities,
                           org.openqa.selenium.Capabilities requiredCapabilities)

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. The default implementation is a no-op, but subtypes should override this method to define custom behavior.

stopClient

protected void stopClient(org.openqa.selenium.Capabilities desiredCapabilities,
                          org.openqa.selenium.Capabilities requiredCapabilities)

Method called after executing a quit() command. The default implementation is a no-op, but subtypes should override this method to define custom behavior.

getErrorHandler

public ErrorHandler getErrorHandler()

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

getCommandExecutor

public CommandExecutor getCommandExecutor()

setCommandExecutor

protected void setCommandExecutor(CommandExecutor executor)

getCapabilities

public org.openqa.selenium.Capabilities getCapabilities()

Specified by:

getCapabilities in interface org.openqa.selenium.HasCapabilities

get

public void get(java.lang.String url)

Specified by:

get in interface org.openqa.selenium.WebDriver

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface org.openqa.selenium.WebDriver

getCurrentUrl

public java.lang.String getCurrentUrl()

Specified by:

getCurrentUrl in interface org.openqa.selenium.WebDriver

getScreenshotAs

public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> outputType)
                      throws org.openqa.selenium.WebDriverException

Specified by:

getScreenshotAs in interface org.openqa.selenium.TakesScreenshot

Throws:

org.openqa.selenium.WebDriverException

findElements

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

Specified by:

findElements in interface org.openqa.selenium.SearchContext

Specified by:

findElements in interface org.openqa.selenium.WebDriver

findElement

public org.openqa.selenium.WebElement findElement(org.openqa.selenium.By by)

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebDriver

findElement

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

setFoundBy

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

findElements

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

cssEscape

static java.lang.String cssEscape(java.lang.String using)

findElementById

public org.openqa.selenium.WebElement findElementById(java.lang.String using)

Specified by:

findElementById in interface org.openqa.selenium.internal.FindsById

findElementsById

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

Specified by:

findElementsById in interface org.openqa.selenium.internal.FindsById

findElementByLinkText

public org.openqa.selenium.WebElement findElementByLinkText(java.lang.String using)

Specified by:

findElementByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementsByLinkText

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

Specified by:

findElementsByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementByPartialLinkText

public org.openqa.selenium.WebElement findElementByPartialLinkText(java.lang.String using)

Specified by:

findElementByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementsByPartialLinkText

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

Specified by:

findElementsByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

findElementByTagName

public org.openqa.selenium.WebElement findElementByTagName(java.lang.String using)

Specified by:

findElementByTagName in interface org.openqa.selenium.internal.FindsByTagName

findElementsByTagName

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

Specified by:

findElementsByTagName in interface org.openqa.selenium.internal.FindsByTagName

findElementByName

public org.openqa.selenium.WebElement findElementByName(java.lang.String using)

Specified by:

findElementByName in interface org.openqa.selenium.internal.FindsByName

findElementsByName

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

Specified by:

findElementsByName in interface org.openqa.selenium.internal.FindsByName

findElementByClassName

public org.openqa.selenium.WebElement findElementByClassName(java.lang.String using)

Specified by:

findElementByClassName in interface org.openqa.selenium.internal.FindsByClassName

findElementsByClassName

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

Specified by:

findElementsByClassName in interface org.openqa.selenium.internal.FindsByClassName

findElementByCssSelector

public org.openqa.selenium.WebElement findElementByCssSelector(java.lang.String using)

Specified by:

findElementByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

findElementsByCssSelector

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

Specified by:

findElementsByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

findElementByXPath

public org.openqa.selenium.WebElement findElementByXPath(java.lang.String using)

Specified by:

findElementByXPath in interface org.openqa.selenium.internal.FindsByXPath

findElementsByXPath

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

Specified by:

findElementsByXPath in interface org.openqa.selenium.internal.FindsByXPath

getPageSource

public java.lang.String getPageSource()

Specified by:

getPageSource in interface org.openqa.selenium.WebDriver

close

public void close()

Specified by:

close in interface org.openqa.selenium.WebDriver

quit

public void quit()

Specified by:

quit in interface org.openqa.selenium.WebDriver

getWindowHandles

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

Specified by:

getWindowHandles in interface org.openqa.selenium.WebDriver

getWindowHandle

public java.lang.String getWindowHandle()

Specified by:

getWindowHandle in interface org.openqa.selenium.WebDriver

executeScript

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

Specified by:

executeScript in interface org.openqa.selenium.JavascriptExecutor

executeAsyncScript

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

Specified by:

executeAsyncScript in interface org.openqa.selenium.JavascriptExecutor

isJavascriptEnabled

private boolean isJavascriptEnabled()

switchTo

public org.openqa.selenium.WebDriver.TargetLocator switchTo()

Specified by:

switchTo in interface org.openqa.selenium.WebDriver

navigate

public org.openqa.selenium.WebDriver.Navigation navigate()

Specified by:

navigate in interface org.openqa.selenium.WebDriver

manage

public org.openqa.selenium.WebDriver.Options manage()

Specified by:

manage in interface org.openqa.selenium.WebDriver

setElementConverter

protected void setElementConverter(JsonToWebElementConverter converter)

getElementConverter

protected 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 org.openqa.selenium.interactions.Keyboard getKeyboard()

Specified by:

getKeyboard in interface org.openqa.selenium.interactions.HasInputDevices

getMouse

public org.openqa.selenium.interactions.Mouse getMouse()

Specified by:

getMouse in interface org.openqa.selenium.interactions.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.

when - verb tense of "Execute" to prefix message

getFileDetector

public FileDetector getFileDetector()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object