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

Class ArtifactResource

java.lang.Object

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

@Internal
public class ArtifactResource
extends Object

Provides RESTful operations on artifacts generated by a build plan.

Since:

5.9

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALL_SUBSCRIBERS_URL
static List<RestArtifactSubscriptions>	ARTIFACT_SUBSCRIPTIONS	Used for REST documentation generation.
static String	SUBSCRIBING_JOBS_URL

Constructor Summary

Constructors

Constructor	Description
ArtifactResource(RestArtifactService restArtifactService, InputParser inputParser)

Method Summary

Modifier and Type	Method	Description
@NotNull List<RestArtifactSubscriptions>	getConsumersOfJobArtifacts(String jobKeyString, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)	Returns the full list of subscribers of artifacts produced by a Job.
@NotNull RestPageModel<RestJob>	getJobsConsumingArtifact(String jobKeyString, long artifactId, PageRequest pageRequest, javax.ws.rs.core.UriInfo uriInfo)	Returns a paginated list of jobs subscribing a specified artifact.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_SUBSCRIBERS_URL

public static final String ALL_SUBSCRIBERS_URL

See Also:

Constant Field Values

SUBSCRIBING_JOBS_URL

public static final String SUBSCRIBING_JOBS_URL

See Also:

Constant Field Values

ARTIFACT_SUBSCRIPTIONS

public static final List<RestArtifactSubscriptions> ARTIFACT_SUBSCRIPTIONS

Used for REST documentation generation.

Constructor Detail

ArtifactResource

public ArtifactResource(RestArtifactService restArtifactService,
                        InputParser inputParser)

Method Detail

getConsumersOfJobArtifacts

@NotNull
public @NotNull List<RestArtifactSubscriptions> getConsumersOfJobArtifacts(String jobKeyString,
                                                                           @Context
                                                                           Expansion expansion,
                                                                           @Context
                                                                           javax.ws.rs.core.UriInfo uriInfo)
                                                                    throws WebValidationException

Returns the full list of subscribers of artifacts produced by a Job.

Parameters:

jobKeyString - artifact producer job key

expansion - represents an expansion tree of additional information we want to retrieve

Returns:

a list of RestArtifactSubscriptions

Throws:

WebValidationException

getJobsConsumingArtifact

@NotNull
public @NotNull RestPageModel<RestJob> getJobsConsumingArtifact(String jobKeyString,
                                                                long artifactId,
                                                                @Context
                                                                PageRequest pageRequest,
                                                                @Context
                                                                javax.ws.rs.core.UriInfo uriInfo)
                                                         throws WebValidationException

Returns a paginated list of jobs subscribing a specified artifact.

Parameters:

jobKeyString - artifact producer job key

artifactId - artifact which subscribers we want to retrieve

pageRequest - represents the params that define which page the request is after

Returns:

a list of RestArtifactSubscriptions

Throws:

WebValidationException