WebDriverManager (WebDriverManager 3.8.1 API)

java.lang.Object
- io.github.bonigarcia.wdm.WebDriverManager

Direct Known Subclasses:

ChromeDriverManager, EdgeDriverManager, FirefoxDriverManager, InternetExplorerDriverManager, OperaDriverManager, PhantomJsDriverManager, SeleniumServerStandaloneManager, VoidDriverManager
```
public abstract class WebDriverManager
extends Object
```
Parent driver manager.

Since:

2.1.0

Author:

Boni Garcia (boni.gg@gmail.com)

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`BETA`
`protected String`	`binaryPath`
`protected Config`	`config`
`protected String`	`downloadedVersion`
`protected Downloader`	`downloader`
`protected boolean`	`forcedArch`
`protected boolean`	`forcedOs`
`protected HttpClient`	`httpClient`
`protected static Map<DriverManagerType,WebDriverManager>`	`instanceMap`
`protected boolean`	`isLatest`
`protected boolean`	`isSnap`
`protected String`	`latestVersion`
`protected List<String>`	`listVersions`
`protected static String`	`LOCAL`
`protected boolean`	`mirrorLog`
`protected static String`	`ONLINE`
`protected static String`	`PRE_INSTALLED`
`protected String`	`preferenceKey`
`protected Preferences`	`preferences`
`protected int`	`retryCount`
`protected static String`	`SLASH`
`protected UrlFilter`	`urlFilter`
`protected Properties`	`versionsProperties`
`protected String`	`versionToDownload`

Constructor Summary

Constructors
Constructor and Description

WebDriverManager()

