Package com.atlassian.bamboo.plugins.git

Class GitHubAccessor

java.lang.Object

com.atlassian.bamboo.plugins.git.GitHubAccessor

public class GitHubAccessor
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubAccessor.GitHubException
protected static class	GitHubAccessor.HttpResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GITHUB_API_BASE_URL

Constructor Summary

Constructors

Constructor	Description
GitHubAccessor(String username, String password, String apiBaseUrl, com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist)

Method Summary

Modifier and Type	Method	Description
boolean	commentOnCommit(String commitId, VcsRepositoryData repositoryData, String message)
GithubWebhookDto	createWebhook(@NotNull String owner, @NotNull String repo, @NotNull String bambooEntrypoint)
protected GitHubAccessor.HttpResponse	delete(@NotNull String url, @Nullable Multimap<String,String> headers)
void	deleteComment(String repo, String commentId)
void	destroyWebhook(@NotNull String owner, @NotNull String repo, @NotNull String webhookId)
Iterable<String>	getAccessibleRepositories()
Map<String,Iterable<String>>	getAccessibleRepositoriesAndBranches()
Iterable<String>	getBranches(String userRepo)
List<String>	getCommentIds(String repo, String commitId)
List<String>	getCommits(String repo)
List<String>	getCommits(String owner, String repo)
Iterable<String>	getOrganisationRepositories(String org)
List<GithubPullRequestDto>	getPullRequests(VcsRepositoryData repositoryData)
protected GitHubAccessor.HttpResponse	getStringFromUrl(String url)	Get a string from a given URL.
Iterable<String>	getUserOrganisations()
Iterable<String>	getUserRepositories()
Iterable<GithubWebhookDto>	getWebhooks(@NotNull String owner, @NotNull String repo)
protected GitHubAccessor.HttpResponse	post(@NotNull String url, @NotNull String payload, @Nullable Multimap<String,String> headers)
boolean	sendBuildStatus(String commitId, VcsRepositoryData repositoryData, Map<String,String> payload)
static String	transformBaseUrlToApiUrl(@Nullable String baseUrl)

Methods inherited from class java.lang.Object

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

Field Details

GITHUB_API_BASE_URL

public static final String GITHUB_API_BASE_URL

See Also:

• Constant Field Values

Constructor Details

GitHubAccessor

public GitHubAccessor(String username,
 String password,
 String apiBaseUrl,
 com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist)

Method Details

getAccessibleRepositories

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

Throws:

IOException

GitHubAccessor.GitHubException

getAccessibleRepositoriesAndBranches

public Map<String,Iterable<String>> getAccessibleRepositoriesAndBranches()
                                                                  throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

getBranches

public Iterable<String> getBranches(String userRepo)
                             throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

getWebhooks

public Iterable<GithubWebhookDto> getWebhooks(@NotNull
 @NotNull String owner,
 @NotNull
 @NotNull String repo)
                                       throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

createWebhook

public GithubWebhookDto createWebhook(@NotNull
 @NotNull String owner,
 @NotNull
 @NotNull String repo,
 @NotNull
 @NotNull String bambooEntrypoint)
                               throws GitHubAccessor.GitHubException

Throws:

GitHubAccessor.GitHubException

destroyWebhook

public void destroyWebhook(@NotNull
 @NotNull String owner,
 @NotNull
 @NotNull String repo,
 @NotNull
 @NotNull String webhookId)
                    throws GitHubAccessor.GitHubException

Throws:

GitHubAccessor.GitHubException

getUserOrganisations

public Iterable<String> getUserOrganisations()
                                      throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

getUserRepositories

public Iterable<String> getUserRepositories()
                                     throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

getOrganisationRepositories

public Iterable<String> getOrganisationRepositories(String org)
                                             throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

commentOnCommit

public boolean commentOnCommit(String commitId,
 VcsRepositoryData repositoryData,
 String message)
                        throws RepositoryException,
GitHubAccessor.GitHubException

Throws:

RepositoryException

GitHubAccessor.GitHubException

sendBuildStatus

public boolean sendBuildStatus(String commitId,
 VcsRepositoryData repositoryData,
 Map<String,String> payload)
                        throws RepositoryException,
GitHubAccessor.GitHubException

Throws:

RepositoryException

GitHubAccessor.GitHubException

getPullRequests

public List<GithubPullRequestDto> getPullRequests(VcsRepositoryData repositoryData)
                                           throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

getCommits

public List<String> getCommits(String repo)
                        throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

getCommits

public List<String> getCommits(String owner,
 String repo)
                        throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

getCommentIds

public List<String> getCommentIds(String repo,
 String commitId)
                           throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

deleteComment

public void deleteComment(String repo,
 String commentId)
                   throws IOException,
GitHubAccessor.GitHubException

Throws:

IOException

GitHubAccessor.GitHubException

getStringFromUrl

protected GitHubAccessor.HttpResponse getStringFromUrl(String url)
                                                throws IOException

Get a string from a given URL.

Parameters:

url - url to GET from.

Returns:

a Pair of String (response body) and a map of response headers.

Throws:

IOException - if a problem occurred in the IO layer.

post

protected GitHubAccessor.HttpResponse post(@NotNull
 @NotNull String url,
 @NotNull
 @NotNull String payload,
 @Nullable
 @Nullable Multimap<String,String> headers)
                                    throws IOException

Throws:

IOException

delete

protected GitHubAccessor.HttpResponse delete(@NotNull
 @NotNull String url,
 @Nullable
 @Nullable Multimap<String,String> headers)
                                      throws IOException

Throws:

IOException

transformBaseUrlToApiUrl

public static String transformBaseUrlToApiUrl(@Nullable
 @Nullable String baseUrl)