BrowserManager (WebdriverManager 1.7.1 API)

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

Direct Known Subclasses:

ChromeDriverManager, EdgeDriverManager, FirefoxDriverManager, InternetExplorerDriverManager, OperaDriverManager, PhantomJsDriverManager, VoidDriverManager, WebDriverManager
```
public abstract class BrowserManager
extends Object
```
Generic manager.

Since:

1.0.0

Author:

Boni Garcia (boni.gg@gmail.com)

Field Summary

Fields
Modifier and Type	Field and Description
`protected Architecture`	`architecture`
`protected String`	`binaryPath`
`static Architecture`	`DEFAULT_ARCH`
`protected URL`	`driverUrl`
`protected boolean`	`forceCache`
`protected boolean`	`forceDownload`
`protected WdmHttpClient`	`httpClient`
`protected static BrowserManager`	`instance`
`protected List<String>`	`listVersions`
`protected static org.slf4j.Logger`	`log`
`protected boolean`	`mirrorLog`
`static String`	`MY_OS_NAME`
`protected String`	`proxy`
`protected String`	`proxyPass`
`protected String`	`proxyUser`
`static String`	`SEPARATOR`
`static String`	`TAOBAO_MIRROR`
`protected boolean`	`triedWithCache`
`protected boolean`	`useBetaVersions`
`protected String`	`version`
`protected String`	`versionToDownload`

Constructor Summary

Constructors
Constructor and Description

BrowserManager()

Constructors
Constructor and Description
`BrowserManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BrowserManager`	`arch32()`
`BrowserManager`	`arch64()`
`BrowserManager`	`architecture(Architecture architecture)`
`protected Proxy`	`createProxy()` Deprecated. Since 1.6.2. This method remain to keep a backward compatibility(gh-118).
`BrowserManager`	`driverRepositoryUrl(URL url)`
`protected String`	`existsDriverInCache(String repository, String driverVersion, Architecture arch)`
`protected void`	`exportDriver(String variableName, String variableValue)`
`protected List<URL>`	`filter(List<URL> list, Architecture arch)`
`protected List<URL>`	`filterByDistro(List<URL> list, String distro, String version)`
`BrowserManager`	`forceCache()`
`protected String`	`forceCache(String repository)`
`BrowserManager`	`forceDownload()`
`String`	`getBinaryPath()`
`protected String`	`getCurrentVersion(URL url, String driverName)`
`protected String`	`getDistroName()`
`String`	`getDownloadedVersion()`
`protected abstract List<String>`	`getDriverName()`
`protected abstract List<URL>`	`getDrivers()`
`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, List<String> driverBinary)`
`protected URL`	`getDriverUrl()`
`protected abstract String`	`getDriverUrlKey()`
`protected String`	`getDriverVersion()`
`protected abstract String`	`getDriverVersionKey()`
`protected abstract String`	`getExportParameter()`
`protected List<URL>`	`getLatest(List<URL> list, List<String> match)`
`protected static String`	`getOsName()`
`protected List<URL>`	`getVersion(List<URL> list, List<String> match, String version)`
`boolean`	`isExecutable(File file)`
`protected boolean`	`isNetAvailable()`
`protected boolean`	`isUsingTaobaoMirror()`
`protected Document`	`loadXML(Reader reader)`
`protected void`	`manage(Architecture arch, DriverVersion version)`
`protected void`	`manage(Architecture arch, String version)`
`protected InputStream`	`openGitHubConnection(URL driverUrl)`
`protected File`	`postDownload(File archive)`
`protected String`	`preDownload(String target, String version)`
`BrowserManager`	`proxy(String proxy)`
`BrowserManager`	`proxyPass(String proxyPass)`
`BrowserManager`	`proxyUser(String proxyUser)`
`protected List<URL>`	`removeFromList(List<URL> list, String version)`
`void`	`setup()`
`void`	`setup(Architecture architecture)` Deprecated. use `architecture(Architecture)` instead.
`void`	`setup(Architecture architecture, String version)` Deprecated. use `version(String)` and `architecture(Architecture)` instead.
`void`	`setup(String version)` Deprecated. use `version(String)` instead.
`protected boolean`	`shouldCheckArchitecture(String driverName)`
`BrowserManager`	`useBetaVersions()`
`BrowserManager`	`useTaobaoMirror()`
`BrowserManager`	`version(String version)`
`protected Integer`	`versionCompare(String str1, String str2)`

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

Field Detail

log

protected static final org.slf4j.Logger log

TAOBAO_MIRROR

public static final String TAOBAO_MIRROR

See Also:: Constant Field Values

SEPARATOR
```
public static final String SEPARATOR
```
See Also:

Constant Field Values

DEFAULT_ARCH

public static final Architecture DEFAULT_ARCH

MY_OS_NAME
```
public static final String MY_OS_NAME
```

instance

protected static BrowserManager instance

versionToDownload
```
protected String versionToDownload
```

mirrorLog
```
protected boolean mirrorLog
```

version
```
protected String version
```

architecture
```
protected Architecture architecture
```

forceCache
```
protected boolean forceCache
```

forceDownload
```
protected boolean forceDownload
```

useBetaVersions
```
protected boolean useBetaVersions
```

driverUrl
```
protected URL driverUrl
```

proxy
```
protected String proxy
```

binaryPath
```
protected String binaryPath
```

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