Constructors
Constructor and Description
`WebDriverManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`WebDriverManager`	`arch32()`
`WebDriverManager`	`arch64()`
`WebDriverManager`	`architecture(Architecture architecture)`
`WebDriverManager`	`avoidAutoVersion()`
`WebDriverManager`	`avoidExport()`
`WebDriverManager`	`avoidOutputTree()`
`WebDriverManager`	`avoidPreferences()`
`WebDriverManager`	`browserPath(String browserPath)`
`protected List<URL>`	`checkLatest(List<URL> list, String driver)`
`static WebDriverManager`	`chromedriver()`
`static WebDriverManager`	`chromiumdriver()`
`void`	`clearCache()`
`WebDriverManager`	`clearPreferences()`
`Config`	`config()`
`protected void`	`downloadCandidateUrls(List<URL> candidateUrls)`
`WebDriverManager`	`driverRepositoryUrl(URL url)`
`static WebDriverManager`	`edgedriver()`
`protected void`	`exportDriver(String variableValue)`
`protected List<URL>`	`filterByDistro(List<URL> candidateUrls)`
`protected List<URL>`	`filterByIgnoredVersions(List<URL> candidateUrls)`
`protected List<File>`	`filterCacheBy(List<File> input, String key, boolean isVersion)`
`protected List<URL>`	`filterCandidateUrls(Architecture arch, String version, boolean getLatest)`
`static WebDriverManager`	`firefoxdriver()`
`WebDriverManager`	`forceCache()`
`WebDriverManager`	`forceDownload()`
`String`	`getBinaryPath()`
`protected abstract Optional<String>`	`getBrowserVersion()`
`protected String`	`getCurrentVersion(URL url, String driverName)`
`protected Optional<String>`	`getDefaultBrowserVersion(String[] programFilesEnvs, String winBrowserName, String linuxBrowserName, String macBrowserName, String versionFlag, String browserNameInOutput)`
`String`	`getDownloadedVersion()`
`protected Optional<String>`	`getDriverFromCache(String driverVersion, Architecture arch, String os)`
`protected abstract DriverManagerType`	`getDriverManagerType()`
`protected abstract String`	`getDriverName()`
`protected abstract List<URL>`	`getDrivers()`
`protected List<URL>`	`getDriversFromGitHub()`
`protected List<URL>`	`getDriversFromMirror(URL driverUrl)` This method works also for http://npm.taobao.org/ and https://bitbucket.org/ mirrors.
`protected List<URL>`	`getDriversFromXml(URL driverUrl)`
`protected abstract URL`	`getDriverUrl()`
`protected URL`	`getDriverUrlCkeckingMirror(URL url)`
`protected abstract String`	`getDriverVersion()`
`protected File`	`getExecFile()`
`protected abstract Optional<String>`	`getExportParameter()`
`protected List<File>`	`getFilesInCache()`
`protected FilenameFilter`	`getFolderFilter()`
`protected HttpClient`	`getHttpClient()`
`static WebDriverManager`	`getInstance(Class<?> webDriverClass)`
`static WebDriverManager`	`getInstance(DriverManagerType driverManagerType)`
`protected Optional<String>`	`getLatestVersion()`
`protected abstract Optional<URL>`	`getMirrorUrl()`
`protected String`	`getOtherProgramFilesEnv()`
`protected String`	`getProgramFilesEnv()`
`protected GitHubApi`	`getVersion(GitHubApi[] releaseArray, String version)`
`protected List<URL>`	`getVersion(List<URL> list, String driver, String version)`
`List<String>`	`getVersions()`
`WebDriverManager`	`gitHubTokenName(String gitHubTokenName)`
`WebDriverManager`	`gitHubTokenSecret(String gitHubTokenSecret)`
`static Config`	`globalConfig()`
`protected Optional<String>`	`handleCache(Architecture arch, String version, String os, boolean getLatest, boolean cache)`
`protected void`	`handleDriver(URL url, String driver, List<URL> out)`
`protected void`	`handleException(Exception e, Architecture arch, String version)`
`static WebDriverManager`	`iedriver()`
`WebDriverManager`	`ignoreVersions(String... versions)`
`protected Document`	`loadXML(Reader reader)`
`WebDriverManager`	`localRepositoryPassword(String localRepositoryPassword)`
`WebDriverManager`	`localRepositoryUser(String localRepositoryUser)`
`static void`	`main(String[] args)`
`protected void`	`manage(Architecture arch, String version)`
`protected InputStream`	`openGitHubConnection(URL driverUrl)`
`static WebDriverManager`	`operadriver()`
`WebDriverManager`	`operatingSystem(OperatingSystem os)`
`static WebDriverManager`	`phantomjs()`
`protected File`	`postDownload(File archive)`
`protected String`	`preDownload(String target, String version)`
`WebDriverManager`	`properties(String properties)`
`WebDriverManager`	`proxy(String proxy)`
`WebDriverManager`	`proxyPass(String proxyPass)`
`WebDriverManager`	`proxyUser(String proxyUser)`
`protected List<URL>`	`removeFromList(List<URL> list, String version)`
`protected void`	`reset()`
`static WebDriverManager`	`seleniumServerStandalone()`
`protected abstract void`	`setDriverUrl(URL url)`
`protected abstract void`	`setDriverVersion(String version)`
`void`	`setup()`
`WebDriverManager`	`targetPath(String targetPath)`
`WebDriverManager`	`timeout(int timeout)`
`WebDriverManager`	`ttl(int seconds)`
`WebDriverManager`	`useBetaVersions()`
`WebDriverManager`	`useLocalVersionsPropertiesFirst()`
`WebDriverManager`	`useMirror()`
`WebDriverManager`	`version(String version)`
`protected Integer`	`versionCompare(String str1, String str2)`
`protected static WebDriverManager`	`voiddriver()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SLASH
```
protected static final String SLASH
```
See Also:

Constant Field Values

PRE_INSTALLED

protected static final String PRE_INSTALLED

See Also:: Constant Field Values

BETA
```
protected static final String BETA
```
See Also:

Constant Field Values

ONLINE
```
protected static final String ONLINE
```
See Also:

Constant Field Values

LOCAL
```
protected static final String LOCAL
```
See Also:

Constant Field Values

instanceMap

protected static Map<DriverManagerType,WebDriverManager> instanceMap

httpClient
```
protected HttpClient httpClient
```

downloader
```
protected Downloader downloader
```

urlFilter
```
protected UrlFilter urlFilter
```

versionToDownload
```
protected String versionToDownload
```

downloadedVersion
```
protected String downloadedVersion
```

latestVersion
```
protected String latestVersion
```

binaryPath
```
protected String binaryPath
```

mirrorLog
```
protected boolean mirrorLog
```

listVersions
```
protected List<String> listVersions
```

forcedArch
```
protected boolean forcedArch
```

forcedOs
```
protected boolean forcedOs
```

isLatest
```
protected boolean isLatest
```

isSnap
```
protected boolean isSnap
```

retryCount
```
protected int retryCount
```

config
```
protected Config config
```

preferences
```
protected Preferences preferences
```

