com.atlassian.bamboo.plugins.bitbucket.api

Interface BitbucketApiService

All Known Implementing Classes:

BitbucketApiServiceImpl

public interface BitbucketApiService

Method Summary

Modifier and Type	Method and Description
void	deleteComment(String username, String password, String repositorySlug, String commitId, String commentId) Delete commit comment.
BitbucketPageEntity<BitbucketNodeEntity>	findBranches(String owner, String slug, String username, String password, String queryString, int start, int limit)
BitbucketPageEntity<BitbucketResourceEntity>	findPublicRepositories(String username, String queryString, int start, int limit) Return a filtered list of public repositories that user has access to.
BitbucketPageEntity<BitbucketResourceEntity>	findRepositories(String username, String password, String queryString, int start, int limit) Return a filtered list of accessible to Bitbucket user.
BitbucketNodeEntity	getBranch(String owner, String slug, String branch, String username, String password) Returns a branch of a repository if it exists, throws exception (404) if not.
List<BitbucketNodeEntity>	getBranches(String owner, String slug, String username, String password) Retrieve list of all branches for given repository
List<String>	getCommentIds(String username, String password, String repositorySlug, String commitId) Fetch comment ids by commit id.
List<String>	getCommits(String username, String password, String repositorySlug, int limit) Fetch repository commits.
BitbucketNodeEntity	getDefaultBranch(String owner, String slug, String username, String password) Fetch default branch of a repository.
List<BitbucketResourceEntity>	getPublicRepositories(String username) Return a list of all public repositories that user has access to.
List<BitbucketResourceEntity>	getPublicRepositories(String username, String queryString) Return a list of all public repositories that user has access to.
List<BitbucketResourceEntity>	getRepositories(String username, String password) Retrieve list of all repositories accessible to Bitbucket user
List<BitbucketResourceEntity>	getRepositories(String username, String password, String queryString) Retrieve list of all repositories accessible to Bitbucket user
BitbucketResourceEntity	getRepository(String owner, String slug, String username, String password) Retrieve data about single Bitbucket repository.
String	getUuidForWorkspaceOrUsername(String identifier, String secret) Fetch UUID for given identifier.
void	updateBuildStatus(String owner, String slug, String revision, RestBuildStatus buildStatus, String username, String password) Send build status update to Bitbucket server

Method Detail

getPublicRepositories

@NotNull
List<BitbucketResourceEntity> getPublicRepositories(@NotNull
                                                             String username)
                                                      throws BitbucketApiException

Return a list of all public repositories that user has access to.

Throws:

BitbucketApiException

getPublicRepositories

@NotNull
List<BitbucketResourceEntity> getPublicRepositories(@NotNull
                                                             String username,
                                                             @Nullable
                                                             String queryString)
                                                      throws BitbucketApiException

Return a list of all public repositories that user has access to.

Throws:

BitbucketApiException

findPublicRepositories

@NotNull
BitbucketPageEntity<BitbucketResourceEntity> findPublicRepositories(@NotNull
                                                                             String username,
                                                                             @Nullable
                                                                             String queryString,
                                                                             int start,
                                                                             int limit)
                                                                      throws BitbucketApiException

Return a filtered list of public repositories that user has access to. The length of the list is limited.

Throws:

BitbucketApiException

getRepositories

@NotNull
List<BitbucketResourceEntity> getRepositories(@NotNull
                                                       String username,
                                                       @NotNull
                                                       String password)
                                                throws BitbucketApiException

Retrieve list of all repositories accessible to Bitbucket user

Parameters:

username -

password -

Returns:

Throws:

BitbucketApiException

getRepositories

@NotNull
List<BitbucketResourceEntity> getRepositories(@NotNull
                                                       String username,
                                                       @NotNull
                                                       String password,
                                                       @Nullable
                                                       String queryString)
                                                throws BitbucketApiException

Retrieve list of all repositories accessible to Bitbucket user

Parameters:

username -

password -

Throws:

BitbucketApiException

findRepositories

