Package com.atlassian.bamboo.plugins.rest.resource

Class ResultResource

java.lang.Object

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

@Path("result")
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
@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	Description
ResultResource(BambooPermissionManager bambooPermissionManager, ResultService resultService, FeatureManager featureManager, RestAuthenticationContext restAuthenticationContext)

Method Summary

Modifier and Type	Method	Description
void	addBuildComment(String projectKey, String buildKey, String buildNumber, CreateCommentRequest comment, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	addBuildLabel(String projectKey, String buildKey, String buildNumber, RestBuildLabel label, jakarta.ws.rs.core.UriInfo uriInfo)
RestResults	getBranchHistory(String projectKey, String buildKey, String branchName, String expandParam, boolean favouriteParam, String labelParam, String issueKeyParam, boolean allStatesParam, String lifecycleStateParam, boolean continuableParam, boolean buildStateParam, int startIndexParam, int maxResultsParam, jakarta.ws.rs.core.UriInfo uriInfo)
Result	getBuild(String projectKey, String buildKey, String buildNumber, String expandParam, boolean showBuildPositions, jakarta.ws.rs.core.UriInfo uriInfo)
Result	getBuildAlias(String projectKey, String buildKey, String buildNumber, String expandParam, jakarta.ws.rs.core.UriInfo uriInfo)
RestComments	getBuildComments(String projectKey, String buildKey, String buildNumber, jakarta.ws.rs.core.UriInfo uriInfo)
RestResults	getBuildHistory(String projectKey, String buildKey, String expandParam, boolean favouriteParam, String labelParam, String issueKeyParam, boolean allStatesParam, String lifecycleStateParam, boolean continuableParam, boolean buildStateParam, int startIndexParam, int maxResultsParam, jakarta.ws.rs.core.UriInfo uriInfo)
RestBuildLabels	getBuildLabels(String projectKey, String buildKey, String buildNumber, jakarta.ws.rs.core.UriInfo uriInfo)
RestResults	getBuildResultsForChangeset(String changesetId, jakarta.ws.rs.core.UriInfo uriInfo)
RestResults	getBuildResultsForCheckoutChangeset(String changesetId, jakarta.ws.rs.core.UriInfo uriInfo)
RestResults	getLatestBuildResults(String expandParam, boolean favouriteParam, String labelParam, String issueKeyParam, boolean allStatesParam, String lifecycleStateParam, boolean continuableParam, String buildStateParam, int startIndexParam, int maxResultsParam, jakarta.ws.rs.core.UriInfo uriInfo)
RestResults	getLatestBuildResultsForProject(String projectKey, String expandParam, boolean favouriteParam, String labelParam, String issueKeyParam, boolean allStatesParam, String lifecycleStateParam, boolean continuableParam, String buildStateParam, int startIndexParam, int maxResultsParam, jakarta.ws.rs.core.UriInfo uriInfo)
RestResultStatus	getResultStatus(String projectKey, String buildKey, String buildNumber, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	removeBuildComment(String projectKey, String buildKey, String buildNumber, long commentId, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	removeBuildLabel(String projectKey, String buildKey, String buildNumber, String labelName, jakarta.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

ResultResource

@Inject
public ResultResource(BambooPermissionManager bambooPermissionManager,
 ResultService resultService,
 FeatureManager featureManager,
 RestAuthenticationContext restAuthenticationContext)

Method Details

getLatestBuildResults

@GET
public RestResults getLatestBuildResults(@QueryParam("expand")
 String expandParam,
 @QueryParam("favourite")
 boolean favouriteParam,
 @QueryParam("label")
 String labelParam,
 @QueryParam("issueKey")
 String issueKeyParam,
 @QueryParam("includeAllStates")
 boolean allStatesParam,
 @QueryParam("lifeCycleState")
 String lifecycleStateParam,
 @QueryParam("continuable")
 boolean continuableParam,
 @QueryParam("buildstate")
 String buildStateParam,
 @QueryParam("start-index")
 int startIndexParam,
 @QueryParam("max-results")
 int maxResultsParam,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getLatestBuildResultsForProject

@GET
@Path("{projectKey : ([^-/]+)}")
public RestResults getLatestBuildResultsForProject(@PathParam("projectKey")
 String projectKey,
 @QueryParam("expand")
 String expandParam,
 @QueryParam("favourite")
 boolean favouriteParam,
 @QueryParam("label")
 String labelParam,
 @QueryParam("issueKey")
 String issueKeyParam,
 @QueryParam("includeAllStates")
 boolean allStatesParam,
 @QueryParam("lifeCycleState")
 String lifecycleStateParam,
 @QueryParam("continuable")
 boolean continuableParam,
 @QueryParam("buildstate")
 String buildStateParam,
 @QueryParam("start-index")
 int startIndexParam,
 @QueryParam("max-results")
 int maxResultsParam,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getBuildResultsForChangeset

@GET
@Path("byChangeset/{csid}")
public RestResults getBuildResultsForChangeset(@PathParam("csid")
 String changesetId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getBuildResultsForCheckoutChangeset

@GET
@Path("byCheckoutChangeset/{csid}")
public RestResults getBuildResultsForCheckoutChangeset(@PathParam("csid")
 String changesetId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getBuildHistory

@GET
@Path("{projectKey : ([^-]+)}-{buildKey}")
public RestResults getBuildHistory(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @QueryParam("expand")
 String expandParam,
 @QueryParam("favourite")
 boolean favouriteParam,
 @QueryParam("label")
 String labelParam,
 @QueryParam("issueKey")
 String issueKeyParam,
 @QueryParam("includeAllStates")
 boolean allStatesParam,
 @QueryParam("lifeCycleState")
 String lifecycleStateParam,
 @QueryParam("continuable")
 boolean continuableParam,
 @QueryParam("buildstate")
 boolean buildStateParam,
 @QueryParam("start-index")
 int startIndexParam,
 @QueryParam("max-results")
 int maxResultsParam,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getBranchHistory

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}/branch/{branchName}")
public RestResults getBranchHistory(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("branchName")
 String branchName,
 @QueryParam("expand")
 String expandParam,
 @QueryParam("favourite")
 boolean favouriteParam,
 @QueryParam("label")
 String labelParam,
 @QueryParam("issueKey")
 String issueKeyParam,
 @QueryParam("includeAllStates")
 boolean allStatesParam,
 @QueryParam("lifeCycleState")
 String lifecycleStateParam,
 @QueryParam("continuable")
 boolean continuableParam,
 @QueryParam("buildstate")
 boolean buildStateParam,
 @QueryParam("start-index")
 int startIndexParam,
 @QueryParam("max-results")
 int maxResultsParam,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getBuild

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}-{buildNumber : ([0-9]+)|(latest)}")
public Result getBuild(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 String buildNumber,
 @QueryParam("expand")
 String expandParam,
 @QueryParam("buildPositions")
 boolean showBuildPositions,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getBuildAlias

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}/{buildNumber : ([0-9]+)|(latest)}")
public Result getBuildAlias(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 String buildNumber,
 @QueryParam("expand")
 String expandParam,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getBuildComments

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}-{buildNumber}/comment")
public RestComments getBuildComments(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 String buildNumber,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

addBuildComment

@POST
@Path("{projectKey : ([^-/]+)}-{buildKey}-{buildNumber}/comment")
public void addBuildComment(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 String buildNumber,
 CreateCommentRequest comment,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

removeBuildComment

@DELETE
@Path("{projectKey : ([^-/]+)}-{buildKey}-{buildNumber}/comment/{commentId}")
public jakarta.ws.rs.core.Response removeBuildComment(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 String buildNumber,
 @PathParam("commentId")
 long commentId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getBuildLabels

@GET
@Path("{projectKey : ([^-/]+)}-{buildKey}-{buildNumber}/label")
public RestBuildLabels getBuildLabels(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 String buildNumber,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

addBuildLabel

@POST
@Path("{projectKey : ([^-/]+)}-{buildKey}-{buildNumber}/label")
public jakarta.ws.rs.core.Response addBuildLabel(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 String buildNumber,
 RestBuildLabel label,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

removeBuildLabel

@DELETE
@Path("{projectKey : ([^-/]+)}-{buildKey}-{buildNumber}/label/{labelName}")
public jakarta.ws.rs.core.Response removeBuildLabel(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 String buildNumber,
 @PathParam("labelName")
 String labelName,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                             throws Exception

Throws:

Exception

getResultStatus

@GET
@Path("/status/{projectKey : ([^-/]+)}-{buildKey}-{buildNumber : ([0-9]+)}")
public RestResultStatus getResultStatus(@PathParam("projectKey")
 String projectKey,
 @PathParam("buildKey")
 String buildKey,
 @PathParam("buildNumber")
 String buildNumber,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)