Package io.appium.java_client

Class AppiumClientConfig

java.lang.Object

org.openqa.selenium.remote.http.ClientConfig

io.appium.java_client.AppiumClientConfig

public class AppiumClientConfig
extends org.openqa.selenium.remote.http.ClientConfig

A class to store the appium http client configuration.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AppiumClientConfig(java.net.URI baseUri, java.time.Duration connectionTimeout, java.time.Duration readTimeout, org.openqa.selenium.remote.http.Filter filters, java.net.Proxy proxy, org.openqa.selenium.Credentials credentials, javax.net.ssl.SSLContext sslContext, java.lang.String version, java.lang.Boolean directConnect)	Client side configuration.

Method Summary

Modifier and Type	Method	Description
AppiumClientConfig	authenticateAs(org.openqa.selenium.Credentials credentials)
AppiumClientConfig	baseUri(java.net.URI baseUri)
AppiumClientConfig	baseUrl(java.net.URL baseUrl)
AppiumClientConfig	connectionTimeout(java.time.Duration timeout)
static AppiumClientConfig	defaultConfig()	Return the instance of AppiumClientConfig with a default config.
AppiumClientConfig	directConnect(boolean directConnect)	Whether enable directConnect feature described in Connecting Directly to Appium Hosts in Distributed Environments.
static AppiumClientConfig	fromClientConfig(org.openqa.selenium.remote.http.ClientConfig clientConfig)	Return the instance of AppiumClientConfig from the given ClientConfig parameters.
boolean	isDirectConnectEnabled()	Whether enable directConnect feature is enabled.
AppiumClientConfig	proxy(java.net.Proxy proxy)
AppiumClientConfig	readTimeout(java.time.Duration timeout)
AppiumClientConfig	withFilter(org.openqa.selenium.remote.http.Filter filter)
AppiumClientConfig	withRetries()

Methods inherited from class org.openqa.selenium.remote.http.ClientConfig

baseUri, baseUrl, connectionTimeout, credentials, filter, proxy, readTimeout, sslContext, sslContext, toString, version, version

Methods inherited from class java.lang.Object

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

Constructor Detail

AppiumClientConfig

protected AppiumClientConfig(java.net.URI baseUri,
                             java.time.Duration connectionTimeout,
                             java.time.Duration readTimeout,
                             org.openqa.selenium.remote.http.Filter filters,
                             @Nullable
                             java.net.Proxy proxy,
                             @Nullable
                             org.openqa.selenium.Credentials credentials,
                             @Nullable
                             javax.net.ssl.SSLContext sslContext,
                             @Nullable
                             java.lang.String version,
                             java.lang.Boolean directConnect)

Client side configuration.

Parameters:

baseUri - Base URL the client sends HTTP request to.

connectionTimeout - The client connection timeout.

readTimeout - The client read timeout.

filters - Filters to modify incoming HttpRequest or outgoing HttpResponse.

proxy - The client proxy preference.

credentials - Credentials used for authenticating http requests

sslContext - SSL context (if present)

directConnect - If directConnect is enabled.

Method Detail

defaultConfig

public static AppiumClientConfig defaultConfig()

Return the instance of AppiumClientConfig with a default config.

Returns:

the instance of AppiumClientConfig.

fromClientConfig

public static AppiumClientConfig fromClientConfig(org.openqa.selenium.remote.http.ClientConfig clientConfig)

Return the instance of AppiumClientConfig from the given ClientConfig parameters.

Parameters:

clientConfig - take a look at ClientConfig

Returns:

the instance of AppiumClientConfig.

baseUri

public AppiumClientConfig baseUri(java.net.URI baseUri)

Overrides:

baseUri in class org.openqa.selenium.remote.http.ClientConfig

baseUrl

public AppiumClientConfig baseUrl(java.net.URL baseUrl)

Overrides:

baseUrl in class org.openqa.selenium.remote.http.ClientConfig

connectionTimeout

public AppiumClientConfig connectionTimeout(java.time.Duration timeout)

Overrides:

connectionTimeout in class org.openqa.selenium.remote.http.ClientConfig

readTimeout

public AppiumClientConfig readTimeout(java.time.Duration timeout)

Overrides:

readTimeout in class org.openqa.selenium.remote.http.ClientConfig

withFilter

public AppiumClientConfig withFilter(org.openqa.selenium.remote.http.Filter filter)

Overrides:

withFilter in class org.openqa.selenium.remote.http.ClientConfig

withRetries

public AppiumClientConfig withRetries()

Overrides:

withRetries in class org.openqa.selenium.remote.http.ClientConfig

proxy

public AppiumClientConfig proxy(java.net.Proxy proxy)

Overrides:

proxy in class org.openqa.selenium.remote.http.ClientConfig

authenticateAs

public AppiumClientConfig authenticateAs(org.openqa.selenium.Credentials credentials)

Overrides:

authenticateAs in class org.openqa.selenium.remote.http.ClientConfig

directConnect

public AppiumClientConfig directConnect(boolean directConnect)

Whether enable directConnect feature described in Connecting Directly to Appium Hosts in Distributed Environments.

Parameters:

directConnect - if enable the directConnect feature

Returns:

A new instance of AppiumClientConfig

isDirectConnectEnabled

public boolean isDirectConnectEnabled()

Whether enable directConnect feature is enabled.

Returns:

If the directConnect is enabled. Defaults false.