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

Class RestJobServiceImpl

java.lang.Object

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

All Implemented Interfaces:

RestJobService

@Component
public class RestJobServiceImpl
extends Object
implements RestJobService

Provides job information and operations in restful formats

Constructor Summary

Constructors

Constructor and Description
RestJobServiceImpl(BuildExecutionManager buildExecutionManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, JobConversionFunction jobConversionFunction, JobService jobService, RestArtifactService restArtifactService)

Method Summary

Modifier and Type	Method and Description
RestJob	addJob(PlanKey planKey, long stageId, RestJob restJob, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Create a new job
void	deleteJob(PlanKey jobKey, Optional<ConfirmationToken> confirmationToken, javax.ws.rs.core.UriInfo uriInfo) Remove a job.
Token	getDeleteConfirmationToken(PlanKey jobKey, javax.ws.rs.core.UriInfo uriInfo) Generate the delete confirmation token to be used for the given job key.
RestWarnings	getJobDeletionWarnings(PlanKey jobKey, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Get warnings related to job deletion.
RestWarnings	getJobMoveWarnings(PlanKey jobKey, long targetStageId, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Get warnings related to job move.
RestJob	updateJob(PlanKey jobKey, RestJob restJob, Optional<ConfirmationToken> confirmationToken, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Updates the details of a specific job.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestJobServiceImpl

@Autowired
public RestJobServiceImpl(BuildExecutionManager buildExecutionManager,
                                     com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                     JobConversionFunction jobConversionFunction,
                                     JobService jobService,
                                     RestArtifactService restArtifactService)

Method Detail

addJob

@NotNull
public RestJob addJob(@NotNull
                               PlanKey planKey,
                               long stageId,
                               @Nullable
                               RestJob restJob,
                               @NotNull
                               Expansion expansion,
                               @NotNull
                               javax.ws.rs.core.UriInfo uriInfo)
                        throws WebValidationException

Description copied from interface: RestJobService

Create a new job

Specified by:

addJob in interface RestJobService

Parameters:

planKey - of plan job is in

stageId - of stage job is in

restJob - Rest Job

expansion - the expansion.

uriInfo - URI info from the request

Returns:

Rest Job

Throws:

WebValidationException

updateJob

@NotNull
public RestJob updateJob(@NotNull
                                  PlanKey jobKey,
                                  @Nullable
                                  RestJob restJob,
                                  @NotNull
                                  Optional<ConfirmationToken> confirmationToken,
                                  @NotNull
                                  Expansion expansion,
                                  @NotNull
                                  javax.ws.rs.core.UriInfo uriInfo)
                           throws WebValidationException

Description copied from interface: RestJobService

Updates the details of a specific job. Will ignore missing properties.

Specified by:

updateJob in interface RestJobService

Parameters:

jobKey - of job.

restJob - job details.

confirmationToken - The token to match before performing the update

expansion - the expansion.

uriInfo - URI info from the request

Returns:

updated job object

Throws:

WebValidationException

deleteJob

public void deleteJob(@NotNull
                      PlanKey jobKey,
                      @NotNull
                      Optional<ConfirmationToken> confirmationToken,
                      @NotNull
                      javax.ws.rs.core.UriInfo uriInfo)
               throws WebValidationException

Description copied from interface: RestJobService

Remove a job.

Specified by:

deleteJob in interface RestJobService

Parameters:

jobKey - of job

confirmationToken - The token to match before performing the delete

uriInfo - URI info from the request

Throws:

WebValidationException

getJobDeletionWarnings

@NotNull
public RestWarnings getJobDeletionWarnings(@NotNull
                                                    PlanKey jobKey,
                                                    @NotNull
                                                    Expansion expansion,
                                                    @NotNull
                                                    javax.ws.rs.core.UriInfo uriInfo)
                                             throws WebValidationException

Description copied from interface: RestJobService

Get warnings related to job 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.

Specified by:

getJobDeletionWarnings in interface RestJobService

Parameters:

jobKey - of job

expansion - the expansion.

uriInfo - URI info from the request

Returns:

an object with information needed to display warnings to the user

Throws:

WebValidationException

getDeleteConfirmationToken

@NotNull
public Token getDeleteConfirmationToken(@NotNull
                                                 PlanKey jobKey,
                                                 @NotNull
                                                 javax.ws.rs.core.UriInfo uriInfo)
                                          throws WebValidationException

Description copied from interface: RestJobService

Generate the delete confirmation token to be used for the given job key.

Specified by:

getDeleteConfirmationToken in interface RestJobService

Parameters:

jobKey - job key to generate the token for.

uriInfo - URI info from the request

Returns:

current confirmation token.

Throws:

WebValidationException - if the job key is invalid.

getJobMoveWarnings

@NotNull
public RestWarnings getJobMoveWarnings(@NotNull
                                                PlanKey jobKey,
                                                long targetStageId,
                                                @NotNull
                                                Expansion expansion,
                                                @NotNull
                                                javax.ws.rs.core.UriInfo uriInfo)
                                         throws WebValidationException

Description copied from interface: RestJobService

Get warnings related to job move. 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.

Specified by:

getJobMoveWarnings in interface RestJobService

Parameters:

jobKey - of job.

targetStageId - id of the stage the job is moving to.

expansion - the expansion.

uriInfo - URI info from the request

Returns:

an object with information needed to display warnings to the user

Throws:

WebValidationException