com.github.nscuro.wdm.binary

Interface BinaryManager

public interface BinaryManager

A manager for WebDriver binaries.

Since:

0.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BinaryManager.Builder

Method Summary

Modifier and Type	Method and Description
static BinaryManager.Builder.HttpClientStep	builder()
static BinaryManager	createDefault() Get the default BinaryManager.
default File	getLatestWebDriverBinary(Browser browser) Get the latest WebDriver binary (Os and Architecture will be auto-detected).
default File	getLatestWebDriverBinary(Browser browser, Os os, Architecture architecture) Get the latest WebDriver binary.
List<File>	getLocalWebDriverBinaries()
default File	getWebDriverBinary(Browser browser, String version) Get a specific version of a WebDriver binary (Os and Architecture will be auto-detected).
File	getWebDriverBinary(Browser browser, String version, Os os, Architecture architecture) Get a WebDriver binary.
void	registerWebDriverBinary(Browser browser, File webDriverBinaryFile) Register a given File as the WebDriver binary for a given Browser.

Method Detail

getWebDriverBinary

@Nonnull
File getWebDriverBinary(Browser browser,
                                 @Nullable
                                 String version,
                                 Os os,
                                 Architecture architecture)
                          throws IOException

Get a WebDriver binary.

Parameters:

browser - The Browser to get the WebDriver binary for

version - The version of the WebDriver binary to get. When null, the latest version will be used

os - The Os the binary must be compatible with

architecture - The Architecture the binary must be compatible with

Returns:

The WebDriver binary

Throws:

IOException - In case of a network or file error

registerWebDriverBinary

void registerWebDriverBinary(Browser browser,
                             File webDriverBinaryFile)

Register a given File as the WebDriver binary for a given Browser.

Parameters:

browser - The Browser to register the WebDriver binary for

webDriverBinaryFile - The binary File to register

Throws:

IllegalArgumentException - When the given File does not exist or is a directory

UnsupportedOperationException - When the given Browser does not support WebDriver binaries

getLocalWebDriverBinaries

@Nonnull
List<File> getLocalWebDriverBinaries()

Returns:

All locally stored WebDriver binary Files

getLatestWebDriverBinary

@Nonnull
default File getLatestWebDriverBinary(Browser browser)
                                        throws IOException

Get the latest WebDriver binary (Os and Architecture will be auto-detected).

Parameters:

browser - The Browser to get the WebDriver binary for

Returns:

The WebDriver binary

Throws:

IOException - In case of a network or file error

getWebDriverBinary

@Nonnull
default File getWebDriverBinary(Browser browser,
                                         String version)
                                  throws IOException

Get a specific version of a WebDriver binary (Os and Architecture will be auto-detected).

Parameters:

browser - The Browser to get the WebDriver binary for

version - The version of the WebDriver binary to get. When null, the latest version will be used

Returns:

The WebDriver binary

Throws:

IOException - In case of a network or file error

getLatestWebDriverBinary

@Nonnull
default File getLatestWebDriverBinary(Browser browser,
                                               Os os,
                                               Architecture architecture)
                                        throws IOException

Get the latest WebDriver binary.

Parameters:

browser - The Browser to get the WebDriver binary for

os - The Os the binary must be compatible with

architecture - The Architecture the binary must be compatible with

Returns:

The WebDriver binary

Throws:

IOException - In case of a network or file error

createDefault

@Nonnull
static BinaryManager createDefault()

Get the default BinaryManager.

Use this instead of builder() if you don't need to perform any customizations.

The following BinaryProviders are included:

     - ChromeDriverBinaryProvider
     - MicrosoftWebDriverBinaryProvider
     - GeckoDriverBinaryProvider
     - IEDriverServerBinaryProvider
     - OperaChromiumDriverBinaryProvider
 

Returns:

A BinaryManager instance

See Also:

BinaryManager.Builder.HttpClientStep.defaultHttpClient(), BinaryManager.Builder.BinaryDestinationDirStep.defaultBinaryDestinationDir()

builder

@Nonnull
static BinaryManager.Builder.HttpClientStep builder()