triedWithCache
```
protected boolean triedWithCache
```

proxyUser
```
protected String proxyUser
```
Since:

1.6.2

proxyPass
```
protected String proxyPass
```
Since:

1.6.2

httpClient
```
protected WdmHttpClient httpClient
```
Since:

1.6.2

Constructor Detail
- BrowserManager
```
public BrowserManager()
```

Method Detail

getDrivers

protected abstract List<URL> getDrivers()
                                 throws Exception

Throws:: Exception

getExportParameter

protected abstract String getExportParameter()

getDriverVersionKey

protected abstract String getDriverVersionKey()

getDriverName

protected abstract List<String> getDriverName()

getDriverUrlKey

protected abstract String getDriverUrlKey()

getDriverVersion
```
protected String getDriverVersion()
```

getDriverUrl

protected URL getDriverUrl()
                    throws MalformedURLException

Throws:: MalformedURLException

preDownload

protected String preDownload(String target,
                             String version)
                      throws IOException

Throws:: IOException

postDownload

protected File postDownload(File archive)
                     throws IOException

Throws:: IOException

getCurrentVersion

protected String getCurrentVersion(URL url,
                                   String driverName)
                            throws MalformedURLException

Throws:: MalformedURLException

manage

protected void manage(Architecture arch,
                      DriverVersion version)

manage

protected void manage(Architecture arch,
                      String version)

forceCache

protected String forceCache(String repository)
                     throws IOException

Throws:: IOException

existsDriverInCache

protected String existsDriverInCache(String repository,
                                     String driverVersion,
                                     Architecture arch)
                              throws IOException

Throws:: IOException

isExecutable

public boolean isExecutable(File file)

shouldCheckArchitecture

protected boolean shouldCheckArchitecture(String driverName)

Since:: 1.6.2

isNetAvailable
```
protected boolean isNetAvailable()
```

filter

protected List<URL> filter(List<URL> list,
                           Architecture arch)

filterByDistro

protected List<URL> filterByDistro(List<URL> list,
                                   String distro,
                                   String version)
                            throws IOException

Throws:: IOException

getDistroName

protected String getDistroName()
                        throws IOException

Throws:: IOException

removeFromList

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

getVersion

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

getLatest

protected List<URL> getLatest(List<URL> list,
                              List<String> match)

isUsingTaobaoMirror

protected boolean isUsingTaobaoMirror()
                               throws MalformedURLException

Throws:: MalformedURLException

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,
                                      List<String> driverBinary)
                               throws Exception

Throws:: Exception

loadXML

protected Document loadXML(Reader reader)
                    throws Exception

Throws:: Exception

getOsName
```
protected static String getOsName()
```

exportDriver

protected void exportDriver(String variableName,
                            String variableValue)

openGitHubConnection

protected InputStream openGitHubConnection(URL driverUrl)
                                    throws IOException

Throws:: IOException

createProxy
```
@Deprecated
protected Proxy createProxy()
```
Deprecated. Since 1.6.2. This method remain to keep a backward compatibility(gh-118).

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

setup

@Deprecated
public void setup(String version)

Deprecated. use version(String) instead.

setup

@Deprecated
public void setup(Architecture architecture)

Deprecated. use architecture(Architecture) instead.

setup

@Deprecated
public void setup(Architecture architecture,
                              String version)

Deprecated. use version(String) and architecture(Architecture) instead.

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

version

public BrowserManager version(String version)

architecture

public BrowserManager architecture(Architecture architecture)

arch32
```
public BrowserManager arch32()
```

arch64
```
public BrowserManager arch64()
```

forceCache
```
public BrowserManager forceCache()
```

forceDownload
```
public BrowserManager forceDownload()
```

driverRepositoryUrl

public BrowserManager driverRepositoryUrl(URL url)

useTaobaoMirror

public BrowserManager useTaobaoMirror()

proxy

public BrowserManager proxy(String proxy)

proxyUser

public BrowserManager proxyUser(String proxyUser)

Since:: 1.6.2

proxyPass

public BrowserManager proxyPass(String proxyPass)

Since:: 1.6.2

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

useBetaVersions

public BrowserManager useBetaVersions()

Class BrowserManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

TAOBAO_MIRROR

SEPARATOR

DEFAULT_ARCH

MY_OS_NAME

instance

versionToDownload

mirrorLog

version

architecture

forceCache

forceDownload

useBetaVersions

driverUrl

proxy

binaryPath

listVersions

triedWithCache

proxyUser

proxyPass

httpClient

Constructor Detail

BrowserManager

Method Detail

getDrivers

getExportParameter

getDriverVersionKey

getDriverName

getDriverUrlKey

getDriverVersion

getDriverUrl

preDownload

postDownload

getCurrentVersion

manage

manage

forceCache

existsDriverInCache

isExecutable

shouldCheckArchitecture

isNetAvailable

filter

filterByDistro

getDistroName

removeFromList

getVersion

getLatest

isUsingTaobaoMirror

versionCompare

getDriversFromMirror

getDriversFromXml

loadXML

getOsName

exportDriver

openGitHubConnection

createProxy

setup

setup

setup

setup

getDownloadedVersion

version

architecture

arch32

arch64

forceCache

forceDownload

driverRepositoryUrl

useTaobaoMirror

proxy

proxyUser

proxyPass

getBinaryPath

useBetaVersions