org.jboss.arquillian.drone.webdriver.binary.handler

Class InternetExplorerBinaryHandler

java.lang.Object

org.jboss.arquillian.drone.webdriver.binary.handler.AbstractBinaryHandler

org.jboss.arquillian.drone.webdriver.binary.handler.InternetExplorerBinaryHandler

All Implemented Interfaces:

BinaryHandler

public class InternetExplorerBinaryHandler
extends AbstractBinaryHandler

A class for handling driver binaries for internet explorer

Author:

Matous Jobanek

Field Summary

Fields

Modifier and Type	Field and Description
static String	IE_SYSTEM_DRIVER_BINARY_PROPERTY

Fields inherited from class org.jboss.arquillian.drone.webdriver.binary.handler.AbstractBinaryHandler

DOWNLOAD_BINARIES_PROPERTY

Constructor Summary

Constructors

Constructor and Description
InternetExplorerBinaryHandler(org.openqa.selenium.remote.DesiredCapabilities capabilities)

Method Summary

Modifier and Type	Method and Description
File	downloadAndPrepare() This method consist of four steps:
protected String	getArquillianCacheSubdirectory() Name of the subdirectory that should be used for this binary handler in the Drone cache directory ($HOME/.arquillian/drone)
protected String	getBinaryProperty() This method should return a capability property name which a path to an executable binary could be stored under
protected org.openqa.selenium.remote.DesiredCapabilities	getCapabilities() This method should return a desired capabilities with stored properties
protected String	getDesiredVersionProperty() This method should return a capability property name which a desired version of a binary could be stored under
protected ExternalBinarySource	getExternalBinarySource() This method should return an instance of an ExternalBinary that should be used for retrieving available releases of a binary
String	getSystemBinaryProperty() This method should return a system property name which a path to an executable binary should be stored under
protected String	getUrlToDownloadProperty() This method should return a capability property name which a url pointing to a desired binary could be stored under

Methods inherited from class org.jboss.arquillian.drone.webdriver.binary.handler.AbstractBinaryHandler

checkAndSetBinary, downloadAndPrepare, downloadAndPrepare, markAsExecutable, setBinaryAsSystemProperty

Methods inherited from class java.lang.Object

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

Field Detail

IE_SYSTEM_DRIVER_BINARY_PROPERTY

public static final String IE_SYSTEM_DRIVER_BINARY_PROPERTY

See Also:

Constant Field Values

Constructor Detail

InternetExplorerBinaryHandler

public InternetExplorerBinaryHandler(org.openqa.selenium.remote.DesiredCapabilities capabilities)

Method Detail

getArquillianCacheSubdirectory

protected String getArquillianCacheSubdirectory()

Description copied from class: AbstractBinaryHandler

Name of the subdirectory that should be used for this binary handler in the Drone cache directory ($HOME/.arquillian/drone)

Specified by:

getArquillianCacheSubdirectory in class AbstractBinaryHandler

Returns:

Name of the subdirectory that should be used for this binary handler in the Drone cache directory

getDesiredVersionProperty

protected String getDesiredVersionProperty()

Description copied from class: AbstractBinaryHandler

This method should return a capability property name which a desired version of a binary could be stored under

Specified by:

getDesiredVersionProperty in class AbstractBinaryHandler

Returns:

A capability property name under a desired version of a binary could be stored under

getUrlToDownloadProperty

protected String getUrlToDownloadProperty()

Description copied from class: AbstractBinaryHandler

This method should return a capability property name which a url pointing to a desired binary could be stored under

Specified by:

getUrlToDownloadProperty in class AbstractBinaryHandler

Returns:

A capability property name which a url pointing to a desired binary could be stored under

getExternalBinarySource

protected ExternalBinarySource getExternalBinarySource()

Description copied from class: AbstractBinaryHandler

This method should return an instance of an ExternalBinary that should be used for retrieving available releases of a binary

Specified by:

getExternalBinarySource in class AbstractBinaryHandler

Returns:

An instance of an ExternalBinary that should be used for retrieving available releases of a binary

getCapabilities

protected org.openqa.selenium.remote.DesiredCapabilities getCapabilities()

Description copied from class: AbstractBinaryHandler

This method should return a desired capabilities with stored properties

Specified by:

getCapabilities in class AbstractBinaryHandler

Returns:

A desired capabilities with stored properties

getBinaryProperty

protected String getBinaryProperty()

Description copied from class: AbstractBinaryHandler

This method should return a capability property name which a path to an executable binary could be stored under

Specified by:

getBinaryProperty in class AbstractBinaryHandler

Returns:

A capability property name which a path to an executable binary could be stored under

getSystemBinaryProperty

public String getSystemBinaryProperty()

Description copied from class: AbstractBinaryHandler

This method should return a system property name which a path to an executable binary should be stored under

Specified by:

getSystemBinaryProperty in interface BinaryHandler

Specified by:

getSystemBinaryProperty in class AbstractBinaryHandler

Returns:

A system property name which a path to an executable binary should be stored under

downloadAndPrepare

public File downloadAndPrepare()
                        throws Exception

Description copied from class: AbstractBinaryHandler

This method consist of four steps:

1. Checking properties

In the first step it checks capabilities if there is set either url a binary should be downloaded from or a desired binary version. For more information see methods AbstractBinaryHandler.getUrlToDownloadProperty() and AbstractBinaryHandler.getDesiredVersionProperty().

2. Downloading

If the url is set then the binary is downloaded from the given url.

If there is set only the desired version, then a binary with the specified version is downloaded using an external binary source (AbstractBinaryHandler.getExternalBinarySource())

If there is set neither a url nor a desired version, then a binary with the latest version is downloaded using the external binary source.

Directory where the downloaded file is stored depends on set properties. If there is set the desired version, or if the latest version is downloaded then the file is stored in:
$HOME/.arquillian/drone/ + AbstractBinaryHandler.getArquillianCacheSubdirectory() + / + version
If the version is not set, then the file is stored in: target/drone/downloaded

3. Extraction/copy

When the file is downloaded then it is expected that in most cases it is an archive (zip, tar) file. If the file is an archive then it is extracted; if the file is not an archive file, then it is copied. The targeted directory for this operation is:
target/drone/md5hash(downloaded_file)/

4. Setting as executable

In the last step the extracted/copied file is set as an executalbe file.

Specified by:

downloadAndPrepare in interface BinaryHandler

Overrides:

downloadAndPrepare in class AbstractBinaryHandler

Returns:

An executable binary that was extracted/copied from the downloaded file

Throws:

Exception - If anything bad happens