Package com.atlassian.bamboo.plugins.github.accessor

Class GitHubAccessorWithTokenAuth

java.lang.Object

com.atlassian.bamboo.plugins.github.accessor.GitHubAccessor

com.atlassian.bamboo.plugins.github.accessor.GitHubAccessorWithTokenAuth

public class GitHubAccessorWithTokenAuth
extends GitHubAccessor

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.bamboo.plugins.github.accessor.GitHubAccessor

GitHubAccessor.ApiEndpoints, GitHubAccessor.GitHubAccessorFieldNames, GitHubAccessor.HttpResponse, GitHubAccessor.ParserFunction<T,R>

Field Summary

Fields inherited from class com.atlassian.bamboo.plugins.github.accessor.GitHubAccessor

apiBaseUrl, GITHUB_API_BASE_URL, MAX_PAGE_SIZE, outboundWhitelist

Constructor Summary

Constructors

Constructor	Description
GitHubAccessorWithTokenAuth(@Nullable String authToken, @Nullable String apiBaseUrl, @NotNull com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist)

Method Summary

Modifier and Type	Method	Description
Iterable<String>	getAccessibleRepositories()	Retrieves a list of accessible repositories.
protected <M extends org.apache.http.client.methods.HttpRequestBase> void	setAuthentication(@NotNull RESTCall<M> restCall)	Sets the authentication details for the given REST call.

Methods inherited from class com.atlassian.bamboo.plugins.github.accessor.GitHubAccessor

checkIfBaseUrlIsAllowed, commentOnCommit, createWebhook, delete, destroyWebhook, foldArrayAndSort, foldIntegerArrayAndSort, getBranches, getCommits, getJSONArrayResponseFromUrl, getPageableResults, getPullRequests, getStringFromUrl, getStringFromUrl, getWebhooks, post, sanitizeBaseUrl, sendBuildStatus

Methods inherited from class java.lang.Object

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

Constructor Details

GitHubAccessorWithTokenAuth

public GitHubAccessorWithTokenAuth(@Nullable
 @Nullable String authToken,
 @Nullable
 @Nullable String apiBaseUrl,
 @NotNull
 @NotNull com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist)

Method Details

getAccessibleRepositories

public Iterable<String> getAccessibleRepositories()
                                           throws IOException,
GitHubException

Description copied from class: GitHubAccessor

Retrieves a list of accessible repositories.

Specified by:

getAccessibleRepositories in class GitHubAccessor

Returns:

an iterable collection of accessible repository names

Throws:

IOException - if an I/O error occurs

GitHubException - if a GitHub-specific error occurs

setAuthentication

protected <M extends org.apache.http.client.methods.HttpRequestBase>
void setAuthentication(@NotNull
 @NotNull RESTCall<M> restCall)

Description copied from class: GitHubAccessor

Sets the authentication details for the given REST call.

Specified by:

setAuthentication in class GitHubAccessor

Type Parameters:

M - the type of the HTTP request

Parameters:

restCall - the REST call to set the authentication details for