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

Class GitHubAccessor

java.lang.Object

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

Direct Known Subclasses:

GitHubAccessorWithBasicAuth, GitHubAccessorWithTokenAuth

public abstract class GitHubAccessor
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	GitHubAccessor.ApiEndpoints
static enum	GitHubAccessor.GitHubAccessorFieldNames
static final record	GitHubAccessor.HttpResponse
protected static interface	GitHubAccessor.ParserFunction<T,R>

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	apiBaseUrl
static final String	GITHUB_API_BASE_URL
static final int	MAX_PAGE_SIZE	A maximum 'per_page' allowed by GitHub API.
protected final com.atlassian.plugins.whitelist.OutboundWhitelist	outboundWhitelist

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	checkIfBaseUrlIsAllowed()
boolean	commentOnCommit(String commitId, VcsRepositoryData repositoryData, String message)	Adds a comment to a commit.
GithubWebhookDto	createWebhook(@NotNull String owner, @NotNull String repo, @NotNull String bambooEntrypoint)	Creates a webhook for the specified repository.
protected GitHubAccessor.HttpResponse	delete(@NotNull String url, @Nullable Multimap<String,String> headers)
void	destroyWebhook(@NotNull String owner, @NotNull String repo, @NotNull String webhookId)	Destroys a webhook for the specified repository.
protected List<String>	foldArrayAndSort(org.json.JSONArray repoJson, String field)
protected List<Integer>	foldIntegerArrayAndSort(org.json.JSONArray repoJson, String field)
abstract Iterable<String>	getAccessibleRepositories()	Retrieves a list of accessible repositories.
Iterable<String>	getBranches(String userRepo)	Retrieves a list of branches for the specified repository.
List<String>	getCommits(String owner, String repo)
protected <M extends org.apache.http.client.methods.HttpRequestBase> Pair<org.json.JSONArray,Multimap<String,String>>	getJSONArrayResponseFromUrl(@NotNull String url, @NotNull Consumer<RESTCall<M>> authenticationProvider, @NotNull Optional<String> nestedArrayFieldToAccess)
protected <T, M extends org.apache.http.client.methods.HttpRequestBase> List<T>	getPageableResults(@NotNull GitHubAccessor.ParserFunction<org.json.JSONArray,List<T>> parser, @NotNull String endpoint, @NotNull Consumer<RESTCall<M>> authenticationProvider, @NotNull Optional<String> nestedArrayField)
List<GithubPullRequestDto>	getPullRequests(VcsRepositoryData repositoryData)	Retrieves a list of pull requests for the specified repository.
protected <M extends org.apache.http.client.methods.HttpRequestBase> GitHubAccessor.HttpResponse	getStringFromUrl(@NotNull String url, @NotNull Consumer<RESTCall<M>> authenticationProvider)	Get a string from a given URL.
protected GitHubAccessor.HttpResponse	getStringFromUrl(String url)
Iterable<GithubWebhookDto>	getWebhooks(@NotNull String owner, @NotNull String repo)	Retrieves a list of webhooks for the specified repository.
protected GitHubAccessor.HttpResponse	post(@NotNull String url, @NotNull String payload, @Nullable Multimap<String,String> headers)
static String	sanitizeBaseUrl(@Nullable String apiBaseUrl)	Sanitizes the provided base URL by ensuring it's properly formatted as a GitHub API URL.
boolean	sendBuildStatus(String commitId, VcsRepositoryData repositoryData, Map<String,String> payload)	Sends a build status for a commit.
protected abstract <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 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

MAX_PAGE_SIZE

public static final int MAX_PAGE_SIZE

A maximum 'per_page' allowed by GitHub API. Greater values will be ignored and results will be returned in bulks of 100s anyway.

See: https://developer.github.com/v3/#pagination

See Also:

• Constant Field Values

outboundWhitelist

protected final com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist

apiBaseUrl

protected final String apiBaseUrl

Constructor Details

GitHubAccessor

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

Method Details

getAccessibleRepositories

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

Retrieves a list of accessible repositories.

Returns:

an iterable collection of accessible repository names

Throws:

IOException - if an I/O error occurs

GitHubException - if a GitHub-specific error occurs

getBranches

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

Retrieves a list of branches for the specified repository.

Parameters:

userRepo - the user repository in the format "owner/repo"

Returns:

an iterable collection of branch names

Throws:

IOException - if an I/O error occurs

GitHubException - if a GitHub-specific error occurs

getWebhooks

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

Retrieves a list of webhooks for the specified repository.

Parameters:

owner - the owner of the repository

