com.atlassian.bamboo.plugins.rest.resource

Class ResultResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.resource.ResultResource

@Singleton
public class ResultResource
extends Object

Provide build results information. Available for anonymous and authenticated users, however proper permissions are enforced

Constructor Summary

Constructors

Constructor and Description
ResultResource(ResultService resultService, FeatureManager featureManager)

Method Summary

Modifier and Type	Method and Description
void	addBuildComment(String projectKey, String buildKey, String buildNumber, RestComment comment, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext, javax.ws.rs.core.UriInfo uriInfo) Adds new comment to build result specified by projectKey-buildKey-buildNumber.
void	addBuildLabel(String projectKey, String buildKey, String buildNumber, RestBuildLabel label, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext, javax.ws.rs.core.UriInfo uriInfo) Adds new label to build result specified by projectKey-buildKey-buildNumber.
RestResults	getBranchHistory(String projectKey, String buildKey, String branchName, String expandParam, boolean favouriteParam, String labelParam, String issueKeyParam, boolean allStatesParam, boolean continuableParam, boolean buildStateParam, int startIndexParam, int maxResultsParam, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide list of build results for specified plan.
Result	getBuild(String projectKey, String buildKey, String buildNumber, String expandParam, boolean favouriteParam, int startIndexParam, int maxResultsParam, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide build result specified by projectKey-buildKey-buildNumber.
Result	getBuildAlias(String projectKey, String buildKey, String buildNumber, String expandParam, boolean favouriteParam, int startIndexParam, int maxResultsParam, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide build result specified by projectKey-buildKey-buildNumber.
RestComments	getBuildComments(String projectKey, String buildKey, String buildNumber, javax.ws.rs.core.UriInfo uriInfo) Provide list of comments for build result specified by projectKey-buildKey-buildNumber.
RestResults	getBuildHistory(String projectKey, String buildKey, String expandParam, boolean favouriteParam, String labelParam, String issueKeyParam, boolean allStatesParam, boolean continuableParam, boolean buildStateParam, int startIndexParam, int maxResultsParam, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide list of build results for specified plan.
RestBuildLabels	getBuildLabels(String projectKey, String buildKey, String buildNumber, javax.ws.rs.core.UriInfo uriInfo) Provide list of labels for build result specified by projectKey-buildKey-buildNumber.
RestResults	getBuildResultsForChangeset(String changesetId, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide list of build results related to changeset id passed as parameter.
RestResults	getBuildResultsForCheckoutChangeset(String changesetId, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide list of build results related to changeset id passed as parameter.
RestResults	getLatestBuildResults(String expandParam, boolean favouriteParam, String labelParam, String issueKeyParam, boolean allStatesParam, boolean continuableParam, boolean buildStateParam, int startIndexParam, int maxResultsParam, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide list of latest build results for top level plans visible for users.
RestResults	getLatestBuildResultsForProject(String projectKey, String expandParam, boolean favouriteParam, String labelParam, String issueKeyParam, boolean allStatesParam, boolean continuableParam, boolean buildStateParam, int startIndexParam, int maxResultsParam, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide list of latest build results for top level plans for specified project.
RestResultStatus	getResultStatus(String projectKey, String buildKey, String buildNumber, javax.ws.rs.core.UriInfo uriInfo, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Provide runtime information for currently executing build result.
void	removeBuildLabel(String projectKey, String buildKey, String buildNumber, String labelName, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext, javax.ws.rs.core.UriInfo uriInfo) Removes label from build result specified by projectKey-buildKey-buildNumber.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultResource

public ResultResource(ResultService resultService,
                      FeatureManager featureManager)

Method Detail

getLatestBuildResults

public RestResults getLatestBuildResults(String expandParam,
                                         boolean favouriteParam,
                                         String labelParam,
                                         String issueKeyParam,
                                         boolean allStatesParam,
                                         boolean continuableParam,
                                         boolean buildStateParam,
                                         int startIndexParam,
                                         int maxResultsParam,
                                         @Context
                                         javax.ws.rs.core.UriInfo uriInfo,
                                         @Context
                                         com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide list of latest build results for top level plans visible for users.

Parameters:

expandParam - expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix.

favouriteParam - filters build results list to show only results for favourite plans. Works only for authenticated user

labelParam - filter by comma separated list of labels

issueKeyParam - filter by comma separated list of Jira issue key related to result

allStatesParam - return all build results including Unknown states

continuableParam - filter only results that may be continued (stopped on Manual Stage)

buildStateParam - filter results by state, valid values are Unknown, Successful, Failed

startIndexParam - start index for results list (zero based)

maxResultsParam - maximum size for returned list

uriInfo -

authenticationContext -

Returns:

RestResults

getLatestBuildResultsForProject

public RestResults getLatestBuildResultsForProject(String projectKey,
                                                   String expandParam,
                                                   boolean favouriteParam,
                                                   String labelParam,
                                                   String issueKeyParam,
                                                   boolean allStatesParam,
                                                   boolean continuableParam,
                                                   boolean buildStateParam,
                                                   int startIndexParam,
                                                   int maxResultsParam,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @Context
                                                   com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide list of latest build results for top level plans for specified project. List of results is limited to plans visible for user.

Parameters:

projectKey - project key to filter plan result list

expandParam - expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix.

favouriteParam - filters build results list to show only results for favourite plans. Works only for authenticated user

labelParam - filter by comma separated list of labels

issueKeyParam - filter by comma separated list of Jira issue key related to result

allStatesParam - return all build results including Unknown states

continuableParam - filter only results that may be continued (stopped on Manual Stage)

buildStateParam - filter results by state, valid values are Unknown, Successful, Failed

startIndexParam - start index for results list (zero based)

maxResultsParam - maximum size for returned list

uriInfo -

authenticationContext -

Returns:

RestResults

getBuildResultsForChangeset

public RestResults getBuildResultsForChangeset(String changesetId,
                                               @Context
                                               javax.ws.rs.core.UriInfo uriInfo,
                                               @Context
                                               com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide list of build results related to changeset id passed as parameter. List of results contains results from all plans related to this changeset.

Parameters:

changesetId - changeset id related to build result

uriInfo -

authenticationContext -

Returns:

List of RestResults related to specified changeset id

getBuildResultsForCheckoutChangeset

public RestResults getBuildResultsForCheckoutChangeset(String changesetId,
                                                       @Context
                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                       @Context
                                                       com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide list of build results related to changeset id passed as parameter. List of results contains results from all plans which have repositories checked out with this changeset.

Parameters:

changesetId - checkout changeset id related to build result

uriInfo -

authenticationContext -

Returns:

List of RestResults checked out with specified changeset id

getBuildHistory

public RestResults getBuildHistory(String projectKey,
                                   String buildKey,
                                   String expandParam,
                                   boolean favouriteParam,
                                   String labelParam,
                                   String issueKeyParam,
                                   boolean allStatesParam,
                                   boolean continuableParam,
                                   boolean buildStateParam,
                                   int startIndexParam,
                                   int maxResultsParam,
                                   @Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide list of build results for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

expandParam - expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix.

favouriteParam - filters build results list to show only results for favourite plans. Works only for authenticated user

labelParam - filter by comma separated list of labels

issueKeyParam - filter by comma separated list of Jira issue key related to result

allStatesParam - return all build results including Unknown states

continuableParam - filter only results that may be continued (stopped on Manual Stage)

buildStateParam - filter results by state, valid values are Unknown, Successful, Failed

startIndexParam - start index for results list (zero based)

maxResultsParam - maximum size for returned list

uriInfo -

authenticationContext -

Returns:

RestResults

getBranchHistory

public RestResults getBranchHistory(String projectKey,
                                    String buildKey,
                                    String branchName,
                                    String expandParam,
                                    boolean favouriteParam,
                                    String labelParam,
                                    String issueKeyParam,
                                    boolean allStatesParam,
                                    boolean continuableParam,
                                    boolean buildStateParam,
                                    int startIndexParam,
                                    int maxResultsParam,
                                    @Context
                                    javax.ws.rs.core.UriInfo uriInfo,
                                    @Context
                                    com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide list of build results for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

expandParam - expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix.

favouriteParam - filters build results list to show only results for favourite plans. Works only for authenticated user

labelParam - filter by comma separated list of labels

issueKeyParam - filter by comma separated list of Jira issue key related to result

allStatesParam - return all build results including Unknown states

continuableParam - filter only results that may be continued (stopped on Manual Stage)

buildStateParam - filter results by state, valid values are Unknown, Successful, Failed

startIndexParam - start index for results list (zero based)

maxResultsParam - maximum size for returned list

uriInfo -

authenticationContext -

Returns:

RestResults

getBuild

public Result getBuild(String projectKey,
                       String buildKey,
                       String buildNumber,
                       String expandParam,
                       boolean favouriteParam,
                       int startIndexParam,
                       int maxResultsParam,
                       @Context
                       javax.ws.rs.core.UriInfo uriInfo,
                       @Context
                       com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

buildNumber - either the number of the specific build result or 'latest' for the highest build number

expandParam - expands build result details on request. Possible values are: changes, metadata, artifacts, comments, labels, jiraIssues, stages, logEntries. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. logEntries and testResults are available only for job results

favouriteParam - filters build results list to show only results for favourite plans. Works only for authenticated user

startIndexParam - start index for results list (zero based)

maxResultsParam - maximum size for returned list

uriInfo - uriInfo

authenticationContext - authenticationContext

Returns:

Result ResultDetails

getBuildAlias

public Result getBuildAlias(String projectKey,
                            String buildKey,
                            String buildNumber,
                            String expandParam,
                            boolean favouriteParam,
                            int startIndexParam,
                            int maxResultsParam,
                            @Context
                            javax.ws.rs.core.UriInfo uriInfo,
                            @Context
                            com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

buildNumber - either the number of the specific build result or 'latest' for the highest build number

expandParam - expands build result details on request. Possible values are: changes, metadata, artifacts, comments, labels, jiraIssues, stages, logEntries. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. logEntries and testResults are available only for job results

favouriteParam - filters build results list to show only results for favourite plans. Works only for authenticated user

startIndexParam - start index for results list (zero based)

maxResultsParam - maximum size for returned list

uriInfo - uriInfo

authenticationContext - authenticationContext

Returns:

Result ResultDetails

getBuildComments

public RestComments getBuildComments(String projectKey,
                                     String buildKey,
                                     String buildNumber,
                                     @Context
                                     javax.ws.rs.core.UriInfo uriInfo)

Provide list of comments for build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

Parameters:

projectKey - projectKey

buildKey - planKey (might be simply planKey or composite planKey-jobKey)

buildNumber - either the number of the specific build result or 'latest' for the highest build number

uriInfo -

Returns:

RestComments

addBuildComment

public void addBuildComment(String projectKey,
                            String buildKey,
                            String buildNumber,
                            RestComment comment,
                            @Context
                            com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext,
                            @Context
                            javax.ws.rs.core.UriInfo uriInfo)

Adds new comment to build result specified by projectKey-buildKey-buildNumber.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

buildNumber - build number

comment - new comment content

authenticationContext -

uriInfo -

getBuildLabels

public RestBuildLabels getBuildLabels(String projectKey,
                                      String buildKey,
                                      String buildNumber,
                                      @Context
                                      javax.ws.rs.core.UriInfo uriInfo)

Provide list of labels for build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

buildNumber - either the number of the specific build result or 'latest' for the highest build number

uriInfo -

Returns:

RestBuildLabels

addBuildLabel

public void addBuildLabel(String projectKey,
                          String buildKey,
                          String buildNumber,
                          RestBuildLabel label,
                          @Context
                          com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext,
                          @Context
                          javax.ws.rs.core.UriInfo uriInfo)

Adds new label to build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

buildNumber - either the number of the specific build result or 'latest' for the highest build number

label - label content to add to build result

authenticationContext -

uriInfo -

removeBuildLabel

public void removeBuildLabel(String projectKey,
                             String buildKey,
                             String buildNumber,
                             String labelName,
                             @Context
                             com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext,
                             @Context
                             javax.ws.rs.core.UriInfo uriInfo)
                      throws Exception

Removes label from build result specified by projectKey-buildKey-buildNumber. Build number may be specified as "latest" for the result with the highest build number.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

buildNumber - either the number of the specific build result or 'latest' for the highest build number

labelName - label name to remove from build result

authenticationContext -

uriInfo -

Throws:

Exception

getResultStatus

public RestResultStatus getResultStatus(String projectKey,
                                        String buildKey,
                                        String buildNumber,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Provide runtime information for currently executing build result. The key difference to other methods is that method is optimized to provide information available in memory only, so no database calls are made. The information provided is not as wide as for finished results, but the call is optimized for speed.

Parameters:

projectKey - project key

buildKey - plan key (might be simply planKey or composite planKey-jobKey)

buildNumber - buildNumber (numeric value only, 'latest' keyword is not supported for this method)

uriInfo -

authenticationContext -

Returns:

RestResultStatus