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, PhantomJSGitHubBitbucketSource

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHORIZATION_HEADER_KEY
static String	BASIC_AUTHORIZATION_HEADER_VALUE_PREFIX
static String	GITHUB_TOKEN_PROPERTY
static String	GITHUB_USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
GitHubSource(String organization, String project, HttpClient httpClient, GitHubLastUpdateCache gitHubLastUpdateCache)
GitHubSource(String organization, String project, HttpClient httpClient, GitHubLastUpdateCache gitHubLastUpdateCache, org.openqa.selenium.remote.DesiredCapabilities capabilities)

Method Summary

Modifier and Type	Method and Description
protected ZonedDateTime	extractModificationDate(HttpClient.Response response)
protected String	findReleaseBinaryUrl(com.google.gson.JsonObject releaseObject, String version)
protected GitHubLastUpdateCache	getCache()
protected com.google.gson.Gson	getGson()
ExternalBinary	getLatestRelease() Retrieves information about the latest release of binary and returns an instance of ExternalBinary that represents the latest release.
protected String	getProjectUrl()
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.
protected String	getUniqueKey()
protected Map<String,String>	lastModificationHeader()
protected HttpClient.Response	sentGetRequestWithPagination(String url, int pageNumber, Map<String,String> headers)

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, getFileNameRegexToDownload, getReleaseForVersion

Field Detail

GITHUB_USERNAME_PROPERTY

public static final String GITHUB_USERNAME_PROPERTY

See Also:

Constant Field Values

GITHUB_TOKEN_PROPERTY

public static final String GITHUB_TOKEN_PROPERTY

See Also:

Constant Field Values

AUTHORIZATION_HEADER_KEY

public static final String AUTHORIZATION_HEADER_KEY

See Also:

Constant Field Values

BASIC_AUTHORIZATION_HEADER_VALUE_PREFIX

public static final String BASIC_AUTHORIZATION_HEADER_VALUE_PREFIX

See Also:

Constant Field Values

Constructor Detail

GitHubSource

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

GitHubSource

public GitHubSource(String organization,
                    String project,
                    HttpClient httpClient,
                    GitHubLastUpdateCache gitHubLastUpdateCache,
                    org.openqa.selenium.remote.DesiredCapabilities capabilities)

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

lastModificationHeader

protected Map<String,String> lastModificationHeader()

extractModificationDate

protected ZonedDateTime extractModificationDate(HttpClient.Response response)

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

findReleaseBinaryUrl

protected String findReleaseBinaryUrl(com.google.gson.JsonObject releaseObject,
                                      String version)
                               throws Exception

Throws:

Exception

sentGetRequestWithPagination

protected HttpClient.Response sentGetRequestWithPagination(String url,
                                                           int pageNumber,
                                                           Map<String,String> headers)
                                                    throws Exception

Throws:

Exception

getProjectUrl

protected String getProjectUrl()

getGson

protected com.google.gson.Gson getGson()

getUniqueKey

protected String getUniqueKey()

getCache

protected GitHubLastUpdateCache getCache()