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

Class GitHubSource

java.lang.Object

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

All Implemented Interfaces:

ExternalBinarySource

Direct Known Subclasses:

GeckoDriverGitHubSource

public abstract class GitHubSource
extends Object
implements ExternalBinarySource

GitHub source is an abstract class that helps you to retrieve either latest release or a release with some version from some specific repository.

Author:

Matous Jobanek

Constructor Summary

Constructors

Constructor and Description
GitHubSource(String organization, String project, HttpClient httpClient, GitHubLastUpdateCache gitHubLastUpdateCache)

Method Summary

Modifier and Type	Method and Description
protected abstract String	getExpectedFileNameRegex(String version) It is expected that this abstract method should return a regex that represents an expected file name of the release asset.
ExternalBinary	getLatestRelease() Retrieves information about the latest release of binary and returns an instance of ExternalBinary that represents the latest release.
ExternalBinary	getReleaseForVersion(String version) 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

Constructor Detail

GitHubSource

public GitHubSource(String organization,
                    String project,
                    HttpClient httpClient,
                    GitHubLastUpdateCache gitHubLastUpdateCache)

Parameters:

organization - GitHub organization/user name the project belongs to

project - GitHub project name

Method Detail

getExpectedFileNameRegex

protected abstract String getExpectedFileNameRegex(String version)

It is expected that this abstract method should return a regex that represents an expected file name of the release asset. These names are visible on pages of some specific release or accessible via api.github request.

Returns:

A regex that represents an expected file name of an asset associated with the required release.

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

getReleaseForVersion

public ExternalBinary getReleaseForVersion(String version)
                                    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:

version - 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