io.github.bonigarcia.wdm

Class WebDriverManager

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 CacheHandler	cacheHandler
protected Config	config
protected String	downloadedDriverPath
protected String	downloadedDriverVersion
protected Downloader	downloader
protected boolean	forcedArch
protected boolean	forcedOs
protected HttpClient	httpClient
protected static Map<DriverManagerType,WebDriverManager>	instanceMap
protected static String	LATEST_RELEASE
protected static org.slf4j.Logger	log
protected boolean	mirrorLog
protected ResolutionCache	resolutionCache
protected int	retryCount
protected static NamespaceContext	S3_NAMESPACE_CONTEXT
protected static String	SLASH
protected VersionDetector	versionDetector

Constructor Summary

Constructors

Constructor and Description
WebDriverManager()

Method Summary

Modifier and Type	Method and Description
WebDriverManager	arch32()
WebDriverManager	arch64()
WebDriverManager	architecture(Architecture architecture)
WebDriverManager	avoidBrowserDetection()
WebDriverManager	avoidExport()
WebDriverManager	avoidFallback()
WebDriverManager	avoidOutputTree()
WebDriverManager	avoidReadReleaseFromRepository()
WebDriverManager	avoidResolutionCache()
WebDriverManager	browserPath(String browserPath)
WebDriverManager	browserVersion(String browserVersion)
protected Optional<URL>	buildUrl(String driverVersion)
WebDriverManager	cachePath(String cachePath)
static WebDriverManager	chromedriver()
static WebDriverManager	chromiumdriver()
WebDriverManager	clearDriverCache()
WebDriverManager	clearResolutionCache()
Config	config()
protected UrlHandler	createUrlHandler(String driverVersion)
protected Optional<String>	detectBrowserVersion()
protected String	download(String driverVersion)
WebDriverManager	driverRepositoryUrl(URL url)
WebDriverManager	driverVersion(String driverVersion)
static WebDriverManager	edgedriver()
protected void	exportDriver(String variableValue)
protected void	fallback(Exception e, String errorMessage)
static WebDriverManager	firefoxdriver()
WebDriverManager	forceDownload()
protected abstract String	getBrowserVersion()
protected abstract Optional<String>	getBrowserVersionFromTheShell()
protected String	getCurrentVersion(URL url)
String	getDownloadedDriverPath()
String	getDownloadedDriverVersion()
abstract DriverManagerType	getDriverManagerType()
protected abstract String	getDriverName()
protected List<URL>	getDriversFromBitBucket()
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, String xpath, Optional<NamespaceContext> namespaceContext)
protected abstract URL	getDriverUrl()
protected URL	getDriverUrlCkeckingMirror(URL url)
protected abstract List<URL>	getDriverUrls()
protected abstract String	getDriverVersion()
protected Optional<String>	getDriverVersionFromRepository(Optional<String> driverVersion)
protected String	getDriverVersionLabel(String driverVersion)
List<String>	getDriverVersions()
protected abstract Optional<String>	getExportParameter()
protected FilenameFilter	getFolderFilter()
protected HttpClient	getHttpClient()
static WebDriverManager	getInstance(Class<?> webDriverClass)
static WebDriverManager	getInstance(DriverManagerType driverManagerType)
protected String	getKeyForResolutionCache()
protected Optional<String>	getLatestDriverVersionFromRepository()
protected String	getLatestVersionLabel()
protected abstract Optional<URL>	getMirrorUrl()
protected NamespaceContext	getNamespaceContext()
protected Optional<String>	getOsLabel()
protected String	getOtherProgramFilesEnv()
protected String	getProgramFilesEnv()
protected Optional<NamespaceContext>	getS3NamespaceContext()
protected String	getShortDriverName()
protected Optional<String>	getValueFromResolutionCache(String preferenceKey)
protected Charset	getVersionCharset()
WebDriverManager	gitHubTokenName(String gitHubTokenName)
WebDriverManager	gitHubTokenSecret(String gitHubTokenSecret)
static Config	globalConfig()
protected void	handleException(Exception e, String driverVersion)
static WebDriverManager	iedriver()
WebDriverManager	ignoreDriverVersions(String... driverVersions)
protected void	initResolutionCache()
protected boolean	isUnknown(String driverVersion)
WebDriverManager	linux()
protected Document	loadXML(InputStream inputStream)
WebDriverManager	localRepositoryPassword(String localRepositoryPassword)
WebDriverManager	localRepositoryUser(String localRepositoryUser)
protected static void	logCliError(String validBrowsers)
protected void	logSeekRepo(URL driverUrl)
WebDriverManager	mac()
static void	main(String[] args)
protected void	manage(String driverVersion)
protected InputStream	openGitHubConnection(URL driverUrl)
static WebDriverManager	operadriver()
WebDriverManager	operatingSystem(OperatingSystem os)
static WebDriverManager	phantomjs()
protected List<File>	postDownload(File archive)
WebDriverManager	properties(String properties)
WebDriverManager	proxy(String proxy)
WebDriverManager	proxyPass(String proxyPass)
WebDriverManager	proxyUser(String proxyUser)
protected void	reset()
WebDriverManager	resolutionCachePath(String resolutionCachePath)
protected String	resolveDriverVersion(String driverVersion)
protected static void	resolveLocal(String validBrowsers, String arg)
static WebDriverManager	seleniumServerStandalone()
protected abstract void	setBrowserVersion(String browserVersion)
protected void	setConfig(Config config)
protected abstract void	setDriverUrl(URL url)
protected abstract void	setDriverVersion(String driverVersion)
void	setup()
protected static void	startServer(String[] args)
protected void	storeInResolutionCache(String preferenceKey, String resolvedDriverVersion, String resolvedBrowserVersion)
WebDriverManager	timeout(int timeout)
WebDriverManager	ttl(int seconds)
WebDriverManager	ttlBrowsers(int seconds)
WebDriverManager	useBetaVersions()
WebDriverManager	useLocalVersionsPropertiesFirst()
WebDriverManager	useMirror()
protected boolean	useResolutionCache()
protected boolean	useResolutionCacheWithKey(String key)
protected static WebDriverManager	voiddriver()
WebDriverManager	win()

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