@NotNull
BitbucketPageEntity<BitbucketResourceEntity> findRepositories(@NotNull
                                                                       String username,
                                                                       @NotNull
                                                                       String password,
                                                                       @Nullable
                                                                       String queryString,
                                                                       int start,
                                                                       int limit)
                                                                throws BitbucketApiException

Return a filtered list of accessible to Bitbucket user. The length of the list is limited.

Throws:

BitbucketApiException

getBranches

@NotNull
List<BitbucketNodeEntity> getBranches(@NotNull
                                               String owner,
                                               @NotNull
                                               String slug,
                                               @NotNull
                                               String username,
                                               @Nullable
                                               String password)
                                        throws BitbucketApiException

Retrieve list of all branches for given repository

Parameters:

owner -

slug -

username -

password -

Returns:

Throws:

BitbucketApiException

findBranches

@NotNull
BitbucketPageEntity<BitbucketNodeEntity> findBranches(@NotNull
                                                               String owner,
                                                               @NotNull
                                                               String slug,
                                                               @NotNull
                                                               String username,
                                                               @Nullable
                                                               String password,
                                                               @Nullable
                                                               String queryString,
                                                               int start,
                                                               int limit)
                                                        throws BitbucketApiException

Throws:

BitbucketApiException

getRepository

@NotNull
BitbucketResourceEntity getRepository(@NotNull
                                               String owner,
                                               @NotNull
                                               String slug,
                                               @Nullable
                                               String username,
                                               @Nullable
                                               String password)
                                        throws BitbucketApiException

Retrieve data about single Bitbucket repository.

Throws:

BitbucketApiException

getDefaultBranch

@NotNull
BitbucketNodeEntity getDefaultBranch(@NotNull
                                              String owner,
                                              @NotNull
                                              String slug,
                                              @Nullable
                                              String username,
                                              @Nullable
                                              String password)
                                       throws BitbucketApiException

Fetch default branch of a repository.

Throws:

BitbucketApiException

getBranch

@NotNull
BitbucketNodeEntity getBranch(@NotNull
                                       String owner,
                                       @NotNull
                                       String slug,
                                       @NotNull
                                       String branch,
                                       @Nullable
                                       String username,
                                       @Nullable
                                       String password)
                                throws BitbucketApiException

Returns a branch of a repository if it exists, throws exception (404) if not.

Throws:

BitbucketApiException

getUuidForWorkspaceOrUsername

@Nullable
String getUuidForWorkspaceOrUsername(@NotNull
                                               String identifier,
                                               @NotNull
                                               String secret)

Fetch UUID for given identifier.

Parameters:

identifier - might be username, email, team name or workspace.

secret - the password of the uuid account

Returns:

getCommits

List<String> getCommits(String username,
                        String password,
                        String repositorySlug,
                        int limit)
                 throws BitbucketApiException,
                        com.opensymphony.webwork.dispatcher.json.JSONException

Fetch repository commits.

Throws:

BitbucketApiException

com.opensymphony.webwork.dispatcher.json.JSONException

getCommentIds

List<String> getCommentIds(String username,
                           String password,
                           String repositorySlug,
                           String commitId)
                    throws BitbucketApiException,
                           com.opensymphony.webwork.dispatcher.json.JSONException

Fetch comment ids by commit id.

Throws:

BitbucketApiException

com.opensymphony.webwork.dispatcher.json.JSONException

deleteComment

void deleteComment(String username,
                   String password,
                   String repositorySlug,
                   String commitId,
                   String commentId)

Delete commit comment.

updateBuildStatus

void updateBuildStatus(@NotNull
                       String owner,
                       @NotNull
                       String slug,
                       @NotNull
                       String revision,
                       @NotNull
                       RestBuildStatus buildStatus,
                       @NotNull
                       String username,
                       @NotNull
                       String password)
                throws BitbucketApiException

Send build status update to Bitbucket server

Parameters:

owner - repository owner

slug - repository slug

revision - changeset revision

buildStatus - payload to be sent to Bitbucket

username - credentials used to authenticate against Bitbucket

password - credentials used to authenticate against Bitbucket

Throws:

BitbucketApiException