io.appium.java_client.remote

Class AppiumCommandExecutor

java.lang.Object

org.openqa.selenium.remote.HttpCommandExecutor

io.appium.java_client.remote.AppiumCommandExecutor

All Implemented Interfaces:

org.openqa.selenium.logging.NeedsLocalLogs, org.openqa.selenium.remote.CommandExecutor

public class AppiumCommandExecutor
extends org.openqa.selenium.remote.HttpCommandExecutor

Constructor Summary

Constructors

Constructor and Description
AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands, AppiumClientConfig appiumClientConfig)
AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands, org.openqa.selenium.remote.service.DriverService service)
AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands, org.openqa.selenium.remote.service.DriverService service, AppiumClientConfig appiumClientConfig)
AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands, org.openqa.selenium.remote.service.DriverService service, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory)
AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands, org.openqa.selenium.remote.service.DriverService service, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, AppiumClientConfig appiumClientConfig) Create an AppiumCommandExecutor instance.
AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands, java.net.URL addressOfRemoteServer)
AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands, java.net.URL addressOfRemoteServer, AppiumClientConfig appiumClientConfig)
AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands, java.net.URL addressOfRemoteServer, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory)

Method Summary

Modifier and Type	Method and Description
org.openqa.selenium.remote.Response	execute(org.openqa.selenium.remote.Command command)
protected java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo>	getAdditionalCommands()
protected org.openqa.selenium.remote.http.HttpClient	getClient()
protected org.openqa.selenium.remote.CommandCodec<org.openqa.selenium.remote.http.HttpRequest>	getCommandCodec()
protected <B> B	getPrivateFieldValue(java.lang.Class<? extends org.openqa.selenium.remote.CommandExecutor> cls, java.lang.String fieldName, java.lang.Class<B> fieldType)
protected void	overrideServerUrl(java.net.URL serverUrl) Override the http client in the HttpCommandExecutor class with a new http client instance with the given URL.
void	refreshAdditionalCommands()
void	setCommandCodec(org.openqa.selenium.remote.CommandCodec<org.openqa.selenium.remote.http.HttpRequest> newCodec)
protected void	setPrivateFieldValue(java.lang.Class<? extends org.openqa.selenium.remote.CommandExecutor> cls, java.lang.String fieldName, java.lang.Object newValue)
void	setResponseCodec(org.openqa.selenium.remote.ResponseCodec<org.openqa.selenium.remote.http.HttpResponse> codec)

Methods inherited from class org.openqa.selenium.remote.HttpCommandExecutor

defineCommand, getAddressOfRemoteServer, getDefaultClientFactory, setLocalLogs

Methods inherited from class java.lang.Object

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

Constructor Detail

AppiumCommandExecutor

public AppiumCommandExecutor(@Nonnull
                             java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands,
                             @Nullable
                             org.openqa.selenium.remote.service.DriverService service,
                             @Nullable
                             org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
                             @Nonnull
                             AppiumClientConfig appiumClientConfig)

Create an AppiumCommandExecutor instance.

Parameters:

additionalCommands - is the map of Appium commands

service - take a look at DriverService

httpClientFactory - take a look at HttpClient.Factory

appiumClientConfig - take a look at AppiumClientConfig

AppiumCommandExecutor

public AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands,
                             org.openqa.selenium.remote.service.DriverService service,
                             org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory)

AppiumCommandExecutor

public AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands,
                             java.net.URL addressOfRemoteServer,
                             org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory)

AppiumCommandExecutor

public AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands,
                             AppiumClientConfig appiumClientConfig)

AppiumCommandExecutor

public AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands,
                             java.net.URL addressOfRemoteServer)

AppiumCommandExecutor

public AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands,
                             java.net.URL addressOfRemoteServer,
                             AppiumClientConfig appiumClientConfig)

AppiumCommandExecutor

public AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands,
                             org.openqa.selenium.remote.service.DriverService service)

AppiumCommandExecutor

public AppiumCommandExecutor(java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> additionalCommands,
                             org.openqa.selenium.remote.service.DriverService service,
                             AppiumClientConfig appiumClientConfig)

Method Detail

getPrivateFieldValue

protected <B> B getPrivateFieldValue(java.lang.Class<? extends org.openqa.selenium.remote.CommandExecutor> cls,
                                     java.lang.String fieldName,
                                     java.lang.Class<B> fieldType)

setPrivateFieldValue

protected void setPrivateFieldValue(java.lang.Class<? extends org.openqa.selenium.remote.CommandExecutor> cls,
                                    java.lang.String fieldName,
                                    java.lang.Object newValue)

getAdditionalCommands

protected java.util.Map<java.lang.String,org.openqa.selenium.remote.CommandInfo> getAdditionalCommands()

getCommandCodec

protected org.openqa.selenium.remote.CommandCodec<org.openqa.selenium.remote.http.HttpRequest> getCommandCodec()

setCommandCodec

public void setCommandCodec(org.openqa.selenium.remote.CommandCodec<org.openqa.selenium.remote.http.HttpRequest> newCodec)

setResponseCodec

public void setResponseCodec(org.openqa.selenium.remote.ResponseCodec<org.openqa.selenium.remote.http.HttpResponse> codec)

getClient

protected org.openqa.selenium.remote.http.HttpClient getClient()

overrideServerUrl

protected void overrideServerUrl(java.net.URL serverUrl)

Override the http client in the HttpCommandExecutor class with a new http client instance with the given URL. It uses the same http client factory and client config for the new http client instance if the constructor got them.

Parameters:

serverUrl - A url to override.

refreshAdditionalCommands

public void refreshAdditionalCommands()

execute

public org.openqa.selenium.remote.Response execute(org.openqa.selenium.remote.Command command)
                                            throws org.openqa.selenium.WebDriverException

Specified by:

execute in interface org.openqa.selenium.remote.CommandExecutor

Overrides:

execute in class org.openqa.selenium.remote.HttpCommandExecutor

Throws:

org.openqa.selenium.WebDriverException