preferenceKey
```
protected String preferenceKey
```

versionsProperties

protected Properties versionsProperties

Constructor Detail
- WebDriverManager
```
public WebDriverManager()
```

Method Detail

getDrivers

protected abstract List<URL> getDrivers()
                                 throws IOException

Throws:: IOException

getBrowserVersion

protected abstract Optional<String> getBrowserVersion()

getDriverManagerType

protected abstract DriverManagerType getDriverManagerType()

getDriverName

protected abstract String getDriverName()

setDriverVersion

protected abstract void setDriverVersion(String version)

getDriverVersion

protected abstract String getDriverVersion()

setDriverUrl

protected abstract void setDriverUrl(URL url)

getDriverUrl
```
protected abstract URL getDriverUrl()
```

getMirrorUrl

protected abstract Optional<URL> getMirrorUrl()

getExportParameter

protected abstract Optional<String> getExportParameter()

globalConfig
```
public static Config globalConfig()
```

config
```
public Config config()
```

chromedriver

public static WebDriverManager chromedriver()

chromiumdriver

public static WebDriverManager chromiumdriver()

firefoxdriver

public static WebDriverManager firefoxdriver()

operadriver

public static WebDriverManager operadriver()

edgedriver

public static WebDriverManager edgedriver()

iedriver

public static WebDriverManager iedriver()

phantomjs

public static WebDriverManager phantomjs()

seleniumServerStandalone

public static WebDriverManager seleniumServerStandalone()

voiddriver

protected static WebDriverManager voiddriver()

getInstance

public static WebDriverManager getInstance(DriverManagerType driverManagerType)

getInstance

public static WebDriverManager getInstance(Class<?> webDriverClass)

setup
```
public void setup()
```

version

public WebDriverManager version(String version)

architecture

public WebDriverManager architecture(Architecture architecture)

arch32
```
public WebDriverManager arch32()
```

arch64
```
public WebDriverManager arch64()
```

operatingSystem

public WebDriverManager operatingSystem(OperatingSystem os)

forceCache
```
public WebDriverManager forceCache()
```

forceDownload

public WebDriverManager forceDownload()

driverRepositoryUrl

public WebDriverManager driverRepositoryUrl(URL url)

useMirror
```
public WebDriverManager useMirror()
```

proxy

public WebDriverManager proxy(String proxy)

proxyUser

public WebDriverManager proxyUser(String proxyUser)

proxyPass

public WebDriverManager proxyPass(String proxyPass)

useBetaVersions

public WebDriverManager useBetaVersions()

ignoreVersions

public WebDriverManager ignoreVersions(String... versions)

gitHubTokenSecret

public WebDriverManager gitHubTokenSecret(String gitHubTokenSecret)

gitHubTokenName

public WebDriverManager gitHubTokenName(String gitHubTokenName)

localRepositoryUser

public WebDriverManager localRepositoryUser(String localRepositoryUser)

localRepositoryPassword

public WebDriverManager localRepositoryPassword(String localRepositoryPassword)

timeout

public WebDriverManager timeout(int timeout)

properties

public WebDriverManager properties(String properties)

targetPath

public WebDriverManager targetPath(String targetPath)

avoidExport
```
public WebDriverManager avoidExport()
```

avoidOutputTree

public WebDriverManager avoidOutputTree()

avoidAutoVersion

public WebDriverManager avoidAutoVersion()

avoidPreferences

public WebDriverManager avoidPreferences()

ttl

public WebDriverManager ttl(int seconds)

browserPath

public WebDriverManager browserPath(String browserPath)

useLocalVersionsPropertiesFirst

public WebDriverManager useLocalVersionsPropertiesFirst()

clearPreferences

public WebDriverManager clearPreferences()

getBinaryPath
```
public String getBinaryPath()
```

getDownloadedVersion
```
public String getDownloadedVersion()
```

getVersions
```
public List<String> getVersions()
```

clearCache
```
public void clearCache()
```

preDownload

protected String preDownload(String target,
                             String version)

postDownload

protected File postDownload(File archive)

getCurrentVersion

protected String getCurrentVersion(URL url,
                                   String driverName)

manage

protected void manage(Architecture arch,
                      String version)

handleException

protected void handleException(Exception e,
                               Architecture arch,
                               String version)

downloadCandidateUrls

protected void downloadCandidateUrls(List<URL> candidateUrls)
                              throws IOException,
                                     InterruptedException