repo - the name of the repository

Returns:

an iterable collection of GitHub webhook DTOs

Throws:

IOException - if an I/O error occurs

GitHubException - if a GitHub-specific error occurs

createWebhook

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

Creates a webhook for the specified repository.

Parameters:

owner - the owner of the repository

repo - the name of the repository

bambooEntrypoint - the Bamboo entry point URL

Returns:

the created GitHub webhook DTO

Throws:

GitHubException - if a GitHub-specific error occurs

destroyWebhook

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

Destroys a webhook for the specified repository.

Parameters:

owner - the owner of the repository

repo - the name of the repository

webhookId - the ID of the webhook to be destroyed

Throws:

GitHubException - if a GitHub-specific error occurs

commentOnCommit

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

Adds a comment to a commit.

Parameters:

commitId - the ID of the commit

repositoryData - the repository data

message - the comment message

Returns:

true if the comment was successfully added, false otherwise

Throws:

RepositoryException - if a repository-specific error occurs

GitHubException - if a GitHub-specific error occurs

sendBuildStatus

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

Sends a build status for a commit.

Parameters:

commitId - the ID of the commit

repositoryData - the repository data

payload - the payload containing the build status

Returns:

true if the build status was successfully sent, false otherwise

Throws:

RepositoryException - if a repository-specific error occurs

GitHubException - if a GitHub-specific error occurs

getPullRequests

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

Retrieves a list of pull requests for the specified repository.

Parameters:

repositoryData - the repository data

Returns:

a list of GitHub pull request DTOs

Throws:

IOException - if an I/O error occurs

GitHubException - if a GitHub-specific error occurs

getCommits

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

Throws:

IOException

GitHubException

setAuthentication

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

Sets the authentication details for the given REST call.

Type Parameters:

M - the type of the HTTP request

Parameters:

restCall - the REST call to set the authentication details for

getPageableResults

protected <T,
M extends org.apache.http.client.methods.HttpRequestBase>
List<T> getPageableResults(@NotNull
 @NotNull GitHubAccessor.ParserFunction<org.json.JSONArray,List<T>> parser,
 @NotNull
 @NotNull String endpoint,
 @NotNull
 @NotNull Consumer<RESTCall<M>> authenticationProvider,
 @NotNull
 @NotNull Optional<String> nestedArrayField)
                    throws GitHubException,
IOException

Throws:

GitHubException

IOException

checkIfBaseUrlIsAllowed

protected void checkIfBaseUrlIsAllowed()
                                throws GitHubException

Throws:

GitHubException

foldArrayAndSort

protected List<String> foldArrayAndSort(org.json.JSONArray repoJson,
 String field)
                                 throws GitHubException

Throws:

GitHubException

foldIntegerArrayAndSort

protected List<Integer> foldIntegerArrayAndSort(org.json.JSONArray repoJson,
 String field)
                                         throws GitHubException

Throws:

GitHubException

getJSONArrayResponseFromUrl

protected <M extends org.apache.http.client.methods.HttpRequestBase>
Pair<org.json.JSONArray,Multimap<String,String>> getJSONArrayResponseFromUrl(@NotNull
 @NotNull String url,
 @NotNull
 @NotNull Consumer<RESTCall<M>> authenticationProvider,
 @NotNull
 @NotNull Optional<String> nestedArrayFieldToAccess)
                                                                      throws IOException,
GitHubException

Throws:

IOException

GitHubException

getStringFromUrl

protected <M extends org.apache.http.client.methods.HttpRequestBase>
GitHubAccessor.HttpResponse getStringFromUrl(@NotNull
 @NotNull String url,
 @NotNull
 @NotNull Consumer<RESTCall<M>> authenticationProvider)
                                      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.

getStringFromUrl

protected GitHubAccessor.HttpResponse getStringFromUrl(String url)
                                                throws IOException

Throws:

IOException

sanitizeBaseUrl

public static String sanitizeBaseUrl(@Nullable
 @Nullable String apiBaseUrl)

Sanitizes the provided base URL by ensuring it's properly formatted as a GitHub API URL.

This method:

1. First removes any query parameters and URL fragments using UrlUtils.stripQueryAndRef(java.lang.String)
2. Then transforms the clean URL to the appropriate GitHub API format

For GitHub URLs:

• If the input is null, empty, or a github.com URL, returns https://api.github.com/
• For enterprise GitHub instances, appends "/api/v3/" to the base URL

Parameters:

apiBaseUrl - the URL to sanitize, can be null

Returns:

a sanitized GitHub API URL without query parameters or fragments

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