SLASH

protected static final String SLASH

See Also:

Constant Field Values

LATEST_RELEASE

protected static final String LATEST_RELEASE

See Also:

Constant Field Values

S3_NAMESPACE_CONTEXT

protected static final NamespaceContext S3_NAMESPACE_CONTEXT

instanceMap

protected static Map<DriverManagerType,WebDriverManager> instanceMap

httpClient

protected HttpClient httpClient

downloader

protected Downloader downloader

downloadedDriverVersion

protected String downloadedDriverVersion

downloadedDriverPath

protected String downloadedDriverPath

mirrorLog

protected boolean mirrorLog

forcedArch

protected boolean forcedArch

forcedOs

protected boolean forcedOs

retryCount

protected int retryCount

config

protected Config config

resolutionCache

protected ResolutionCache resolutionCache

cacheHandler

protected CacheHandler cacheHandler

versionDetector

protected VersionDetector versionDetector

Constructor Detail

WebDriverManager

public WebDriverManager()

Method Detail

getDriverUrls

protected abstract List<URL> getDriverUrls()
                                    throws IOException

Throws:

IOException

getBrowserVersionFromTheShell

protected abstract Optional<String> getBrowserVersionFromTheShell()

getDriverName

protected abstract String getDriverName()

getDriverVersion

protected abstract String getDriverVersion()

setDriverVersion

protected abstract void setDriverVersion(String driverVersion)

getBrowserVersion

protected abstract String getBrowserVersion()

setBrowserVersion

protected abstract void setBrowserVersion(String browserVersion)

setDriverUrl

protected abstract void setDriverUrl(URL url)

getDriverUrl

protected abstract URL getDriverUrl()

getMirrorUrl

protected abstract Optional<URL> getMirrorUrl()

getExportParameter

protected abstract Optional<String> getExportParameter()

getDriverManagerType

public abstract DriverManagerType getDriverManagerType()

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()

driverVersion

public WebDriverManager driverVersion(String driverVersion)

browserVersion

public WebDriverManager browserVersion(String browserVersion)

architecture

public WebDriverManager architecture(Architecture architecture)

arch32

public WebDriverManager arch32()

arch64

public WebDriverManager arch64()

win

public WebDriverManager win()

linux

public WebDriverManager linux()

mac

public WebDriverManager mac()

operatingSystem

public WebDriverManager operatingSystem(OperatingSystem os)

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()

ignoreDriverVersions

public WebDriverManager ignoreDriverVersions(String... driverVersions)

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)

cachePath

public WebDriverManager cachePath(String cachePath)

resolutionCachePath

public WebDriverManager resolutionCachePath(String resolutionCachePath)

avoidExport

public WebDriverManager avoidExport()

avoidOutputTree