Throws:: IOException; InterruptedException

filterCandidateUrls

protected List<URL> filterCandidateUrls(Architecture arch,
                                        String version,
                                        boolean getLatest)
                                 throws IOException

Throws:: IOException

filterByIgnoredVersions

protected List<URL> filterByIgnoredVersions(List<URL> candidateUrls)

filterByDistro

protected List<URL> filterByDistro(List<URL> candidateUrls)
                            throws IOException

Throws:: IOException

handleCache

protected Optional<String> handleCache(Architecture arch,
                                       String version,
                                       String os,
                                       boolean getLatest,
                                       boolean cache)

getDriverFromCache

protected Optional<String> getDriverFromCache(String driverVersion,
                                              Architecture arch,
                                              String os)

filterCacheBy

protected List<File> filterCacheBy(List<File> input,
                                   String key,
                                   boolean isVersion)

getFilesInCache

protected List<File> getFilesInCache()

removeFromList

protected List<URL> removeFromList(List<URL> list,
                                   String version)

getVersion

protected List<URL> getVersion(List<URL> list,
                               String driver,
                               String version)

checkLatest

protected List<URL> checkLatest(List<URL> list,
                                String driver)

handleDriver

protected void handleDriver(URL url,
                            String driver,
                            List<URL> out)

versionCompare

protected Integer versionCompare(String str1,
                                 String str2)

getDriversFromMirror
```
protected List<URL> getDriversFromMirror(URL driverUrl)
                                  throws IOException
```
This method works also for http://npm.taobao.org/ and https://bitbucket.org/ mirrors.

Throws:

IOException

getDriversFromXml

protected List<URL> getDriversFromXml(URL driverUrl)
                               throws IOException

Throws:: IOException

loadXML

protected Document loadXML(Reader reader)
                    throws SAXException,
                           IOException,
                           ParserConfigurationException

Throws:: SAXException; IOException; ParserConfigurationException

exportDriver

protected void exportDriver(String variableValue)

openGitHubConnection

protected InputStream openGitHubConnection(URL driverUrl)
                                    throws IOException

Throws:: IOException

getDriversFromGitHub

protected List<URL> getDriversFromGitHub()
                                  throws IOException

Throws:: IOException

getVersion

protected GitHubApi getVersion(GitHubApi[] releaseArray,
                               String version)

getHttpClient
```
protected HttpClient getHttpClient()
```

getFolderFilter

protected FilenameFilter getFolderFilter()

getDefaultBrowserVersion

protected Optional<String> getDefaultBrowserVersion(String[] programFilesEnvs,
                                                    String winBrowserName,
                                                    String linuxBrowserName,
                                                    String macBrowserName,
                                                    String versionFlag,
                                                    String browserNameInOutput)

getExecFile
```
protected File getExecFile()
```

getLatestVersion

protected Optional<String> getLatestVersion()

reset
```
protected void reset()
```

getProgramFilesEnv
```
protected String getProgramFilesEnv()
```

getOtherProgramFilesEnv

protected String getOtherProgramFilesEnv()

getDriverUrlCkeckingMirror

protected URL getDriverUrlCkeckingMirror(URL url)

main

public static void main(String[] args)

Class WebDriverManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SLASH

PRE_INSTALLED

BETA

ONLINE

LOCAL

instanceMap

httpClient

downloader

urlFilter

versionToDownload

downloadedVersion

latestVersion

binaryPath

mirrorLog

listVersions

forcedArch

forcedOs

isLatest

isSnap

retryCount

config

preferences

preferenceKey

versionsProperties

Constructor Detail

WebDriverManager

Method Detail

getDrivers

getBrowserVersion

getDriverManagerType

getDriverName

setDriverVersion

getDriverVersion

setDriverUrl

getDriverUrl

getMirrorUrl

getExportParameter

globalConfig

config

chromedriver

chromiumdriver

firefoxdriver

operadriver

edgedriver

iedriver

phantomjs

seleniumServerStandalone

voiddriver

getInstance

getInstance

setup

version

architecture

arch32

arch64

operatingSystem

forceCache

forceDownload

driverRepositoryUrl

useMirror

proxy

proxyUser

proxyPass

useBetaVersions

ignoreVersions

gitHubTokenSecret

gitHubTokenName

localRepositoryUser

localRepositoryPassword

timeout

properties

targetPath

avoidExport

avoidOutputTree