com.atlassian.bamboo.plugins.rest.plan.stage

Interface RestStageService

All Known Implementing Classes:

RestStageServiceImpl

public interface RestStageService

Service for rest related stage operations. since 5.9

Method Summary

Modifier and Type	Method and Description
void	deleteStage(@NotNull PlanKey planKey, long stageId, @NotNull io.atlassian.fugue.Option<ConfirmationToken> confirmationToken, @NotNull javax.ws.rs.core.UriInfo uriInfo) Deletes the given stage.
RestWarnings	getStageDeletionWarnings(@NotNull PlanKey planKey, long stageId, @NotNull Expansion expansion, @NotNull javax.ws.rs.core.UriInfo uriInfo) Get warnings related to stage deletion.
RestWarnings	getStageMoveWarnings(@NotNull PlanKey planKey, long stageId, int index, @NotNull Expansion expansion, @NotNull javax.ws.rs.core.UriInfo uriInfo) Returns warnings related to a stage move action.
@NotNull RestStage	updateStage(@NotNull PlanKey planKey, long stageId, @NotNull RestStage restStage, @NotNull io.atlassian.fugue.Option<ConfirmationToken> token, @Nullable Expansion expansion, @NotNull javax.ws.rs.core.UriInfo uriInfo) Performs a partial update on a stage, updating just the fields that are specified while the rest will remain the same.

Method Detail

updateStage

@NotNull
@NotNull RestStage updateStage(@NotNull
                                        @NotNull PlanKey planKey,
                                        long stageId,
                                        @NotNull
                                        @NotNull RestStage restStage,
                                        @NotNull
                                        @NotNull io.atlassian.fugue.Option<ConfirmationToken> token,
                                        @Nullable
                                        @Nullable Expansion expansion,
                                        @NotNull
                                        @NotNull javax.ws.rs.core.UriInfo uriInfo)
                                 throws WebValidationException

Performs a partial update on a stage, updating just the fields that are specified while the rest will remain the same. If a token is provided, will only update the stage is the token is up to date.

Parameters:

planKey - of the plan the stage belongs to

stageId - id of stage being updated

restStage - partial representation of a stage, only the specified fields will be updated

token - checks we have a token that applies to the current status of the stage, and not an obsolete version

expansion - fields to expand in the stage representation included in the response

uriInfo - URI info from the request

Returns:

RestStage updated version

Throws:

InvalidRequestException - if invalid params

NotFoundException - if the stage is not found

NotAuthorizedException - if the user lack permissions

WebValidationException - if the stage cannot be updated due to invalid request

deleteStage

void deleteStage(@NotNull
                 @NotNull PlanKey planKey,
                 long stageId,
                 @NotNull
                 @NotNull io.atlassian.fugue.Option<ConfirmationToken> confirmationToken,
                 @NotNull
                 @NotNull javax.ws.rs.core.UriInfo uriInfo)
          throws WebValidationException

Deletes the given stage. Also removes any jobs under the stage.

Parameters:

planKey - of plan stage belongs to.

stageId - id of stage being removed.

confirmationToken - The token to match before performing the delete

uriInfo - URI info from the request

Throws:

ConflictException - if there is a token validation error

WebValidationException

getStageDeletionWarnings

RestWarnings getStageDeletionWarnings(@NotNull
                                      @NotNull PlanKey planKey,
                                      long stageId,
                                      @NotNull
                                      @NotNull Expansion expansion,
                                      @NotNull
                                      @NotNull javax.ws.rs.core.UriInfo uriInfo)
                               throws WebValidationException

Get warnings related to stage deletion. This will return a structure with one entry for each artifact subscription. The entry for the artifact subscription will contain a list of all consuming jobs.

Parameters:

planKey - of plan stage is in

stageId - of stage to delete

expansion - the expansion.

uriInfo - URI info from the request

Returns:

an object with information needed to display warnings to the user

Throws:

WebValidationException

getStageMoveWarnings

RestWarnings getStageMoveWarnings(@NotNull
                                  @NotNull PlanKey planKey,
                                  long stageId,
                                  int index,
                                  @NotNull
                                  @NotNull Expansion expansion,
                                  @NotNull
                                  @NotNull javax.ws.rs.core.UriInfo uriInfo)
                           throws WebValidationException

Returns warnings related to a stage move action. This will return a structure with one entry for each artifact subscription that will be broken if the stage is moved. The entry for the artifact subscription will contain a list of all consumer jobs.

Parameters:

planKey - plan key of the plan the stage is in

stageId - identifies the stage to move

index - zero-based position the stage will be moved into

expansion - the fields to expand in the warnings response

uriInfo - URI info from the request

Returns:

RestWarnings with warnings if any, and a token

Throws:

WebValidationException - if the planKey is not valid

NotFoundException - if stage does not exist

org.acegisecurity.AccessDeniedException - if user lacks edit configuration plan permissions