public WebDriverManager avoidOutputTree()

avoidBrowserDetection

public WebDriverManager avoidBrowserDetection()

avoidResolutionCache

public WebDriverManager avoidResolutionCache()

avoidFallback

public WebDriverManager avoidFallback()

avoidReadReleaseFromRepository

public WebDriverManager avoidReadReleaseFromRepository()

ttl

public WebDriverManager ttl(int seconds)

ttlBrowsers

public WebDriverManager ttlBrowsers(int seconds)

browserPath

public WebDriverManager browserPath(String browserPath)

useLocalVersionsPropertiesFirst

public WebDriverManager useLocalVersionsPropertiesFirst()

clearResolutionCache

public WebDriverManager clearResolutionCache()

clearDriverCache

public WebDriverManager clearDriverCache()

getDownloadedDriverPath

public String getDownloadedDriverPath()

getDownloadedDriverVersion

public String getDownloadedDriverVersion()

getDriverVersions

public List<String> getDriverVersions()

manage

protected void manage(String driverVersion)

resolveDriverVersion

protected String resolveDriverVersion(String driverVersion)

initResolutionCache

protected void initResolutionCache()

download

protected String download(String driverVersion)
                   throws IOException

Throws:

IOException

exportDriver

protected void exportDriver(String variableValue)

storeInResolutionCache

protected void storeInResolutionCache(String preferenceKey,
                                      String resolvedDriverVersion,
                                      String resolvedBrowserVersion)

getValueFromResolutionCache

protected Optional<String> getValueFromResolutionCache(String preferenceKey)

postDownload

protected List<File> postDownload(File archive)

detectBrowserVersion

protected Optional<String> detectBrowserVersion()

useResolutionCacheWithKey

protected boolean useResolutionCacheWithKey(String key)

useResolutionCache

protected boolean useResolutionCache()

isUnknown

protected boolean isUnknown(String driverVersion)

getCurrentVersion

protected String getCurrentVersion(URL url)

handleException

protected void handleException(Exception e,
                               String driverVersion)

fallback

protected void fallback(Exception e,
                        String errorMessage)

createUrlHandler

protected UrlHandler createUrlHandler(String driverVersion)
                               throws IOException

Throws:

IOException

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

getNamespaceContext

protected NamespaceContext getNamespaceContext()

getS3NamespaceContext

protected Optional<NamespaceContext> getS3NamespaceContext()

getDriversFromXml

protected List<URL> getDriversFromXml(URL driverUrl,
                                      String xpath,
                                      Optional<NamespaceContext> namespaceContext)
                               throws IOException

Throws:

IOException

logSeekRepo

protected void logSeekRepo(URL driverUrl)

loadXML

protected Document loadXML(InputStream inputStream)
                    throws SAXException,
                           IOException,
                           ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

openGitHubConnection

protected InputStream openGitHubConnection(URL driverUrl)
                                    throws IOException

Throws:

IOException

getDriversFromGitHub

protected List<URL> getDriversFromGitHub()
                                  throws IOException

Throws:

IOException

getDriversFromBitBucket

protected List<URL> getDriversFromBitBucket()
                                     throws IOException

Throws:

IOException

getHttpClient

protected HttpClient getHttpClient()

getFolderFilter

protected FilenameFilter getFolderFilter()

getVersionCharset

protected Charset getVersionCharset()

getLatestVersionLabel

protected String getLatestVersionLabel()

getOsLabel

protected Optional<String> getOsLabel()

getDriverVersionFromRepository

protected Optional<String> getDriverVersionFromRepository(Optional<String> driverVersion)

reset

protected void reset()

getProgramFilesEnv

protected String getProgramFilesEnv()

getOtherProgramFilesEnv

protected String getOtherProgramFilesEnv()

getDriverUrlCkeckingMirror

protected URL getDriverUrlCkeckingMirror(URL url)

resolveLocal

protected static void resolveLocal(String validBrowsers,
                                   String arg)

startServer

protected static void startServer(String[] args)

logCliError

protected static void logCliError(String validBrowsers)

setConfig

protected void setConfig(Config config)

getLatestDriverVersionFromRepository

protected Optional<String> getLatestDriverVersionFromRepository()

getShortDriverName

protected String getShortDriverName()

getKeyForResolutionCache

protected String getKeyForResolutionCache()

getDriverVersionLabel

protected String getDriverVersionLabel(String driverVersion)

buildUrl

protected Optional<URL> buildUrl(String driverVersion)

main

public static void main(String[] args)