org.jboss.arquillian.drone.webdriver.binary.downloading.source

Class XmlStorageSource

java.lang.Object

org.jboss.arquillian.drone.webdriver.binary.downloading.source.XmlStorageSource

All Implemented Interfaces:

ExternalBinarySource

Direct Known Subclasses:

SeleniumXmlStorageSource

public abstract class XmlStorageSource
extends Object
implements ExternalBinarySource

XmlStorageSource source is an abstract class that helps you to retrieve either latest release or a release with some version from some specific XML-based storage, such as S3 buckets. Eg. http://selenium-release.storage.googleapis.com/ for selenium bits or https://chromedriver.storage.googleapis.com/ for chrome web-drivers

Field Summary

Fields

Modifier and Type	Field and Description
protected String	fileName
protected String	nodeName

Constructor Summary

Constructors

Constructor and Description
XmlStorageSource(String storageUrl, HttpClient httpClient)
XmlStorageSource(String storageUrl, String urlToLatestRelease, HttpClient httpClient)
XmlStorageSource(String nodeName, String fileName, String storageUrl, String urlToLatestRelease, HttpClient httpClient)

Method Summary

Modifier and Type	Method and Description
protected String	getContentOfFirstElement(Element element, String tagName)
protected NodeList	getDriverEntries(Document doc)
protected abstract String	getExpectedKeyRegex(String requiredVersion, String directory) It is expected that this abstract method should return a regex that represents a key of an expected binary/file stored in the xml storage.
protected String	getLastModified(Element element)
ExternalBinary	getLatestRelease() Retrieves information about the latest release of binary and returns an instance of ExternalBinary that represents the latest release.
protected ExternalBinary	getLatestRelease(String charset)
protected String	getLocation(Element element)
ExternalBinary	getReleaseForVersion(String requiredVersion) Retrieves information about a binary release with the desired version and returns an instance of ExternalBinary that represents the found release.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.arquillian.drone.webdriver.binary.downloading.source.ExternalBinarySource

getFileNameRegexToDownload

Field Detail

nodeName

protected String nodeName

fileName

protected String fileName

Constructor Detail

XmlStorageSource

public XmlStorageSource(String nodeName,
                        String fileName,
                        String storageUrl,
                        String urlToLatestRelease,
                        HttpClient httpClient)

XmlStorageSource

public XmlStorageSource(String storageUrl,
                        HttpClient httpClient)

Parameters:

storageUrl - An url to a xml storage from which information about releases should be retrieved from

XmlStorageSource

public XmlStorageSource(String storageUrl,
                        String urlToLatestRelease,
                        HttpClient httpClient)

Parameters:

storageUrl - An url to a xml storage from which information about releases should be retrieved from

urlToLatestRelease - An url where a version of the latest release could be retrieved from

Method Detail

getLatestRelease

public ExternalBinary getLatestRelease()
                                throws Exception

Description copied from interface: ExternalBinarySource

Retrieves information about the latest release of binary and returns an instance of ExternalBinary that represents the latest release.

Specified by:

getLatestRelease in interface ExternalBinarySource

Returns:

An instance of ExternalBinary that contains information about the latest release of the binary.

Throws:

Exception - If anything bad happens

getLatestRelease

protected ExternalBinary getLatestRelease(String charset)
                                   throws Exception

Throws:

Exception

getDriverEntries

protected NodeList getDriverEntries(Document doc)

getLastModified

protected String getLastModified(Element element)

getLocation

protected String getLocation(Element element)

getContentOfFirstElement

protected String getContentOfFirstElement(Element element,
                                          String tagName)

getReleaseForVersion

public ExternalBinary getReleaseForVersion(String requiredVersion)
                                    throws Exception

Description copied from interface: ExternalBinarySource

Retrieves information about a binary release with the desired version and returns an instance of ExternalBinary that represents the found release.

Specified by:

getReleaseForVersion in interface ExternalBinarySource

Parameters:

requiredVersion - A version of a binary release that should be retrieved.

Returns:

An instance of ExternalBinary that contains information about a binary release with the desired version.

Throws:

Exception

getExpectedKeyRegex

protected abstract String getExpectedKeyRegex(String requiredVersion,
                                              String directory)

It is expected that this abstract method should return a regex that represents a key of an expected binary/file stored in the xml storage. Commonly, key consists of directory_name + / + file_name.

Parameters:

requiredVersion - The required version set using method getReleaseForVersion(java.lang.String), or otherwise null

directory - The directory for the current binary the regex is being matched against

Returns:

A regex that represents a key of an expected binary/file.